Difference between revisions of "OnObjectEquipped - Actor"
Jump to navigation
Jump to search
imported>RedwoodElf |
m (Minor note that this event fires for more than just weapons and armor.) |
||
| (7 intermediate revisions by 5 users not shown) | |||
| Line 4: | Line 4: | ||
'''Member of:''' [[Actor Script]] | '''Member of:''' [[Actor Script]] | ||
Event called when the actor equips an object. | Event called when the actor equips an object. Note that this includes consumable objects such as potions. | ||
== Syntax == | == Syntax == | ||
<source lang=" | <source lang="text"> | ||
Event OnObjectEquipped(Form akBaseObject, ObjectReference akReference) | Event OnObjectEquipped(Form akBaseObject, ObjectReference akReference) | ||
</source> | </source> | ||
| Line 13: | Line 13: | ||
== Parameters == | == Parameters == | ||
*akBaseObject: The base object the actor just equipped. | *akBaseObject: The base object the actor just equipped. | ||
*akReference: The reference that the actor just equipped - if the reference is | *akReference: The reference that the actor just equipped - if the reference is persistent. Otherwise, None. | ||
== Examples == | == Examples == | ||
| Line 25: | Line 25: | ||
== Notes == | == Notes == | ||
* | *An [[OnObjectUnequipped - Actor|OnObjectUnequipped()]] event will always get sent before [[OnObjectEquipped - Actor|OnObjectEquipped()]] when equipping an item to an occupied equipment slot. | ||
**The OnObjectEquipped() event does not wait for the OnObjectUnequipped() event to complete before starting. Adding the Utility.Wait(n) function at the beginning of the OnObjectEquipped() event script can help ensure it waits for the first event to finish. | |||
== See Also == | == See Also == | ||
Latest revision as of 23:08, 1 December 2021
Member of: Actor Script
Event called when the actor equips an object. Note that this includes consumable objects such as potions.
Syntax[edit | edit source]
Event OnObjectEquipped(Form akBaseObject, ObjectReference akReference)
Parameters[edit | edit source]
- akBaseObject: The base object the actor just equipped.
- akReference: The reference that the actor just equipped - if the reference is persistent. Otherwise, None.
Examples[edit | edit source]
Event OnObjectEquipped(Form akBaseObject, ObjectReference akReference)
if akBaseObject as Weapon
Debug.Trace("This actor just equipped a weapon!")
endIf
endEventNotes[edit | edit source]
- An OnObjectUnequipped() event will always get sent before OnObjectEquipped() when equipping an item to an occupied equipment slot.
- The OnObjectEquipped() event does not wait for the OnObjectUnequipped() event to complete before starting. Adding the Utility.Wait(n) function at the beginning of the OnObjectEquipped() event script can help ensure it waits for the first event to finish.