GetPlayerWeapon

From Multi Theft Auto: Wiki
Revision as of 16:35, 16 December 2006 by Talidan (talk | contribs)
Jump to navigation Jump to search

This function tells you which weapon type is in a player's weapon slot. See Weapon Info

Syntax

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.

Example

This 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.
weaponType = getPlayerWeapon ( findPlayer ( "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=6785"