Difference between revisions of "GetActionRef"
Jump to navigation
Jump to search
imported>Skyranger-1 |
imported>Haama (→Notes: Most common block people try) |
||
| Line 6: | Line 6: | ||
==Notes== | ==Notes== | ||
* This function is only useful inside some block types. It is known to work in [[OnActivate]] and [[OnTrigger]] blocks. There are also reports of it working in [[OnHit]] blocks, which implies it might work in some other block types as well. | * This function is only useful inside some block types. It is known to work in [[OnActivate]] and [[OnTrigger]] blocks. There are also reports of it working in [[OnHit]] blocks, which implies it might work in some other block types as well. | ||
** It does ''not'' work in an [[onEquip]] 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]]: | * 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 ) | <pre>if ( GetActionRef == player ) | ||
if ( IsActionRef player ) ; these two expressions are equivalent</pre> | if ( IsActionRef player ) ; these two expressions are equivalent</pre> | ||
==See Also== | ==See Also== | ||
[[IsActionRef]] | [[IsActionRef]] | ||
Revision as of 09:45, 2 May 2008
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 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 some block types. It is known to work in OnActivate and OnTrigger blocks. There are also reports of it working in OnHit blocks, which implies it might work in some other block types as well.
- It does not work in an onEquip 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