Difference between revisions of "IsRefEssential"

Revision as of 18:58, 8 August 2010

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

A function added by the Oblivion Script Extender.

Syntax:

(isEssential:bool) reference.IsRefEssential

Returns whether the referenced actor is essential.

@@ Line 1: / Line 1: @@
-A command for [[:Category:Oblivion Script Extender|Oblivion Script Extender]]
+{{BotAddedPage|CSbot|DragoonWraith}}
+{{Function
+ | origin = OBSE
+ | summary = Returns whether the referenced actor is essential.
+ | name = IsRefEssential
+ | returnVal = isEssential
+ | returnType = bool
+ | referenceType = reference
+}}
-'''Syntax:'''
+[[Category:Functions]]
- (isEssential:bool) reference.IsRefEssential
+[[Category:Functions (OBSE)]]
+[[Category:Functions (OBSE v0009)]]
- [''Ref.'']IsRefEssential
+[[Category:Actor Functions]]
+[[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)]]