Difference between revisions of "SetRefEssential"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
(fixing Example)
imported>CSbot
(Automated import of articles)
Line 1: Line 1:
A command for [[:Category:Oblivion Script Extender|Oblivion Script Extender]]
{{BotAddedPage|CSbot|DragoonWraith}}
{{Function
| origin = OBSE
| summary = Sets the calling ref to be essential or not.
| name = SetRefEssential
| referenceType = reference
| arguments =
  {{FunctionArgument
  | name = newIsEssential
  | type = bool
  }}
}}


'''Syntax:'''
[[Category:Functions]]
reference.SetRefEssential isEssential:bool
[[Category:Functions (OBSE)]]
 
[[Category:Functions (OBSE v0009)]]
[''Ref.'']setRefEssential ''booleanFlag''
[[Category:Actor Functions]]
 
[[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)]]

Revision as of 18:59, 8 August 2010

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

A function added by the Oblivion Script Extender.

Syntax:

(void) reference.SetRefEssential newIsEssential:bool

Sets the calling ref to be essential or not.