Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

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

• int: value

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.

Code Examples

shared

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

See Also

Pickup Functions

• createPickup
• getPickupAmmo
• getPickupAmount
• getPickupRespawnInterval
• getPickupType
• getPickupWeapon
• isPickupSpawned
• setPickupRespawnInterval
• setPickupType
• usePickup

Pickup Events

• onClientPickupHit
• onClientPickupLeave
• onPickupHit
• onPickupLeave
• onPickupSpawn
• onPickupUse

Reference

• Scripting Functions