Difference between revisions of "@ItemEquip"

From SphereWiki
Jump to: navigation, search
(Created page with '==Description== This trigger fires when a character equips an item. Fires on: * Characters ==References== The following object references are explicitly available for thi...')
 
 
Line 35: Line 35:
 
|}
 
|}
  
 +
Hint: As an example, use "cont=(<findlayer(21).uid>)" to put an item pack into the backpack if you wish to block the equip action
  
 
[[Category: Reference Compendium]]
 
[[Category: Reference Compendium]]
 
[[Category: Triggers]]
 
[[Category: Triggers]]

Latest revision as of 15:36, 12 February 2012

Description

This trigger fires when a character equips an item.


Fires on:


References

The following object references are explicitly available for this trigger:

Name Description
ACT The item being equipped.
I The character equipping the item.


Arguments

The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:


No arguments are set for this trigger.


Return Values

The following return values are explicitly defined for this trigger:

Return Value Description
1 Treats the item as failed to equip.
Note: This trigger is not reliable for blocking the equipping of an item. Use the @EquipTest trigger instead which is designed for blocking the equip action.

Hint: As an example, use "cont=(<findlayer(21).uid>)" to put an item pack into the backpack if you wish to block the equip action