Equipment - Revision history

Fredg1: /* Equipment Commands */ equipped_amount()

2020-07-31T21:37:30Z

Equipment Commands: equipped_amount()

← Older revision		Revision as of 21:37, 31 July 2020
Line 4:		Line 4:
	{{Flink\|item\|equipped_item\|slot\|desc=Returns the item equipped in the specified slot.}}		{{Flink\|item\|equipped_item\|slot\|desc=Returns the item equipped in the specified slot.}}
	{{Flink\|boolean\|have_equipped\|item\|desc=Reports if the specified item is currently equipped by your character.}}		{{Flink\|boolean\|have_equipped\|item\|desc=Reports if the specified item is currently equipped by your character.}}
			{{Flink\|int\|equipped_amount\|item\|desc=Returns the amount of a given item currently equipped on your character.}}
	{{Flink\|boolean\|can_equip\|item\|desc=Tells if you meet the requirements for equipping the given item (regardless of its availability).}}		{{Flink\|boolean\|can_equip\|item\|desc=Tells if you meet the requirements for equipping the given item (regardless of its availability).}}
	{{Flink\|int\|weapon_hands\|item\|desc=Reports how many weapon-hand slots are required for a given item (0 - 2). Off-hand items return 0.}}		{{Flink\|int\|weapon_hands\|item\|desc=Reports how many weapon-hand slots are required for a given item (0 - 2). Off-hand items return 0.}}

Bale: Fix descriptions for get_outfits and get_custom_outfits

2014-11-25T01:09:21Z

Fix descriptions for get_outfits and get_custom_outfits

← Older revision		Revision as of 01:09, 25 November 2014
Line 23:		Line 23:
	{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}		{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}
	{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}		{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}
	{{Flink\|string [int]\|get_outfits\|desc=This function returns a list of all currently ~~custom outfits~~.}}		{{Flink\|string [int]\|get_outfits\|desc=This function returns a list of all KoL outfits that the character currently owns and can wear.}}
	{{Flink\|string [int]\|get_custom_outfits\|desc=This function returns a list of all currently custom outfits.}}		{{Flink\|string [int]\|get_custom_outfits\|desc=This function returns a list of all currently defined custom outfits.}}

	[[Category:Scripting]]		[[Category:Scripting]]

Bale: get_outfits, get_custom_outfits

2014-11-20T23:10:18Z

get_outfits, get_custom_outfits

← Older revision		Revision as of 23:10, 20 November 2014
Line 1:		Line 1:
			{{TOCright}}
			==Equipment Commands==
	{{Flink\|boolean\|equip\|{{opt\|slot}}\|item\|desc=Equips the specified item and reports success.}}		{{Flink\|boolean\|equip\|{{opt\|slot}}\|item\|desc=Equips the specified item and reports success.}}
	{{Flink\|item\|equipped_item\|slot\|desc=Returns the item equipped in the specified slot.}}		{{Flink\|item\|equipped_item\|slot\|desc=Returns the item equipped in the specified slot.}}
Line 13:		Line 15:
	{{Flink\|boolean\|bjornify_familiar\|familiar\|desc=Bjornifies the specified familiar.}}		{{Flink\|boolean\|bjornify_familiar\|familiar\|desc=Bjornifies the specified familiar.}}
	{{Flink\|familiar\|my_bjorned_familiar\|desc=Returns the familiar currently in the Buddy Bjorn.}}		{{Flink\|familiar\|my_bjorned_familiar\|desc=Returns the familiar currently in the Buddy Bjorn.}}
			{{Flink\|boolean\|maximize\|string\|boolean}}
			{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}

			==Outfit Commands==
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
	{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}		{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}
	{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}		{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}
	{{Flink\|~~boolean~~\|~~maximize~~\|~~string\|boolean~~}}		{{Flink\|string [int]\|get_outfits\|desc=This function returns a list of all currently custom outfits.}}
	{{Flink~~\|boolean\|maximize~~\|string~~\|int\|~~int\|~~boolean~~\|desc=~~Checks for and optionally equips the optimal gear for any given parameters~~.}}		{{Flink\|string [int]\|get_custom_outfits\|desc=This function returns a list of all currently custom outfits.}}

	[[Category:Scripting]]		[[Category:Scripting]]

Bale: bjornify_familiar, my_bjorned_familiar

2014-11-10T05:21:27Z

bjornify_familiar, my_bjorned_familiar

