SetPlayerHealth - Revision history

Woovie at 22:24, 1 July 2019

2019-07-01T22:24:07Z

← Older revision		Revision as of 22:24, 1 July 2019
Line 1:		Line 1:
			__NOTOC__
			{{Server client function}}
	{{Deprecated\|setElementHealth\|}}		{{Deprecated\|setElementHealth\|}}

2019-07-01T22:23:54Z

← Older revision		Revision as of 22:23, 1 July 2019
Line 1:		Line 1:
	~~#REDIRECT [[~~setElementHealth]]		{{Deprecated\|setElementHealth\|}}

2019-07-01T22:17:18Z

Add redirect to setElementHealth

← Older revision		Revision as of 22:17, 1 July 2019
Line 1:		Line 1:
	~~{{Deprecated}}~~		#REDIRECT [[setElementHealth]]
	~~__NOTOC__~~
	~~This function allows you to set a player's health.~~

	~~==Syntax==~~
	~~<syntaxhighlight lang="lua">~~
	~~bool setPlayerHealth ( player thePlayer, float playerHealth )~~
	~~</syntaxhighlight>~~

	~~===Required Arguments===~~
	*'''thePlayer''': The [[~~player~~]] ~~whose health you want to set.~~
	*'''playerHealth''': The value you want to set the health to. Valid values are from 0 (dead) to 100 (full health).

	~~===Returns===~~
	~~Returns ''true'' if the player's health was set succesfully. Returns ''false'' if the player argument is invalid, or the health argument is out of range.~~

	~~==Example==~~
	~~<section name="Server" class="server" show="true">~~
	~~This example adds a console command that lets players "slap" each other (doing 20 damage).~~
	~~<syntaxhighlight lang="lua">~~
	~~function slap ( sourcePlayer, command, targetPlayerName )~~
	~~local targetPlayer = getPlayerFromNick ( targetPlayerName ) -- look up the player to be slapped~~
	~~if targetPlayer then -- check if we found him~~
	~~setPlayerHealth ( thePlayer, getPlayerHealth(targetPlayer) - 20 ) -- if so, subtract 20 from his health~~
	~~else -- otherwise, output an error message~~
	~~outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )~~
	~~end~~
	~~end~~
	~~addCommandHandler ( "slap", slap )~~
	~~</syntaxhighlight></section>~~

	~~==See Also==~~
	~~{{Player functions}}~~
	~~{{Server function}}~~

2007-09-17T00:47:40Z

← Older revision		Revision as of 00:47, 17 September 2007
Line 1:		Line 1:
			{{Deprecated}}
	__NOTOC__		__NOTOC__
	This function allows you to set a player's health.		This function allows you to set a player's health.

2007-08-16T11:16:02Z

← Older revision		Revision as of 11:16, 16 August 2007
Line 21:		Line 21:
	local targetPlayer = getPlayerFromNick ( targetPlayerName ) -- look up the player to be slapped		local targetPlayer = getPlayerFromNick ( targetPlayerName ) -- look up the player to be slapped
	if targetPlayer then -- check if we found him		if targetPlayer then -- check if we found him
	setPlayerHealth ( thePlayer, getPlayerHealth(targetPlayer) - 20 ) -- subtract 20 from his health		setPlayerHealth ( thePlayer, getPlayerHealth(targetPlayer) - 20 ) -- if so, subtract 20 from his health
	else -- ~~if the target player wasn't found~~, output an error message		else -- otherwise, output an error message
	outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )		outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )
	end		end

2007-08-16T11:13:56Z

← Older revision		Revision as of 11:13, 16 August 2007
Line 16:		Line 16:
	==Example==		==Example==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	This example ~~finds "player" and when~~ "slap" ~~is entered, their health is decreased~~		This example adds a console command that lets players "slap" each other (doing 20 damage).
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function slap ( ~~player~~, command ) --~~calls~~ the ~~function~~		function slap ( sourcePlayer, command, targetPlayerName )
	setPlayerHealth ( ~~player~~, getPlayerHealth(~~player~~) - 20 ) --~~sets~~ the player ~~health~~		local targetPlayer = getPlayerFromNick ( targetPlayerName ) -- look up the player to be slapped
	end		if targetPlayer then -- check if we found him
			setPlayerHealth ( thePlayer, getPlayerHealth(targetPlayer) - 20 ) -- subtract 20 from his health
			else -- if the target player wasn't found, output an error message
			outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )
			end
			end
	addCommandHandler ( "slap", slap )		addCommandHandler ( "slap", slap )
	</syntaxhighlight></section>		</syntaxhighlight></section>

2007-08-14T23:08:42Z

← Older revision		Revision as of 23:08, 14 August 2007
Line 15:		Line 15:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	This example finds "player" and when "slap" is entered, their health is decreased		This example finds "player" and when "slap" is entered, their health is decreased
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 21:		Line 22:
	end		end
	addCommandHandler ( "slap", slap )		addCommandHandler ( "slap", slap )
	</syntaxhighlight>		</syntaxhighlight></section>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}
			{{Server function}}

2007-08-06T07:08:11Z

← Older revision		Revision as of 07:08, 6 August 2007
Line 18:		Line 18:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function slap ( player, command ) --calls the function		function slap ( player, command ) --calls the function
	setPlayerHealth ( player, getPlayerHealth - 20 ) --sets the player health		setPlayerHealth ( player, getPlayerHealth(player) - 20 ) --sets the player health
	end		end
	addCommandHandler ( "slap", slap )		addCommandHandler ( "slap", slap )

2007-08-06T06:52:44Z

← Older revision		Revision as of 06:52, 6 August 2007
Line 15:		Line 15:

	==Example==		==Example==
	This example finds a player ~~called ''someguy''~~ and ~~sets~~ their health ~~to 1 (almost dead).~~		This example finds "player" and when "slap" is entered, their health is decreased
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- ~~Try to set~~ the ~~health of a player called 'someguy' to 1~~		function slap ( player, command ) --calls the function
	~~if (~~ setPlayerHealth ( ~~findPlayer ( "someguy" )~~, ~~1 )~~ ) ~~then~~		setPlayerHealth ( player, getPlayerHealth - 20 ) --sets the player health
	-- ~~Tell everyone that someguy has lost lots of~~ health		end
	~~outputChatBox~~ ( "~~Someguy's life expectancy just got a lot less expected.~~" )		addCommandHandler ( "slap", slap )
	~~end~~
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}

2006-05-20T20:04:43Z