GetPlayerWeapon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Deprecated)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{Deprecated}}
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]]
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]]



Revision as of 09:30, 25 June 2010


Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.


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