← Older revision		Revision as of 05:21, 10 November 2014
Line 11:		Line 11:
	{{Flink\|boolean\|enthrone_familiar\|familiar\|desc=Enthrones the specified familiar.}}		{{Flink\|boolean\|enthrone_familiar\|familiar\|desc=Enthrones the specified familiar.}}
	{{Flink\|familiar\|my_enthroned_familiar\|desc=Returns the familiar currently enthroned.}}		{{Flink\|familiar\|my_enthroned_familiar\|desc=Returns the familiar currently enthroned.}}
			{{Flink\|boolean\|bjornify_familiar\|familiar\|desc=Bjornifies the specified familiar.}}
			{{Flink\|familiar\|my_bjorned_familiar\|desc=Returns the familiar currently in the Buddy Bjorn.}}
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}

Bale: is_wearing_outfit

2014-11-05T06:25:57Z

is_wearing_outfit

← Older revision		Revision as of 06:25, 5 November 2014
Line 14:		Line 14:
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
	{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}		{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}
			{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}
	{{Flink\|boolean\|maximize\|string\|boolean}}		{{Flink\|boolean\|maximize\|string\|boolean}}
	{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}		{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}

	[[Category:Scripting]]		[[Category:Scripting]]

Bale: r9018 outfit_pieces()

2011-02-08T05:19:19Z

r9018 outfit_pieces()

← Older revision		Revision as of 05:19, 8 February 2011
Line 13:		Line 13:
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
			{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}
	{{Flink\|boolean\|maximize\|string\|boolean}}		{{Flink\|boolean\|maximize\|string\|boolean}}
	{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}		{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}

	[[Category:Scripting]]		[[Category:Scripting]]

Bale: fix return type

2011-01-28T05:15:25Z

fix return type

