Editing OnTrigger - ObjectReference

[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Events]]
'''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 ==
<syntaxhighlight lang="papyrus">
Event OnTrigger(ObjectReference akActionRef)
</syntaxhighlight>

== Parameters ==
*akActionRef: The [[ObjectReference Script (Papyrus)|ObjectReference]] that triggered this reference.

== Examples ==
<syntaxhighlight lang="papyrus">
Event OnTrigger(ObjectReference akActionRef)
  Debug.Trace(akActionRef + " just hit us!")
EndEvent
</syntaxhighlight>

== Notes ==
* 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.
* The rate at which this event is sent is controlled by the <code>[Havok]fTriggerEventDelayMS</code> INI setting, which defaults to 500.0. On Windows, the game measures how many milliseconds have passed since a trigger last sent a batch of OnTrigger events using the <code>QueryPerformanceCounter</code> Win32 API.
* OnTrigger events are sent all at once for all refs (whose collision layers match that of the trigger) within the trigger's volume.

== See Also ==
*[[ObjectReference Script]]
*[[OnTriggerEnter - ObjectReference]]
*[[OnTriggerLeave - ObjectReference]]