Difference between revisions of "IsRefEssential"

Revision as of 19:00, 8 August 2010

Syntax:

(isEssential:bool) reference.IsRefEssential

[Ref.]IsRefEssential

Must be called on a reference. Returns true if the reference is an essential actor (meaning they can't be killed, only knocked unconscious).

Example:

if ( myNPCRef.isRefEssential )
  myNPCRef.setRefEssential 0 ; remove the essential flag from the reference
endif

@@ Line 1: / Line 1: @@
-{{BotAddedPage|CSbot|DragoonWraith}}
+A command for [[:Category:Oblivion Script Extender|Oblivion Script Extender]]
-{{Function
- | origin = OBSE
- | summary = Returns whether the referenced actor is essential.
- | name = IsRefEssential
- | returnVal = isEssential
- | returnType = bool
- | referenceType = reference
-}}
-[[Category:Functions]]
+'''Syntax:'''
-[[Category:Functions (OBSE)]]
+ (isEssential:bool) reference.IsRefEssential
-[[Category:Functions (OBSE v0009)]]
-[[Category:Actor Functions]]
+ [''Ref.'']IsRefEssential
-[[Category:Actor Functions (OBSE)]]
+Must be called on a reference. Returns true if the reference is an essential actor (meaning they can't be killed, only knocked unconscious).
+'''Example:'''
+<pre>if ( myNPCRef.isRefEssential )
+  myNPCRef.setRefEssential 0 ; remove the essential flag from the reference
+endif</pre>
+==See Also==
+[[SetRefEssential]]
+[[Category: Functions]]
+[[Category: Functions (OBSE)]]
+[[Category: Actor Value Functions]]
+[[Category: Actor Value Functions (OBSE)]]