GetPickupAmmo: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
==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 an integer of the amount of ammo in the pickup. | Returns an ''integer'' of the amount of ammo in the pickup, ''false'' if the pickup element is invalid. | ||
==Example== | ==Example== | ||
This example | This example outputs a message with the picked up weapon and ammo to the player. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onPickupHitFunction ( player ) --when a pickup is hit | |||
function | if (getPickupType(source) ~= 2) then return end | ||
local ammo = getPickupAmmo ( source ) | |||
local weapon = getPickupWeapon ( source ) -- define weapon as the weapon of the pickup | |||
outputChatBox("You just picked up "..getWeaponNameFromID(weapon).." with "..ammo.." ammo",player) -- output a message to the player | |||
end | end | ||
addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) -- add an event for onPickupHit | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Pickup functions}} | {{Pickup functions}} | ||
Revision as of 14:09, 28 July 2007
This function retreives 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.
Example
This example outputs a message with the picked up weapon and ammo to the player.
function onPickupHitFunction ( player ) --when a pickup is hit
if (getPickupType(source) ~= 2) then return end
local ammo = getPickupAmmo ( source )
local weapon = getPickupWeapon ( source ) -- define weapon as the weapon of the pickup
outputChatBox("You just picked up "..getWeaponNameFromID(weapon).." with "..ammo.." ammo",player) -- output a message to the player
end
addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) -- add an event for onPickupHit
See Also