Difference between revisions of "SetRefEssential"

Revision as of 19:01, 8 August 2010

Syntax:

reference.SetRefEssential isEssential:bool

[Ref.]setRefEssential booleanFlag

Sets the calling ref to be essential or not.

Example:

if ( myNPCRef.isRefEssential == 0 )
  myNPCRef.setRefEssential 1 ; make the reference essential
endif

@@ Line 1: / Line 1: @@
-{{BotAddedPage|CSbot|DragoonWraith}}
+A command for [[:Category:Oblivion Script Extender|Oblivion Script Extender]]
-{{Function
- | origin = OBSE
- | summary = Sets the calling ref to be essential or not.
- | name = SetRefEssential
- | referenceType = reference
- | arguments =
-  {{FunctionArgument
-   | name = newIsEssential
-   | type = bool
-  }}
-}}
-[[Category:Functions]]
+'''Syntax:'''
-[[Category:Functions (OBSE)]]
+ reference.SetRefEssential isEssential:bool
-[[Category:Functions (OBSE v0009)]]
-[[Category:Actor Functions]]
+ [''Ref.'']setRefEssential ''booleanFlag''
-[[Category:Actor Functions (OBSE)]]
+Sets the calling ref to be essential or not.
+==Notes==
+* Essential actors cannot be killed, only knocked unconscious.
+* Must be called on a reference to an actor.
+* Set to 1 to flag the reference as essential or 0 to clear the flag.
+'''Example:'''
+<pre>
+if ( myNPCRef.isRefEssential == 0 )
+  myNPCRef.setRefEssential 1 ; make the reference essential
+endif</pre>
+==See Also==
+[[IsRefEssential]]
+[[Category: Functions]]
+[[Category: Functions (OBSE)]]
+[[Category: Actor Value Functions]]
+[[Category: Actor Value Functions (OBSE)]]