EquipPlayerWeaponSlot: Difference between revisions

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


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Equip the specified weapon slot for the specified player.}}


{{FuncSyntax|EquipPlayerWeaponSlot(player, weaponslot)}}
{{FuncSyntax|EquipPlayerWeaponSlot(player, weaponslot)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier.}}
{{FuncParam|weaponslot|__EDIT_ME__}}
{{FuncParam|weaponslot|The weapon slot (range 1 - 3)}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns ''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
EquipPlayerWeaponSlot(playerId, 1)
</syntaxhighlight>


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

Latest revision as of 11:03, 2 September 2020

EquipPlayerWeaponSlot

Type: Function
Context: Server
Introduced: v1.0

Description

Equip the specified weapon slot for the specified player.

Syntax

EquipPlayerWeaponSlot(player, weaponslot)

Parameters

  • player
    The player identifier.
  • weaponslot
    The weapon slot (range 1 - 3)

Return Value

  • This function returns true' on success.

Example

EquipPlayerWeaponSlot(playerId, 1)

See also