Difference between revisions of "IsRefEssential"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Raziel23x
(Update)
imported>WereWolf
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.isEssential )
   myNPCRef.setRefEssential 0 ; remove the essential flag from the reference
   myNPCRef.setRefEssential 0 ; remove the essential flag from the reference
Line 13: Line 15:
==See Also==
==See Also==
[[SetRefEssential]]
[[SetRefEssential]]
[[Category: OBSE Functions]]
<!--[[Category: OBSE Functions]]
[[Category: OBSE Reference Functions]]
[[Category: OBSE Reference Functions]]
[[Category: OBSE_Actor_Functions]]
[[Category: OBSE_Actor_Functions]]-->
[[Category: Actor_Value_Functions_(OBSE)]]
[[Category: Functions]]
[[Category: Functions (OBSE)]]
[[Category: Record Variable Functions]]
[[Category: Record Variable Functions (OBSE)]]
[[Category: Actor Value Functions]]
[[Category: Actor Value Functions (OBSE)]]

Revision as of 15:38, 14 September 2007

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.isEssential )
  myNPCRef.setRefEssential 0 ; remove the essential flag from the reference
endif

See Also

SetRefEssential