@ItemEquip

From SphereWiki
Revision as of 20:09, 17 June 2009 by MrSugarCube (talk | contribs) (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...')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.