GetPickupWeapon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (Removed leading whitespace from syntax)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
{{Server client function}}
 
__NOTOC__
__NOTOC__  
This function retrieves the weapon ID of a weapon pickup.
This fake function is for use with blah & blah and does blahblahblabhalbhl
 
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPickupWeapon ( pickup pickup )        
int getPickupWeapon ( pickup thePickup )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''thePickup:''' The pickup of which you wish to retrieve the weapon
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns the [[Weapons|Weapon ID]] of the pickup, or ''false'' if the pickup is invalid.


==Example==  
==Example==  
This example does...
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">
--This line does...
function onPickupHitFunc ( thePlayer )                  -- when a pickup is hit
blabhalbalhb --abababa
    if getPickupType ( source ) == 2 then              -- check if it's a weapon pickup
--This line does this...
        local ammo = getPickupAmmo ( source )          -- get the pickup ammo
mooo
        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==
{{FunctionArea_Functions}}
{{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 [-]
Server
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

See Also

GTASA IDs (vehicles, weapons, weathers, characters, colors): http://info.vces.net/ (Special thanks to Brophy and Ratt for making these lists)