← Older revision		Revision as of 05:15, 28 January 2011
Line 13:		Line 13:
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
	{{Flink\|~~int~~\|maximize\|string\|boolean}}		{{Flink\|boolean\|maximize\|string\|boolean}}
	{{Flink\|~~int~~\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}		{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}

	[[Category:Scripting]]		[[Category:Scripting]]

Bale: added maximize() in r8954

2011-01-28T03:23:12Z

added maximize() in r8954

← Older revision		Revision as of 03:23, 28 January 2011
Line 13:		Line 13:
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
			{{Flink\|int\|maximize\|string\|boolean}}
			{{Flink\|int\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}

	[[Category:Scripting]]		[[Category:Scripting]]

Heeheehee at 17:58, 23 July 2010

2010-07-23T17:58:11Z

← Older revision		Revision as of 17:58, 23 July 2010
Line 9:		Line 9:
	{{Flink\|item\|familiar_equipment\|familiar\|desc=Reports the most commonly associated familiar equipment for the specified familiar.}}		{{Flink\|item\|familiar_equipment\|familiar\|desc=Reports the most commonly associated familiar equipment for the specified familiar.}}
	{{Flink\|item\|familiar_equipped_equipment\|familiar\|desc=Returns the item currently equipped on the specified familiar (or $item[none] if you don't have that familiar).}}		{{Flink\|item\|familiar_equipped_equipment\|familiar\|desc=Returns the item currently equipped on the specified familiar (or $item[none] if you don't have that familiar).}}
	{{Flink\|boolean\|~~enthrone~~\|familiar\|desc=Enthrones the specified familiar.}}		{{Flink\|boolean\|enthrone_familiar\|familiar\|desc=Enthrones the specified familiar.}}
	{{Flink\|familiar\|my_enthroned_familiar\|desc=Returns the familiar currently enthroned.}}		{{Flink\|familiar\|my_enthroned_familiar\|desc=Returns the familiar currently enthroned.}}
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
	[[Category:Scripting]]		[[Category:Scripting]]

Bale at 09:01, 17 July 2010

2010-07-17T09:01:32Z

← Older revision		Revision as of 09:01, 17 July 2010
Line 13:		Line 13:
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
	[[Category:~~ASH~~ Scripting]]		[[Category:Scripting]]

← Older revision		Revision as of 21:37, 31 July 2020
Line 4:		Line 4:
	{{Flink\|item\|equipped_item\|slot\|desc=Returns the item equipped in the specified slot.}}		{{Flink\|item\|equipped_item\|slot\|desc=Returns the item equipped in the specified slot.}}
	{{Flink\|boolean\|have_equipped\|item\|desc=Reports if the specified item is currently equipped by your character.}}		{{Flink\|boolean\|have_equipped\|item\|desc=Reports if the specified item is currently equipped by your character.}}
			{{Flink\|int\|equipped_amount\|item\|desc=Returns the amount of a given item currently equipped on your character.}}
	{{Flink\|boolean\|can_equip\|item\|desc=Tells if you meet the requirements for equipping the given item (regardless of its availability).}}		{{Flink\|boolean\|can_equip\|item\|desc=Tells if you meet the requirements for equipping the given item (regardless of its availability).}}
	{{Flink\|int\|weapon_hands\|item\|desc=Reports how many weapon-hand slots are required for a given item (0 - 2). Off-hand items return 0.}}		{{Flink\|int\|weapon_hands\|item\|desc=Reports how many weapon-hand slots are required for a given item (0 - 2). Off-hand items return 0.}}

← Older revision		Revision as of 01:09, 25 November 2014
Line 23:		Line 23:
	{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}		{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}
	{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}		{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}
	{{Flink\|string [int]\|get_outfits\|desc=This function returns a list of all currently ~~custom outfits~~.}}		{{Flink\|string [int]\|get_outfits\|desc=This function returns a list of all KoL outfits that the character currently owns and can wear.}}
	{{Flink\|string [int]\|get_custom_outfits\|desc=This function returns a list of all currently custom outfits.}}		{{Flink\|string [int]\|get_custom_outfits\|desc=This function returns a list of all currently defined custom outfits.}}

	[[Category:Scripting]]		[[Category:Scripting]]

← Older revision		Revision as of 23:10, 20 November 2014
Line 1:		Line 1:
			{{TOCright}}
			==Equipment Commands==
	{{Flink\|boolean\|equip\|{{opt\|slot}}\|item\|desc=Equips the specified item and reports success.}}		{{Flink\|boolean\|equip\|{{opt\|slot}}\|item\|desc=Equips the specified item and reports success.}}
	{{Flink\|item\|equipped_item\|slot\|desc=Returns the item equipped in the specified slot.}}		{{Flink\|item\|equipped_item\|slot\|desc=Returns the item equipped in the specified slot.}}
Line 13:		Line 15:
	{{Flink\|boolean\|bjornify_familiar\|familiar\|desc=Bjornifies the specified familiar.}}		{{Flink\|boolean\|bjornify_familiar\|familiar\|desc=Bjornifies the specified familiar.}}
	{{Flink\|familiar\|my_bjorned_familiar\|desc=Returns the familiar currently in the Buddy Bjorn.}}		{{Flink\|familiar\|my_bjorned_familiar\|desc=Returns the familiar currently in the Buddy Bjorn.}}
			{{Flink\|boolean\|maximize\|string\|boolean}}
			{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}

			==Outfit Commands==
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
	{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}		{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}
	{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}		{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}
	{{Flink\|~~boolean~~\|~~maximize~~\|~~string\|boolean~~}}		{{Flink\|string [int]\|get_outfits\|desc=This function returns a list of all currently custom outfits.}}
	{{Flink~~\|boolean\|maximize~~\|string~~\|int\|~~int\|~~boolean~~\|desc=~~Checks for and optionally equips the optimal gear for any given parameters~~.}}		{{Flink\|string [int]\|get_custom_outfits\|desc=This function returns a list of all currently custom outfits.}}

	[[Category:Scripting]]		[[Category:Scripting]]

← Older revision		Revision as of 05:21, 10 November 2014
Line 11:		Line 11:
	{{Flink\|boolean\|enthrone_familiar\|familiar\|desc=Enthrones the specified familiar.}}		{{Flink\|boolean\|enthrone_familiar\|familiar\|desc=Enthrones the specified familiar.}}
	{{Flink\|familiar\|my_enthroned_familiar\|desc=Returns the familiar currently enthroned.}}		{{Flink\|familiar\|my_enthroned_familiar\|desc=Returns the familiar currently enthroned.}}
			{{Flink\|boolean\|bjornify_familiar\|familiar\|desc=Bjornifies the specified familiar.}}
			{{Flink\|familiar\|my_bjorned_familiar\|desc=Returns the familiar currently in the Buddy Bjorn.}}
	{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}		{{Flink\|boolean\|have_outfit\|string\|desc=Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.}}
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}

← Older revision		Revision as of 06:25, 5 November 2014
Line 14:		Line 14:
	{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}		{{Flink\|boolean\|outfit\|string\|desc=Attempts to wear the specified outfit and reports success.}}
	{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}		{{Flink\|item [int]\|outfit_pieces\|string\|desc=Returns an array of the items which compose an outfit.}}
			{{Flink\|boolean\|is_wearing_outfit\|string\|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}
	{{Flink\|boolean\|maximize\|string\|boolean}}		{{Flink\|boolean\|maximize\|string\|boolean}}
	{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}		{{Flink\|boolean\|maximize\|string\|int\|int\|boolean\|desc=Checks for and optionally equips the optimal gear for any given parameters.}}

	[[Category:Scripting]]		[[Category:Scripting]]