Difference between revisions of "OnTrigger - ObjectReference"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Cipscis
m (Reverted edits by Heecf (talk) to last revision by Jlundin)
(Add detail about how often the event is sent)
 
Line 4: Line 4:
'''Member of:''' [[ObjectReference Script]]
'''Member of:''' [[ObjectReference Script]]


Event called when the object reference is a trigger and has been triggered. This event will be sent every so often while a reference stays inside the trigger box.
Event called when the object reference is a trigger and has been triggered. This event will be sent every so often while a reference stays inside the trigger box (approximately two times a second).


== Syntax ==
== Syntax ==

Latest revision as of 15:18, 20 March 2022

Member of: ObjectReference Script

Event called when the object reference is a trigger and has been triggered. This event will be sent every so often while a reference stays inside the trigger box (approximately two times a second).

Syntax[edit | edit source]

Event OnTrigger(ObjectReference akActionRef)

Parameters[edit | edit source]

Examples[edit | edit source]

Event OnTrigger(ObjectReference akActionRef)
  Debug.Trace(akActionRef + " just hit us!")
EndEvent

Notes[edit | edit source]

This event is sent repeatedly, so care should be taken not to tie up the script system unnecessarily with a long complicated handler. Try using the trigger enter and leave events instead.

See Also[edit | edit source]