Difference between revisions of "IsActionRef"

Latest revision as of 04:24, 15 January 2011

< [[::Category:Functions|Category:Functions]]

Link to TES4 Construction Set Wiki: IsActionRef.

A function included in the GECK version 1.1.0.36.

Useful only inside an OnActivate block. Returns true if the specified ObjectRefID was the activator.

(0, 1:int) IsActionRef ActorRefID:ref

IsActionRef player

begin OnActivate 
  if IsActionRef Player == 1 
     MessageBox "You can't activate me!" 
  else 
     Activate 
  endif 
end

@@ Line 1: / Line 1: @@
-'''Syntax:'''
+{{Function
-  IsActionRef ObjectRefID
+  |CSWikiPage = IsActionRef
-'''Example:'''
+ |origin = GECK1
+ |summary = Useful only inside an OnActivate block. Returns true if the specified ObjectRefID was the activator.
+ |name = IsActionRef
+ |returnVal = 0, 1
+ |returnType = int
+ |arguments =
+  {{FunctionArgument
+   |Name = ActorRefID
+   |Type = ref
+  }}
+ |example =
   IsActionRef player
-Useful only inside an OnActivate block. Returns true if the specified ObjectRefID was the activator.
-For example:
   begin OnActivate
-    if IsActionRef player == 1
+    if IsActionRef Player == 1
-       MessageBox "You can't activate me, sucka!"
+       MessageBox "You can't activate me!"
     else
        Activate
     endif
   end
+}}
+==See Also==
+*[[GetActionRef]]
 [[Category:Functions]]
-[[Category:Functions (GECK 1.0)]]
+[[Category:Functions (GECK 1.1)]]
 [[Category:Object Functions]]
-[[Category:Object Functions (GECK 1.0)]]
+[[Category:Object Functions (GECK 1.1)]]