GetActionRef

Revision as of 14:26, 9 April 2009 by imported>PoHa! (Copied info from CS Wiki; removed incomplete tag)

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

IsActionRef
OnTrigger