OnActivate - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

Event called when the object reference is activated.

Syntax

Event OnActivate(ObjectReference akActionRef)

Parameters

Examples

Event OnActivate(ObjectReference akActionRef)
  Debug.Trace("Activated by " + akActionRef)
EndEvent
 
; Have the event run if the triggering objectreference is the player.
Event OnActivate(ObjectReference akActionRef)
   if akActionRef == Game.GetPlayer()
      ; your code here.
   endif
EndEvent

Notes

  • An actor entering furniture will send this event. However, an actor exiting furniture will send the OnExitFurniture event instead.
  • This event will still be received if the object reference has had its normal activation processing blocked via BlockActivation. It is also most likely running after the object itself has done (or ignored) it's normal activation processing. Which means, for example, that if normally the object is picked up you won't be able to manipulate it as it will have already been moved into the actor's inventory.
  • This event will still be received when attempting to open a door that is locked. Checking a door's current lock state will be needed in order to avoid premature/unwanted activations.

See Also