Difference between revisions of "GetActionRef"
Jump to navigation
Jump to search
imported>Kkuhlmann |
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1))) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
=='''Description'''== | |||
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. | |||
=='''Syntax'''== | |||
set refVar to GetActionRef | |||
set refVar to GetAR | |||
=='''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]] | |||
[[OnTrigger]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Functions (GECK 1.1)]]<BR> | |||
[[Category:Reference Variable Functions]] | [[Category:Reference Variable Functions]] | ||
[[Category:Reference Variable Functions (GECK 1.1)]] | |||
<!-- Begin Search Terms | |||
Get | |||
Action | |||
Ref | |||
End Search Terms --> | |||
Latest revision as of 12:14, 15 August 2009
Description[edit | edit source]
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.
Syntax[edit | edit source]
set refVar to GetActionRef set refVar to GetAR
Notes[edit | edit source]
- 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[edit | edit source]