KillPlayer: Difference between revisions
Jump to navigation
Jump to search
(added another example) |
No edit summary |
||
Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool killPlayer ( player thePlayer, [ player theKiller = nil, int weapon=255, int bodyPart=255 ] )</syntaxhighlight> | <syntaxhighlight lang="lua">bool killPlayer ( player thePlayer, [ player theKiller = nil, int weapon=255, int bodyPart=255, bool stealth ] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
Line 13: | Line 13: | ||
* '''weapon:''' The ID of the weapon that should appear to have killed the player (doesn't affect how they die) | * '''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) | * '''bodyPart:''' The ID of the body part that should appear to have been hit by the weapon (doesn't affect how they die) | ||
* '''stealth:''' Boolean value, representing whether or not this a stealth kill ('''From DP3''') | |||
===Returns=== | ===Returns=== |
Revision as of 09:53, 1 April 2008
This function kills the specified player.
Syntax
bool killPlayer ( player thePlayer, [ player theKiller = nil, int weapon=255, int bodyPart=255, bool stealth ] )
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)
- stealth: Boolean value, representing whether or not this a stealth kill (From DP3)
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", getRootElement(), headshotKill )
See Also
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerScriptDebugLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState