GetPickupWeapon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
FeaturedPro (talk | contribs) m (Removed leading whitespace from syntax) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Server client function}} | |||
__NOTOC__ | |||
__NOTOC__ | This function retrieves the weapon ID of a weapon pickup. | ||
This | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getPickupWeapon ( pickup | int getPickupWeapon ( pickup thePickup ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''thePickup:''' The pickup of which you wish to retrieve the weapon | ||
===Returns=== | ===Returns=== | ||
Returns | Returns the [[Weapons|Weapon ID]] of the pickup, or ''false'' if the pickup is invalid. | ||
==Example== | ==Example== | ||
This example | This example gives extra ammo to a player if a pickup only has a small amount of ammo. | ||
<section name="Server" class="server" show="true"> | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function onPickupHitFunc ( thePlayer ) -- when a pickup is hit | ||
if getPickupType ( source ) == 2 then -- check if it's a weapon pickup | |||
-- | local ammo = getPickupAmmo ( source ) -- get the pickup ammo | ||
if ammo < 50 then -- if ammo is less than 50 | |||
local weapon = getPickupWeapon ( source ) -- store pickup weapon | |||
giveWeaponAmmo ( thePlayer, weapon, 50 ) -- give an extra 50 ammo | |||
end | |||
end | |||
end | |||
addEventHandler ( "onPickupHit", root, onPickupHitFunc ) -- add the function as handler for onPickupHit | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{ | {{IDs}} | ||
{{Pickup functions}} | |||
Latest revision as of 20:23, 22 January 2022
This function retrieves the weapon ID of a weapon pickup.
Syntax
int getPickupWeapon ( pickup thePickup )
Required Arguments
- thePickup: The pickup of which you wish to retrieve the weapon
Returns
Returns the Weapon ID of the pickup, or false if the pickup is invalid.
Example
This example gives extra ammo to a player if a pickup only has a small amount of ammo.
Click to collapse [-]
Serverfunction onPickupHitFunc ( thePlayer ) -- when a pickup is hit
if getPickupType ( source ) == 2 then -- check if it's a weapon pickup
local ammo = getPickupAmmo ( source ) -- get the pickup ammo
if ammo < 50 then -- if ammo is less than 50
local weapon = getPickupWeapon ( source ) -- store pickup weapon
giveWeaponAmmo ( thePlayer, weapon, 50 ) -- give an extra 50 ammo
end
end
end
addEventHandler ( "onPickupHit", root, onPickupHitFunc ) -- add the function as handler for onPickupHit
See Also
GTASA IDs (vehicles, weapons, weathers, characters, colors): http://info.vces.net/ (Special thanks to Brophy and Ratt for making these lists)