GetPickupAmount

This function retreives the amount of health or armour given from a pickup.

Syntax

int getPickupAmount ( pickup thePickup )        

Required Arguments

• thePickup: The pickup you wish to retrieve the amount from.

Returns

Returns an integer of the amount the pickup is set to, false if it's invalid.

Example

This example outputs the amount of health a player picked up.

function onPickupHitFunction ( player ) --when someone hits a pickup
    if getPickupType ( source ) == 0 then --check the type of pickup, if it is a health pickup then
        amount = getPickupAmount ( source )
        outputChatBox("You picked up "..amount.." health",player)
    end
end
addEventHandler ( "onPickupHit", root, onPickupHitFunction ) --add an event handler for onPickupHit

See Also

• createPickup
• getPickupAmmo
• getPickupAmount
• getPickupType
• setPickupType
• getPickupWeapon