Difference between revisions of "KillEssential - Actor"
Jump to navigation
Jump to search
imported>Rhavlovick m (1 revision: Clobber re-import by Henning) |
imported>Gavrant (Note about KillEssential not working for non-unique actors) |
||
| Line 8: | Line 8: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
Function KillEssential(Actor akKiller = None) | Function KillEssential(Actor akKiller = None) | ||
ActorBase akActorBase = GetBaseObject() as ActorBase | |||
if akActorBase.IsUnique() | |||
akActorBase.SetEssential(0) | |||
endif | |||
Kill(akKiller) | |||
endFunction | |||
</source> | </source> | ||
| Line 22: | Line 28: | ||
ImportantPerson.KillEssential(Dragon) | ImportantPerson.KillEssential(Dragon) | ||
</source> | </source> | ||
== Notes == | |||
* KillEssential() does not work for essential actors whose actor base is not flagged as Unique. | |||
== See Also == | == See Also == | ||
Revision as of 08:24, 25 September 2019
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)
endFunctionParameters
- 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.