KillPlayer: Difference between revisions

Latest revision as of 07:08, 4 November 2020

	This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
	Please use killPed instead.

This function kills the specified player.

Syntax

bool killPlayer ( player thePlayer, [ player theKiller = nil, int weapon=255, int bodyPart=255 ] )

Required Arguments

thePlayer: The player to kill

Optional Arguments

theKiller: The player responsible for the kill
weapon: The ID of the weapon that should appear to have killed the player (doesn't affect how they die)
bodyPart: The ID of the body part that should appear to have been hit by the weapon (doesn't affect how they die)

Returns

Returns true if the player was killed, false if the player specified could not be killed or is invalid.

Example

Example 1: This simple example adds a kill command to commit suicide.

function commitSuicide(sourcePlayer)
	-- kill the player and make him responsible for it
	killPlayer(sourcePlayer, sourcePlayer)
end
-- attach our handler to the "kill" command
addCommandHandler("kill", commitSuicide)

Example 2: This example enables 1 hit kills if a player is shot in the head.

function headshotKill ( attacker, attackerweapon, bodypart, loss )
	if bodypart == 9 then --if the bodypart is the head
		--kill the player, emulating the correct killer, weapon and bodypart.
		killPlayer ( source, attacker, attackerweapon, bodypart )
	end
end
addEventHandler ( "onPlayerDamage", root, headshotKill )

@@ Line 1: / Line 1: @@
 __NOTOC__
-This function kills the specified player. It returns a boolean value (true or false) depending on whether the function passed or failed.
+{{Server function}}
+{{Deprecated|killPed|}}
+This function kills the specified player.
 ==Syntax==
-<syntaxhighlight lang="lua">bool KillPlayer ( player thePlayer )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool killPlayer ( player thePlayer, [ player theKiller = nil, int weapon=255, int bodyPart=255 ] )</syntaxhighlight>
 ===Required Arguments===
-* '''player''': A [[player]] object referencing the specified player.
+* '''thePlayer:''' The [[player]] to kill
+===Optional Arguments===
+* '''theKiller:''' The player responsible for the kill
+* '''weapon:''' The ID of the weapon that should appear to have killed the player (doesn't affect how they die)
+* '''bodyPart:''' The ID of the body part that should appear to have been hit by the weapon (doesn't affect how they die)
 ===Returns===
-Returns true if the function succeeded, and false otherwise.
+Returns ''true'' if the player was killed, ''false'' if the player specified could not be killed or is invalid.
 ==Example==
-<syntaxhighlight lang="lua">player = GetPlayerFromID ( 1 )
+'''Example 1:''' This simple example adds a '''kill''' command to commit suicide.
- if ( KillPlayer ( player ) )
+<syntaxhighlight lang="lua">
- outputChatBox ( ( GetPlayerName ( player ), " was eliminated." ), source )
+function commitSuicide(sourcePlayer)
- end</syntaxhighlight>
+	-- kill the player and make him responsible for it
+	killPlayer(sourcePlayer, sourcePlayer)
+end
+-- attach our handler to the "kill" command
+addCommandHandler("kill", commitSuicide)
+</syntaxhighlight>
+'''Example 2:''' This example enables 1 hit kills if a player is shot in the head.
+<syntaxhighlight lang="lua">
+function headshotKill ( attacker, attackerweapon, bodypart, loss )
+	if bodypart == 9 then --if the bodypart is the head
+		--kill the player, emulating the correct killer, weapon and bodypart.
+		killPlayer ( source, attacker, attackerweapon, bodypart )
+	end
+end
+addEventHandler ( "onPlayerDamage", root, headshotKill )
+</syntaxhighlight>
+==See Also==
+{{Player functions}}