Difference between revisions of "GetActionRef"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Fella
imported>DragoonWraith
(misc function)
Line 15: Line 15:


[[Category: Functions]]
[[Category: Functions]]
[[Category:Functions (CS)]]
[[Category: Functions (CS)]]
[[Category: Functions (CS 1.0)]]
[[Category: Functions (CS 1.0)]]
[[Category: Miscellaneous Functions]]
[[Category: Miscellaneous Functions (CS 1.0)]]
[[Category: Record Variable Functions]]
[[Category: Record Variable Functions]]
[[Category: Record Variable Functions (CS v1.0)]]
[[Category: Record Variable Functions (CS 1.0)]]

Revision as of 20:59, 21 March 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 an OnActivate 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