Difference between revisions of "GetPedWeapon"

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Example: Added "getRandomPlayer" for more experimental purpose.)
Line 23: Line 23:
 
<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.
local weaponType = getPedWeapon ( getPlayerFromName ( "someguy" ) )
+
local weaponType = getPedWeapon ( getRandomPlayer() )
 
-- If a weapon type was returned then
 
-- If a weapon type was returned then
 
if ( weaponType ) then
 
if ( weaponType ) then

Revision as of 16:40, 23 June 2012

This function tells you which weapon type is in a certain weapon slot of a ped. See Weapon Info

Syntax

int getPedWeapon ( ped thePed, [ int weaponSlot = current ] )

Required Arguments

  • thePed: the ped you want to get the weapon type from.

Optional Arguments

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

Returns

Returns an int indicating the type of the weapon the ped has in the specified slot. If the slot is empty, it returns 0.

It should be noted that if a ped 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 ped does not have a weapon at all), though getPedTotalAmmo will return 0. Therefore, getPedTotalAmmo should be used in conjunction with getPedWeapon in order to check if a ped has a weapon.

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 = getPedWeapon ( getRandomPlayer() )
-- 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

BETA: FROM VERSION 1.5.8 r20740 ONWARDS