Use - Revision history

Eliteofdelete: Added Chew reference

2015-11-17T07:26:45Z

Added Chew reference

← Older revision		Revision as of 07:26, 17 November 2015
Line 17:		Line 17:
	}}\|		}}\|

	function_description=Attempts to use {{pspan\|qty}} amount of item {{pspan\|it}}. Returns true if the item is used or false if it fails to do so. Note that food must be "used" via eat() & drinks via drink(); attempting to use this function will result in an error message and a return value of false. Using this function for equipment will function the same as equip() would without the optional slot parameter. If this function is called with a non-usable item, a message saying so will print to the CLI and the function will return true.\|		function_description=Attempts to use {{pspan\|qty}} amount of item {{pspan\|it}}. Returns true if the item is used or false if it fails to do so. Note that food must be "used" via eat() & drinks via drink() & spleen via chew(); attempting to use this function will result in an error message and a return value of false. Using this function for equipment will function the same as equip() would without the optional slot parameter. If this function is called with a non-usable item, a message saying so will print to the CLI and the function will return true.\|

	code1={{CodeSample\|		code1={{CodeSample\|
Line 31:		Line 31:
	}}\|		}}\|

	see_also={{SeeAlso\|drink\|eat\|equip}}\|		see_also={{SeeAlso\|drink\|eat\|equip\|chew}}\|
	cli_equiv=The CLI command "use" functions similarly.\|		cli_equiv=The CLI command "use" functions similarly.\|
	more_info=If {{pspan\|qty}} is 0 or negative, no item will be used and the function will return true.\|		more_info=If {{pspan\|qty}} is 0 or negative, no item will be used and the function will return true.\|

Eliteofdelete at 22:58, 21 January 2015

2015-01-21T22:58:41Z

← Older revision		Revision as of 22:58, 21 January 2015
Line 19:		Line 19:
	function_description=Attempts to use {{pspan\|qty}} amount of item {{pspan\|it}}. Returns true if the item is used or false if it fails to do so. Note that food must be "used" via eat() & drinks via drink(); attempting to use this function will result in an error message and a return value of false. Using this function for equipment will function the same as equip() would without the optional slot parameter. If this function is called with a non-usable item, a message saying so will print to the CLI and the function will return true.\|		function_description=Attempts to use {{pspan\|qty}} amount of item {{pspan\|it}}. Returns true if the item is used or false if it fails to do so. Note that food must be "used" via eat() & drinks via drink(); attempting to use this function will result in an error message and a return value of false. Using this function for equipment will function the same as equip() would without the optional slot parameter. If this function is called with a non-usable item, a message saying so will print to the CLI and the function will return true.\|

	~~needscode~~=~~yes~~\|		code1={{CodeSample\|
			title=Code Samples\|
			description=The following example uses the festive warbear bank if you have one.\|
			code=
			<syntaxhighlight>
			if (item_amount($item[festive warbear bank]) > 0)
			use(1, $item[festive warbear bank]);
			else print("You do not have a festive warbear bank.", "red");
			</syntaxhighlight>\|

			}}\|

	see_also={{SeeAlso\|drink\|eat\|equip}}\|		see_also={{SeeAlso\|drink\|eat\|equip}}\|

Bale at 22:05, 21 May 2010

2010-05-21T22:05:33Z

← Older revision		Revision as of 22:05, 21 May 2010
Line 5:		Line 5:
	FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Item Management\|~~

	function1={{Function\|		function1={{Function\|
Line 26:		Line 25:
	more_info=If {{pspan\|qty}} is 0 or negative, no item will be used and the function will return true.\|		more_info=If {{pspan\|qty}} is 0 or negative, no item will be used and the function will return true.\|
	}}		}}

			[[Category:Item Management]]

Bale at 11:16, 11 May 2010

2010-05-11T11:16:37Z

← Older revision		Revision as of 11:16, 11 May 2010
Line 24:		Line 24:
	see_also={{SeeAlso\|drink\|eat\|equip}}\|		see_also={{SeeAlso\|drink\|eat\|equip}}\|
	cli_equiv=The CLI command "use" functions similarly.\|		cli_equiv=The CLI command "use" functions similarly.\|
			more_info=If {{pspan\|qty}} is 0 or negative, no item will be used and the function will return true.\|
	}}		}}

StDoodle at 21:13, 8 March 2010

2010-03-08T21:13:43Z

← Older revision		Revision as of 21:13, 8 March 2010
Line 1:		Line 1:
	{{#vardefine:name\|use}}		{{
	{{#vardefine:return_type\|boolean}}		#vardefine:name\|use}}{{
			#vardefine:return_type\|boolean}}{{

	{{FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	function_category=Item Management\|		function_category=Item Management\|

StDoodle: Created page with '{{#vardefine:name|use}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Item Management| function1={{Function| name={{#var:name}}| aggr…'

2010-03-05T14:32:16Z

Created page with '{{#vardefine:name|use}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Item Management| function1={{Function| name={{#var:name}}| aggr…'

New page

{{#vardefine:name|use}}
{{#vardefine:return_type|boolean}}

{{FunctionPage|
name={{#var:name}}|
function_category=Item Management|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|it}}|
p1desc={{pspan|qty}} is the quantity to use|
p2desc={{pspan|it}} is the item to use|
}}|

function_description=Attempts to use {{pspan|qty}} amount of item {{pspan|it}}. Returns true if the item is used or false if it fails to do so. Note that food must be "used" via eat() & drinks via drink(); attempting to use this function will result in an error message and a return value of false. Using this function for equipment will function the same as equip() would without the optional slot parameter. If this function is called with a non-usable item, a message saying so will print to the CLI and the function will return true.|

needscode=yes|

see_also={{SeeAlso|drink|eat|equip}}|
cli_equiv=The CLI command "use" functions similarly.|
}}