KillPlayer

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)

See Also

• forcePlayerMap
• getAlivePlayers
• getDeadPlayers
• getPlayerACInfo
• getPlayerAnnounceValue
• getPlayerBlurLevel
• getPlayerCount
• getPlayerFromName
• getPlayerIdleTime
• getPlayerIP
• getPlayerMoney
• getPlayerName
• getPlayerNametagColor
• getPlayerNametagText
• getPlayerPing
• getPlayerScriptDebugLevel
• getPlayerSerial
• getPlayerTeam
• getPlayerVersion
• getPlayerWantedLevel
• getRandomPlayer
• givePlayerMoney
• isPlayerMapForced
• isPlayerMuted
• isPlayerNametagShowing
• isVoiceEnabled
• redirectPlayer
• resendPlayerACInfo
• resendPlayerModInfo
• setPlayerAnnounceValue
• setPlayerBlurLevel
• setPlayerHudComponentVisible
• setPlayerMoney
• setPlayerMuted
• setPlayerName
• setPlayerNametagColor
• setPlayerNametagShowing
• setPlayerNametagText
• setPlayerScriptDebugLevel
• setPlayerTeam
• setPlayerVoiceBroadcastTo
• setPlayerVoiceIgnoreFrom
• setPlayerWantedLevel
• spawnPlayer
• takePlayerMoney
• takePlayerScreenShot