Difference between revisions of "KillActor"

← Older edit

KillActor (edit)

Revision as of 09:39, 12 January 2011

848 bytes added , 09:39, 12 January 2011

no edit summary

Anonymous user

imported>Ez0n3

@@ 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.
+  |name = KillActor
+  |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.)
-=='''Description'''==
+*When a [[Body Part]] is dismembered, all Severable/Explodable body parts that share its assigned [[ActorValue]] will also be dismembered.
-'''Kill Actor''' kills a specified actor and takes three optional parameters to set who killed it, which limb is dismembered, and how it got killed. See [[GetHitLocation]] for limb values and [[GetCauseofDeath]] for death values.
-=='''Syntax'''==
- KillActor ''KillerActorREF (optional), DismemberLimb (optional), CauseOfDeath (optional)''
-=='''Examples'''==
- KillActor
- Kill
- Kill player, 1, 0
+*If a body part is not checked as Explodable, neither it nor any body parts that share its ActorValue will explode when dismembered.
-Player killed him, dismembers a limb, marks actor as killed by an explosion.
-=='''Notes'''==
+*Dismember body part Locations [as of 12/12/08]
-*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.)
+**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
-*Dismember Limb Locations [as of 05/31/08]
+*Actors under the effect of [[SetScale]] may remain unaffected by [[KillActor]]
-**1 - head
-**3 - left arm
-**5 - right arm
-**7 - left leg
-**10 - right leg
-=='''See Also'''==
+*[[KillActor]] can be called on dead actors to dismember limbs
-[[GetHitLocation]]<br>
-[[GetCauseofDeath]]<br>
-=='''Reference'''==
+==See Also==
-None provided.
+*[[GetHitLocation]]
-<!-- [[KillActor_Reference|List of functions that use KillActor]]  (wiki) -->
+*[[GetCauseofDeath]]
+*[[Body Part]]
+*[[ActorValue]]
+*[[ResurrectActor]]
 [[Category:Functions]]
+[[Category:Functions (GECK 1.1)]]
+[[Category:Godsend Functions]]
+[[Category:Godsend Functions (GECK 1.1)]]