Difference between revisions of "ObjectReference Script"

*Event [[OnActivate - ObjectReference|OnActivate]](ObjectReference akActionRef)

**Event received when this object is activated.

*Event [[OnAttachedToCell - ObjectReference|OnAttachedToCell]]()

**Event received when this reference moves from a detached cell to an attached one.

*Event [[OnCellAttach - ObjectReference|OnCellAttach]]()

**Event received when this reference's parent cell attaches.

*Event [[OnCellDetach - ObjectReference|OnCellDetach]]()

**Event received when this reference's parent cell detaches.

*Event [[OnCellLoad - ObjectReference|OnCellLoad]]()

**Event received when everything in the cell that holds this reference has loaded.

*Event [[OnClose - ObjectReference|OnClose]](ObjectReference akActionRef)

**Event received when this object is finished closing.

*Event [[OnContainerChanged - ObjectReference|OnContainerChanged]](ObjectReference akNewContainer, ObjectReference akOldContainer)

**Event received when an object moves into/out of/between containers.

*Event [[OnDestructionStageChanged - ObjectReference|OnDestructionStageChanged]](int aiOldStage, int aiCurrentStage)

**Event received when this object's destruction stage has worsened.

*Event [[OnDetachedFromCell - ObjectReference|OnDetachedFromCell]]()

**Event received when this object moves from an attached cell to a detached cell.

*Event [[OnEquipped - ObjectReference|OnEquipped]](Actor akActor)

**Event received when this object is equipped by an actor.

*Event [[OnGrab - ObjectReference|OnGrab]]()

**Event received when this object is grabbed (z-keyed) by the player.

*Event [[OnHit - ObjectReference|OnHit]](ObjectReference akAggressor, Form akSource, Projectile akProjectile, bool abPowerAttack, bool abSneakAttack, bool abBashAttack, bool abHitBlocked)

**Event received when this object is hit with a weapon or projectile.

*Event [[OnItemAdded - ObjectReference|OnItemAdded]](Form akBaseItem, int aiItemCount, ObjectReference akItemReference, ObjectReference akSourceContainer)

**Event received when an item is inserted into this object's container.

*Event [[OnItemRemoved - ObjectReference|OnItemRemoved]](Form akBaseItem, int aiItemCount, ObjectReference akItemReference, ObjectReference akDestContainer)

**Event received when an item is removed from this object's container.

*Event [[OnLoad - ObjectReference|OnLoad]]()

**Event received when this object's 3d is loaded and ready.

*Event [[OnLockStateChanged - ObjectReference|OnLockStateChanged]]()

**Event received when the lock on this object changes its state.

*Event [[OnMagicEffectApply - ObjectReference|OnMagicEffectApply]](ObjectReference akCaster, MagicEffect akEffect)

**Event received when a magic effect is attempting to be applied to this reference.

*Event [[OnOpen - ObjectReference|OnOpen]](ObjectReference akActionRef)

**Event received when this object is fully opened.

*Event [[OnRead - ObjectReference|OnRead]]()

**Event received when this object is read. (Only applies to books)

*Event [[OnRelease - ObjectReference|OnRelease]]()

**Event received when this object is released by the player (stopped z-keying).

*Event [[OnReset - ObjectReference|OnReset]]()

**Event received when this object is reset.

*Event [[OnSell - ObjectReference|OnSell]](Actor akSeller)

**Event received when this object is sold by someone.

*Event [[OnSpellCast - ObjectReference|OnSpellCast]](Form akSpell)

**Event received when this object casts a spell.

*Event [[OnTrapHit - ObjectReference|OnTrapHit]](ObjectReference akTarget, float afXVel, float afYVel, float afZVel, float afXPos, float afYPos, float afZPos, int aeMaterial, bool abInitialHit, int aeMotionType)

**Event received when this trap object hits a target.

*Event [[OnTrapHitStart - ObjectReference|OnTrapHitStart]](ObjectReference akTarget, float afXVel, float afYVel, float afZVel, float afXPos, float afYPos, float afZPos, int aeMaterial, bool abInitialHit, int aeMotionType)

**Event received when this trap object starts colliding with a target.

*Event [[OnTrapHitStop - ObjectReference|OnTrapHitStop]](ObjectReference akTarget)

**Event received when this trap object stops colliding with a target.

*Event [[OnTranslationAlmostComplete - ObjectReference|OnTranslationAlmostComplete]]()

**Event received when a translation request is almost complete.

*Event [[OnTranslationComplete - ObjectReference|OnTranslationComplete]]()

**Event received when a translation request is complete.

*Event [[OnTranslationFailed - ObjectReference|OnTranslationFailed]]()

**Event received when a translation request has failed.

*Event [[OnTrigger - ObjectReference|OnTrigger]](ObjectReference akActionRef)

**Event received when this object is triggered.

*Event [[OnTriggerEnter - ObjectReference|OnTriggerEnter]](ObjectReference akActionRef)

**Event received when this object's volume is entered.

*Event [[OnTriggerLeave - ObjectReference|OnTriggerLeave]](ObjectReference akActionRef)

**Event received when this object's volume is left.

*Event [[OnUnequipped - ObjectReference|OnUnequipped]](Actor akActor)

**Event received when this object is unequipped by an actor.

*Event [[OnUnload - ObjectReference|OnUnload]]()

**Event received when this object's 3d has been unloaded.

*Event [[OnWardHit - ObjectReference|OnWardHit]](ObjectReference akCaster, Spell akSpell, int aiStatus)

**Event called when the object reference is using a ward that is hit by a spell.