SetEssential - Actor | Fallout 4

Found in:

Vanilla
F4SE

voidfunctionSetEssential(boolabEssential)Native

Description

Wiki Description

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.

Documentation Comment

overrides the Essential status of the actor

Caveats

CK Wiki - 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.

Parameters

boolabEssential

CK Wiki Description

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

Examples

; Flag the Emperor as essential
EmperorBaseActorProperty.SetEssential()

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

Auto-Generated Example

bool myBool__abEssential

myActor__toCallFunctionOn.SetEssential(myBool__abEssential)

Actor
Actor.SetProtected(...)

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki