KillEssential - Actor

From Creation Kit
Jump to: navigation, search

Member of: Actor Script

Kills this actor with the passed-in actor being the culprit, even if he is essential.

Syntax

Function KillEssential(Actor akKiller = None)
    ActorBase akActorBase = GetBaseObject() as ActorBase
    if akActorBase.IsUnique()
        akActorBase.SetEssential(0)
    endif
    Kill(akKiller)
endFunction

Parameters

  • akKiller: The Actor who is the guilty party in killing this one.
    • Default: None

Return Value

None.

Examples

; Have the dragon kill the important person, even if essential
ImportantPerson.KillEssential(Dragon)

Notes

  • KillEssential() does not work for essential actors whose actor base is not flagged as Unique.

See Also