Difference between revisions of "KillActor"
Jump to navigation
Jump to search
Updated to function template, added note about SetScale (full scale of bug not currently known)
imported>Quetzilla (probably should make template for body part dismember locations) |
imported>Cipscis (Updated to function template, added note about SetScale (full scale of bug not currently known)) |
||
| Line 1: | Line 1: | ||
== | {{Function | ||
|CSWikiPage = Kill | |||
|origin = GECK1 | |||
|summary = [[KillActor]] kills the calling actor and takes three optional parameters to set who killed it, which limb to dismember, and the cause of death. See [[GetCauseofDeath]] for death values. | |||
== | |alias = Kill | ||
|referenceType = Actor | |||
|arguments = {{FunctionArgument | |||
|Name = Killer | |||
= | |Type = ref | ||
|Optional = Optional | |||
}}{{FunctionArgument | |||
|Name = DismemberLimb | |||
|Type = int | |||
|Optional = Optional | |||
}}{{FunctionArgument | |||
|Name = CauseOfDeath | |||
|Type = int | |||
== | |Optional = Optional | ||
}} | |||
|Example = Kill player 1 0 | |||
The scripted reference is killed by the player, their head is destroyed, and they are marked as having been killed by an explosion. | |||
}} | |||
==Notes== | |||
*Use some dummy NPC (e.g. CG01DadREF) for Killer param if you don't care who killed him and just want to use the other optional parameters. (Do NOT use player since that will cause "limb crippled" messages to be displayed.) | *Use some dummy NPC (e.g. CG01DadREF) for Killer param if you don't care who killed him and just want to use the other optional parameters. (Do NOT use player since that will cause "limb crippled" messages to be displayed.) | ||
| Line 40: | Line 45: | ||
**14 - Weapon | **14 - Weapon | ||
*Actors under the effect of [[SetScale]] may remain unaffected by [[KillActor]] | |||
[[ | |||
[[ | |||
== | ==See Also== | ||
*[[GetHitLocation]] | |||
*[[GetCauseofDeath]] | |||
*[[Body Part]] | |||
*[[ActorValue]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Godsend Functions]] | [[Category:Godsend Functions]] | ||