KillPlayer: Difference between revisions

Revision as of 17:33, 26 August 2007

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

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)

@@ Line 18: / Line 18: @@
 ==Example==
+This simple example adds a '''kill''' command to commit suicide.
 <syntaxhighlight lang="lua">
--- Get the player with an ID of 1
+function commitSuicide(sourcePlayer)
-thePlayer = getPlayerFromID ( 1 )
+	-- kill the player and make him responsible for it
--- If a player was found with an ID of 1 then
+	killPlayer(sourcePlayer, sourcePlayer)
-if ( thePlayer ) then
-	-- Kill the player
-	if ( killPlayer ( thePlayer ) ) then
-		-- Inform everyone that they were killed.
-		outputChatBox ( getPlayerName ( thePlayer ) .. " was eliminated." )
-	end
 end
+-- attach our handler to the "kill" command
+addCommandHandler("kill", commitSuicide)
 </syntaxhighlight>
 ==See Also==
 {{Player functions}}