Equip - Revision history

Malibu Stacey: add new overloads for equipping familiars directly and code example

2024-04-12T16:49:32Z

add new overloads for equipping familiars directly and code example

@@ Line 15: / Line 15: @@
 function2={{Function|
 name={{#var:name}}|
 aggregate={{#var:aggregate}}|
@@ Line 21: / Line 31: @@
 parameter1={{Param|slot|where}}|
 parameter2={{Param|item|equip_me}}|
-p1desc={{Pspan|where}} is the slot to place the item in (optional)|
+p1desc={{Pspan|equip_me}} is the item to equip|
-p2desc={{Pspan|equip_me}} is the item to equip|
+p2desc={{Pspan|where}} is the slot to place the item in|
 }}|
@@ Line 29: / Line 60: @@
 *If {{pspan|where}} is not specified and {{pspan|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense.
 *If you cannot equip {{pspan|equip_me}}, or {{pspan|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.
 &nbsp;|
@@ Line 39: / Line 71: @@
 equip($item[swashbuckling pants]);
 equip($slot[acc2], $item[stuffed shoulder parrot]);
 </syntaxhighlight>
 }}|

Bale at 22:10, 21 May 2010

2010-05-21T22:10:26Z

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

	function1={{Function\|		function1={{Function\|
Line 46:		Line 45:
	cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.\|		cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.\|
	}}		}}

			[[Category:Equipment]]

Heeheehee: Typo caught.

2010-03-22T03:57:40Z

Typo caught.

← Older revision		Revision as of 03:57, 22 March 2010
Line 34:		Line 34:
	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=Equips the Swashbuckling Getup carefully to ensure that the ~~parot~~ is in the second accessory slot.\|		description=Equips the Swashbuckling Getup carefully to ensure that the parrot is in the second accessory slot.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>

Heeheehee: Lame workaround to maintain formatting. =D

2010-03-21T20:42:02Z

Lame workaround to maintain formatting. =D

← Older revision		Revision as of 20:42, 21 March 2010
Line 26:		Line 26:
	}}\|		}}\|

	function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). ~~</p>~~		function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open).
	~~<p>~~If {{pspan\|where}} is specified and {{pspan\|equip_me}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true. ~~</p>~~		*If {{pspan\|where}} is specified and {{pspan\|equip_me}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true.
	~~<p>~~If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense. ~~</p>~~		*If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense.
	~~<p>~~If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|		*If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.
			\|

	code1={{CodeSample\|		code1={{CodeSample\|

Bale: fixed formatting.

2010-03-21T09:39:03Z

fixed formatting.

← Older revision		Revision as of 09:39, 21 March 2010
Line 26:		Line 26:
	}}\|		}}\|

	function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open).		function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). </p>
	*If {{pspan\|where}} is specified and {{pspan\|equip_me}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true.		<p>If {{pspan\|where}} is specified and {{pspan\|equip_me}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true. </p>
	*If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense.		<p>If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense. </p>
	*If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|		<p>If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|

	code1={{CodeSample\|		code1={{CodeSample\|

Bale: fixed typos and added formating

2010-03-21T09:33:49Z

fixed typos and added formating

← Older revision		Revision as of 09:33, 21 March 2010
Line 26:		Line 26:
	}}\|		}}\|

	function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). If {{pspan\|where}} is specified and {{pspan\|~~where~~}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true. If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error. If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|		function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open).
			*If {{pspan\|where}} is specified and {{pspan\|equip_me}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true.
			*If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense.
			*If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|

	code1={{CodeSample\|		code1={{CodeSample\|
Line 42:		Line 45:
	cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.\|		cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.\|
	}}		}}
	~~{{RFI\|What's up with the abort message when no slot is specified and item is $item[none]?\|I'm sure there are other edge-case I haven't thought of; if you do, please test and edit in.}}~~

Heeheehee: Typo-fixing?

2010-03-14T21:18:17Z

Typo-fixing?

← Older revision		Revision as of 21:18, 14 March 2010
Line 26:		Line 26:
	}}\|		}}\|

	function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). If {{pspan\|where}} is specified and {{pspan\|where}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true. If {{pspan\|where}} is not specified and {{pspan\|~~where~~}} is set to $item[none], the function aborts and you get a funky error. If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|		function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). If {{pspan\|where}} is specified and {{pspan\|where}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true. If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error. If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|

	code1={{CodeSample\|		code1={{CodeSample\|

StDoodle at 18:18, 14 March 2010

2010-03-14T18:18:51Z

← Older revision		Revision as of 18:18, 14 March 2010
Line 12:		Line 12:
	return_type={{#var:return_type}}\|		return_type={{#var:return_type}}\|
	return_also={{#var:return_also}}\|		return_also={{#var:return_also}}\|
	~~parameter2~~={{Param\|item\|equip_me}}\|		parameter1={{Param\|item\|equip_me}}\|
	}}\|		}}\|

StDoodle at 13:56, 10 March 2010

2010-03-10T13:56:46Z

← Older revision		Revision as of 13:56, 10 March 2010
Line 42:		Line 42:
	cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.\|		cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.\|
	}}		}}
	{{RFI\|What's up with the abort message when no slot is ~~unspecified~~ and item is $item[none]?\|I'm sure there are other edge-case I haven't thought of; if you do, please test and edit in.}}		{{RFI\|What's up with the abort message when no slot is specified and item is $item[none]?\|I'm sure there are other edge-case I haven't thought of; if you do, please test and edit in.}}

Bale: added code sample

2010-03-10T09:58:58Z

added code sample

← Older revision		Revision as of 09:58, 10 March 2010
Line 28:		Line 28:
	function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). If {{pspan\|where}} is specified and {{pspan\|where}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true. If {{pspan\|where}} is not specified and {{pspan\|where}} is set to $item[none], the function aborts and you get a funky error. If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|		function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). If {{pspan\|where}} is specified and {{pspan\|where}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true. If {{pspan\|where}} is not specified and {{pspan\|where}} is set to $item[none], the function aborts and you get a funky error. If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|

	~~needscode~~=~~yes~~\|		code1={{CodeSample\|
			title=Code Sample\|
			description=Equips the Swashbuckling Getup carefully to ensure that the parot is in the second accessory slot.\|
			code=
			<syntaxhighlight>
			equip($item[eyepatch]);
			equip($item[swashbuckling pants]);
			equip($slot[acc2], $item[stuffed shoulder parrot]);
			</syntaxhighlight>
			}}\|

	see_also={{SeeAlso\|can_equip\|equipped_amount\|equipped_item\|have_equipped}}\|		see_also={{SeeAlso\|can_equip\|equipped_amount\|equipped_item\|have_equipped}}\|

← Older revision		Revision as of 09:39, 21 March 2010
Line 26:		Line 26:
	}}\|		}}\|

	function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open).		function_description=Attempts to equip the item {{pspan\|equip_me}} in the slot {{pspan\|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan\|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). </p>
	*If {{pspan\|where}} is specified and {{pspan\|equip_me}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true.		<p>If {{pspan\|where}} is specified and {{pspan\|equip_me}} is set to $item[none], this function will unequip whatever is in slot {{pspan\|where}} and return true. </p>
	*If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense.		<p>If {{pspan\|where}} is not specified and {{pspan\|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense. </p>
	*If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|		<p>If you cannot equip {{pspan\|equip_me}}, or {{pspan\|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.\|

	code1={{CodeSample\|		code1={{CodeSample\|