A
          / \      _             Play Now                         Nemesis on 
          | |     | |  _______   _        _   _______    _______   _    _______
          | |\    | | |   ____| |  \    /  | |   ____|  /   ____| | |  /   ____|
 /-------/-------------------------------------------------------------------,
O= Home <=XX|  About  News  Pics  Adventurers  Wizards  Download  Connect     >
 \-------\-------------------------------------------------------------------'
          | |   \   | |  |____  | |      | | |  |____   ___ \  \  | |  ___ \  \
          | |     \_| |_______| |_|      |_| |_______| |_______/  |_| |_______/
          \ /
           V  

Documentation Area

Document Path: /doc/living/query_all_money

Name: query_all_money - get the whole money array from a living

Syntax:
	#include <currency.h>
	int **query_all_money()

Description:
	The query_all_money call returns the whole money array, stored in the
	player. It is valid only with the new currency system.

Return value: 
	The money array is a 2-dimensional array of currencies and currency
	units. Currency defines are listed in /include/currency.h.

	Each currency has 3 currency units. For the standard currency these
	are gold coins, silver coins and copper coins. At the moment there
	is support for 5 currencies.

	The array returned has the form money[5][3], each array entry shows
	the number of coins of each currency unit.

Examples:
	int **money;
	money=this_player()->query_all_money();

	The money array should look like this:

				Unit 1	Unit 2	Unit 3
		Currency 1	[0][0]  [0][1]  [0][2]
		Currency 2	[1][0]  [1][1]  [1][2]
		Currency 3	[2][0]  [2][1]  [2][2]
		Currency 4	[3][0]  [3][1]  [3][2]
		Currency 5	[4][0]  [4][1]  [4][2]

	For example money[0][0] is the amount of gold coins.

See also:
living/query_money
living/add_money