GetPlayerEquippedWeapon: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetPlayerEquippedWeapon(player)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncRetur...")
 
No edit summary
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Get the specified player's equiped weapon Id.}}


{{FuncSyntax|GetPlayerEquippedWeapon(player)}}
{{FuncSyntax|GetPlayerEquippedWeapon(player)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns the weapon ID.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
if GetPlayerEquippedWeapon(playerId) == 21 then
    print("Player has equipped a taser.")
end
<syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{PlayerFunctions}}

Revision as of 19:37, 31 December 2019

GetPlayerEquippedWeapon

Type: Function
Context: Server
Introduced: v1.0

Description

Get the specified player's equiped weapon Id.

Syntax

GetPlayerEquippedWeapon(player)

Parameters

  • player
    The player identifier.

Return Value

  • This function returns the weapon ID.

Example

<syntaxhighlight lang="Lua"> if GetPlayerEquippedWeapon(playerId) == 21 then

   print("Player has equipped a taser.")

end <syntaxhighlight>

See also

Template:PlayerFunctions