SetPlayerArmor: Difference between revisions

From Onset Developer Wiki
(Documented parameters, return value and added realtedFunction)
No edit summary
 
(2 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|Set the armor of the player.}}


{{FuncSyntax|SetPlayerArmor(player, armor)}}
{{FuncSyntax|SetPlayerArmor(player, armor)}}
Line 9: Line 9:
{{FuncParam|armor|The armor value.}}
{{FuncParam|armor|The armor value.}}


{{FuncReturnValue|This function doesn't doesn't have a return value.}}
{{FuncReturnValue|This function doesn't have a return value.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
--This command allows players to set refill their armor
function armor(player)
  SetPlayerArmor(player, 100)
end
AddCommand('armor', armor)
 
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
[[GetPlayerArmor]]
* [[GetPlayerArmor]]

Latest revision as of 15:50, 19 November 2019

SetPlayerArmor

Type: Function
Context: Server
Introduced: v1.0

Description

Set the armor of the player.

Syntax

SetPlayerArmor(player, armor)

Parameters

  • player
    The player identifier.
  • armor
    The armor value.

Return Value

  • This function doesn't have a return value.

Example

--This command allows players to set refill their armor
function armor(player)
   SetPlayerArmor(player, 100)
end
AddCommand('armor', armor)

See also