SetEssential - Actor

Member of: Actor Script

Sets or clears this actor's essential flag. If the actor is protected and you set the essential flag, the protected flag will be removed. This works on an individual actor, not the Actor Base.

Syntax

Function SetEssential(bool abEssential) native

Parameters

• abEssential: Whether to set or clear this actor's essential flag.

Return Value

None.

Examples

; Flag the Emperor as essential
EmperorBaseActorProperty.SetEssential()

; Flag RedShirt as non-essential
RedShirtBaseActorProperty.SetEssential(false)

Notes

Once this function is called it overrides all other methods to make an actor essential. Changing the state on the actor base will no longer have any effect, nor will the essential flag on any alias filled by the actor.

See Also

• Actor Script
• SetProtected - Actor