Difference between revisions of "IsRefEssential"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Scruggs
 
imported>DragoonWraith
m (Reverted edits by CSbot (Talk); changed back to last version by DragoonWraith)
 
(13 intermediate revisions by 6 users not shown)
Line 2: Line 2:


'''Syntax:'''
'''Syntax:'''
(isEssential:bool) reference.IsRefEssential
  [''Ref.'']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).
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:
'''Example:'''
<pre>if ( myNPCRef.isEssential )
<pre>if ( myNPCRef.isRefEssential )
   myNPCRef.setRefEssential 0 ; remove the essential flag from the reference
   myNPCRef.setRefEssential 0 ; remove the essential flag from the reference
endif</pre>
endif</pre>


[[Category: OBSE Functions]]
==See Also==
[[Category: OBSE Reference Functions]]
[[SetRefEssential]]
 
[[Category: Functions]]
[[Category: Functions (OBSE)]]
[[Category: Actor Value Functions]]
[[Category: Actor Value Functions (OBSE)]]

Latest revision as of 19:52, 8 August 2010

A command for Oblivion Script Extender

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

See Also[edit | edit source]

SetRefEssential