KillPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Needs_Checking|According to the proposed functions this should have an optional arguments for killer and weapon|[[User:EAi|EAi]]}}__NOTOC__
{{Needs_Checking|According to the proposed functions this should have an optional arguments for killer and weapon|[[User:Erorr404|Erorr404]]}}__NOTOC__
__NOTOC__
__NOTOC__
This function kills the specified player. It returns a boolean value (true or false) depending on whether the function passed or failed.
This function kills the specified player. It returns a boolean value (true or false) depending on whether the function passed or failed.

Revision as of 00:16, 16 August 2006

Dialog-information.png This article needs checking.
Reason(s): According to the proposed functions this should have an optional arguments for killer and weapon

This function kills the specified player. It returns a boolean value (true or false) depending on whether the function passed or failed.

Syntax

bool killPlayer ( player thePlayer )

Required Arguments

  • thePlayer: A player object referencing the specified player.

Returns

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

Example

-- Get the player with an ID of 1
player = getPlayerFromID ( 1 )
-- If a player was found with an ID of 1 then
if ( player )
	-- Kill the player
	if ( killPlayer ( player ) ) then
		-- Inform everyone that they were killed.
		outputChatBox ( ( getPlayerName ( player ), " was eliminated." ) )
	end
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/KillPlayer?oldid=4360"