SetPlayerHealth: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetPlayerHealth(player, health)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncParam|...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|You can set the player's health in a range of 0 to 100 units.}}


{{FuncSyntax|SetPlayerHealth(player, health)}}
{{FuncSyntax|SetPlayerHealth(player, health)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|Player you want to set health of}}
{{FuncParam|health|__EDIT_ME__}}
{{FuncParam|health|New health value you want to set player to}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function heal(player)
  SetPlayerHealth(player, 100)
  AddPlayerChat(player, "You've healed yourself")
end
AddCommand('heal', heal)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{ServerPlayerFunctions}}

Latest revision as of 14:51, 26 June 2021

SetPlayerHealth

Type: Function
Context: Server
Introduced: v1.0

Description

You can set the player's health in a range of 0 to 100 units.

Syntax

SetPlayerHealth(player, health)

Parameters

  • player
    Player you want to set health of
  • health
    New health value you want to set player to

Return Value

  • Returns true on success.

Example

function heal(player)
   SetPlayerHealth(player, 100)
   AddPlayerChat(player, "You've healed yourself")
end
AddCommand('heal', heal)

See also

Retrieved from "https://dev.playonset.com/index.php?title=SetPlayerHealth&oldid=4859"