GetPlayerWeapon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Visual improvement)
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function tells you which weapon type is in a player's weapon slot.
{{Server client function}}
{{Deprecated|getPedWeapon}}
 
This function tells you which weapon type is in the player's current slot (clientside, you can optionally specify a slot other than the current one). See [[weapon|Weapon Info]]


==Syntax==
==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
int getPlayerWeapon ( player thePlayer )
</syntaxhighlight>
===Required Arguments===
*'''thePlayer''': the [[player]] you want to get the weapon type from.
===Returns===
Returns an [[int]] indicating the type of the weapon the player has currently equipped.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPlayerWeapon ( player thePlayer, [ int weaponSlot = current ] )
int getPlayerWeapon ( player thePlayer, [ int weaponSlot = current ] )
Line 11: Line 27:


===Optional Arguments===
===Optional Arguments===
*'''weaponSlot''': an integer representing the weapon slot (set to the players current slot if not given)
*'''weaponSlot''': an integer representing the weapon slot (set to the players current slot if not given).


===Returns===
===Returns===
Returns an [[int]] indicating the type of the weapon the player has in the specified slot. See [[weapon info]]
Returns an [[int]] indicating the type of the weapon the player has in the specified slot.
 
It should be noted that if a player runs out of ammo for a weapon, it will still return the ID of that weapon in the slot (even if it appears as if the player does not have a weapon at all), though [[getPlayerTotalAmmo]] will return '''0'''.  Therefore, [[getPlayerTotalAmmo]] should be used in conjunction with [[getPlayerWeapon]] in order to check if a player has a weapon.
</section>


==Example==
==Example==
This example will display a player's current weapon type. In this case, it is hard coded to use the player called ''someguy''.
<section name="Example" class="server" show="true">
This serverside example will display a player's current weapon type. In this case, it is hard coded to use the player called ''someguy''.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Find a player called someguy and find his current weapon id.
-- Find a player called someguy and find his current weapon id.
weaponType = getPlayerWeapon ( findPlayer ( "someguy" ) )
local weaponType = getPlayerWeapon ( getPlayerFromNick ( "someguy" ) )
-- If a weapon type was returned then
-- If a weapon type was returned then
if ( weaponType ) then
if ( weaponType ) then
   outputChatBox ( "Someguy's current Weapon-type: " .. weaponType .. "." ) -- Display the weapon type in the chat box
   outputChatBox ( "someguy's current Weapon-type: " .. weaponType .. "." ) -- Display the weapon type in the chat box
end
end
</syntaxhighlight>
</syntaxhighlight>
</section>


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

Latest revision as of 11:25, 26 June 2014

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use getPedWeapon instead.


This function tells you which weapon type is in the player's current slot (clientside, you can optionally specify a slot other than the current one). See Weapon Info

Syntax

Click to collapse [-]
Server
int getPlayerWeapon ( player thePlayer )

Required Arguments

  • thePlayer: the player you want to get the weapon type from.

Returns

Returns an int indicating the type of the weapon the player has currently equipped.

Click to collapse [-]
Client
int getPlayerWeapon ( player thePlayer, [ int weaponSlot = current ] )

Required Arguments

  • thePlayer: the player you want to get the weapon type from.

Optional Arguments

  • weaponSlot: an integer representing the weapon slot (set to the players current slot if not given).

Returns

Returns an int indicating the type of the weapon the player has in the specified slot.

It should be noted that if a player runs out of ammo for a weapon, it will still return the ID of that weapon in the slot (even if it appears as if the player does not have a weapon at all), though getPlayerTotalAmmo will return 0. Therefore, getPlayerTotalAmmo should be used in conjunction with getPlayerWeapon in order to check if a player has a weapon.

Example

Click to collapse [-]
Example

This serverside example will display a player's current weapon type. In this case, it is hard coded to use the player called someguy. 

-- Find a player called someguy and find his current weapon id.
local weaponType = getPlayerWeapon ( getPlayerFromNick ( "someguy" ) )
-- If a weapon type was returned then
if ( weaponType ) then
  outputChatBox ( "someguy's current Weapon-type: " .. weaponType .. "." ) -- Display the weapon type in the chat box
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerWeapon?oldid=40323"