Difference between revisions of "KillActor"

From GECK

(probably should make template for body part dismember locations)
(Updated to function template, added note about SetScale (full scale of bug not currently known))
Line 1: Line 1:
=='''Description'''==
+
{{Function
 
+
  |CSWikiPage = Kill
'''Kill Actor''' kills a specified actor and takes three optional parameters to set who killed it, which limbs are dismembered, and how it got killed. See [[GetCauseofDeath]] for death values.
+
  |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.
=='''Syntax'''==
+
  |alias = Kill
 
+
  |referenceType = Actor
KillActor ''KillerActorREF (optional), DismemberLimb (optional), CauseOfDeath (optional)''
+
  |arguments = {{FunctionArgument
 
+
    |Name = Killer
=='''Examples'''==
+
    |Type = ref
 
+
    |Optional = Optional
KillActor
+
  }}{{FunctionArgument
 
+
    |Name = DismemberLimb
Kill
+
    |Type = int
 
+
    |Optional = Optional
Kill player, 1, 0
+
  }}{{FunctionArgument
Player killed him, dismembers a limb, marks actor as killed by an explosion.
+
    |Name = CauseOfDeath
 
+
    |Type = int
=='''Notes'''==
+
    |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
  
=='''See Also'''==
+
*Actors under the effect of [[SetScale]] may remain unaffected by [[KillActor]]
[[GetHitLocation]]<br>
+
[[GetCauseofDeath]]<br>
+
[[Body Part]]<br>
+
[[ActorValue]]
+
  
=='''Reference'''==
+
==See Also==
None provided.
+
*[[GetHitLocation]]
<!-- [[KillActor_Reference|List of functions that use KillActor]] (wiki) -->
+
*[[GetCauseofDeath]]
 +
*[[Body Part]]
 +
*[[ActorValue]]
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Godsend Functions]]
 
[[Category:Godsend Functions]]

Revision as of 04:56, 21 July 2009

Link to TES4 Construction Set Wiki: Kill.

A function included in the GECK version 1.1.0.36.

Description

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.

Syntax

Actor.KillActor Killer:ref DismemberLimb:int CauseOfDeath:int 

Or:

Actor.Kill Killer:ref DismemberLimb:int CauseOfDeath:int

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.)
  • When a Body Part is dismembered, all Severable/Explodable body parts that share its assigned ActorValue will also be dismembered.
  • If a body part is not checked as Explodable, neither it nor any body parts that share its ActorValue will explode when dismembered.
  • Dismember body part Locations [as of 12/12/08]
    • 0 - Torso
    • 1 - Head1
    • 2 - Head2
    • 3 - LeftArm1
    • 4 - LeftArm2
    • 5 - RightArm1
    • 6 - RightArm2
    • 7 - LeftLeg1
    • 8 - LeftLeg2
    • 9 - LeftLeg3
    • 10 - RightLeg1
    • 11 - RightLeg2
    • 12 - RightLeg3
    • 13 - Brain
    • 14 - Weapon
  • Actors under the effect of SetScale may remain unaffected by KillActor

See Also

Personal tools