Difference between revisions of "GetActionRef"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-Link to TES4 Construction Set Wiki +{{Incomplete}}\n\nLink to TES4 Construction Set Wiki)) |
imported>PoHa! (Copied info from CS Wiki; removed incomplete tag) |
||
| Line 1: | Line 1: | ||
'''Syntax:''' | |||
set refVar to GetActionRef | |||
Returns the reference currently interacting with the scripted object. It will only return a value during the frame after the object has been interacted with. This means it is generally only useful inside an [[OnActivate]], [[OnTriggerEnter]], [[OnTriggerLeave]] or [[OnTrigger]] block. If more than one object is interacting with the object (for instance, several objects colliding with the same trigger zone), only the most recently interacting object will be returned by this function. | |||
==Notes== | |||
* This function is only useful inside an OnActivate, OnTriggerEnter, OnTriggerLeave, or OnTrigger block. | |||
* Unlike [[IsActionRef]], which checks for a specific reference, this function returns a reference. However, it can be used to imitate the behavior of [[IsActionRef]]: | |||
<pre>if ( GetActionRef == player ) | |||
if ( IsActionRef player ) ; these two expressions are equivalent</pre> | |||
==See Also== | |||
[[IsActionRef]]<BR> | |||
[[OnTrigger]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Reference Variable Functions]] | [[Category:Reference Variable Functions]] | ||
<!-- Begin Search Terms | |||
Get | |||
Action | |||
Ref | |||
End Search Terms --> | |||
Revision as of 13:26, 9 April 2009
Syntax:
set refVar to GetActionRef
Returns the reference currently interacting with the scripted object. It will only return a value during the frame after the object has been interacted with. This means it is generally only useful inside an OnActivate, OnTriggerEnter, OnTriggerLeave or OnTrigger block. If more than one object is interacting with the object (for instance, several objects colliding with the same trigger zone), only the most recently interacting object will be returned by this function.
Notes
- This function is only useful inside an OnActivate, OnTriggerEnter, OnTriggerLeave, or OnTrigger block.
- Unlike IsActionRef, which checks for a specific reference, this function returns a reference. However, it can be used to imitate the behavior of IsActionRef:
if ( GetActionRef == player ) if ( IsActionRef player ) ; these two expressions are equivalent
See Also