Difference between revisions of "Bot Playground/Commands/getBalance"

Revision as of 06:28, 2 November 2016

Retrieves the current bot's L$ balance.

Bot.getBalance(function(result) {
  console.log("I have L$" + result.balance);
});

or using a Promise:

Bot.getBalance()
  .then(function(result) {
    console.log("I have L$" + result.balance);
  });

This command accepts the following parameters:

Variable		Required	Description
getBalance:
Output:
	Function returns a Promise with the following data:
	success	bool	true if command completed successfully
	error	string	error string if command has failed

For a comprehensive balance management script check the code in Examples section.

@@ Line 27: / Line 27: @@
 {{API Variables Table End}}
-== Error messages ==
+== See also ==
+* [[Bot_Playground/Commands/giveMoney|giveMoney()]]
+== Examples ==
 For a comprehensive balance management script check the [[Bot_Playground/Examples/Working_with_bot_money_balance|code in Examples section]].