GetPickupAmmo: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This | {{Server client function}} | ||
This function retrieves the amount of ammo in a weapon pickup. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getPickupAmmo ( pickup | int getPickupAmmo ( pickup thePickup ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''thePickup:''' The pickup in which you wish to retrieve the ammo of | ||
===Returns=== | ===Returns=== | ||
Returns '' | Returns an ''integer'' of the amount of ammo in the pickup, ''false'' if the pickup element is invalid, 0 if it's no weapon pickup. | ||
==Example== | ==Example== | ||
This example | This example outputs a message with the picked up weapon and ammo to the player. | ||
<section show="true" name="Server" class="server"> | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function onPickupHitFunction ( thePlayer ) | ||
if getPickupType ( source ) ~= 2 then return end -- if the pickup is no weapon, stop | |||
-- | local ammo = getPickupAmmo ( source ) -- get the amount of ammo | ||
local weapon = getPickupWeapon ( source ) -- get the weapon of the pickup | |||
outputChatBox ( "You just picked up a " .. getWeaponNameFromID(weapon) .. " with " .. ammo .. " ammo", thePlayer ) -- output a message to the player | |||
end | |||
addEventHandler ( "onPickupHit", root, onPickupHitFunction ) -- add an event handler for onPickupHit | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{ | {{Pickup functions}} | ||
Latest revision as of 08:09, 4 November 2020
This function retrieves the amount of ammo in a weapon pickup.
Syntax
int getPickupAmmo ( pickup thePickup )
Required Arguments
- thePickup: The pickup in which you wish to retrieve the ammo of
Returns
Returns an integer of the amount of ammo in the pickup, false if the pickup element is invalid, 0 if it's no weapon pickup.
Example
This example outputs a message with the picked up weapon and ammo to the player.
Click to collapse [-]
Serverfunction onPickupHitFunction ( thePlayer ) if getPickupType ( source ) ~= 2 then return end -- if the pickup is no weapon, stop local ammo = getPickupAmmo ( source ) -- get the amount of ammo local weapon = getPickupWeapon ( source ) -- get the weapon of the pickup outputChatBox ( "You just picked up a " .. getWeaponNameFromID(weapon) .. " with " .. ammo .. " ammo", thePlayer ) -- output a message to the player end addEventHandler ( "onPickupHit", root, onPickupHitFunction ) -- add an event handler for onPickupHit
See Also