GetPickupAmount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 16: Line 16:
This example outputs the amount of health a player picked up.
This example outputs the amount of health a player picked up.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onPickupHitFunction ( player ) --when someone hits a pickup
function onPickupHitFunction ( thePlayer ) --when someone hits a pickup
     if getPickupType ( source ) == 0 then --check the type of pickup, if it is a health pickup then
     if getPickupType ( source ) == 0 then --check the type of pickup, if it is a health pickup then
         amount = getPickupAmount ( source )
         amount = getPickupAmount ( source )
         outputChatBox("You picked up "..amount.." health",player)
         outputChatBox("You picked up "..amount.." health", thePlayer)
     end
     end
end
end

Revision as of 15:06, 29 July 2007

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 ( thePlayer ) --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", thePlayer)
    end
end
addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) --add an event handler for onPickupHit 

See Also