GetPickupAmount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This function retreives the amount of health or armour given from a pickup.
{{Server client function}}
This function retrieves the amount of health or armor given from a pickup.


==Syntax==  
==Syntax==  
Line 11: Line 12:


===Returns===
===Returns===
Returns an ''integer'' of the amount the pickup is set to, ''false'' if it's invalid.
Returns an ''integer'' of the amount the pickup is set to, ''false'' if it's invalid, 0 if it's no health or amor pickup.


==Example==  
==Example==  
This example outputs the amount of health a player picked up.
This example outputs the amount of health a player picked up.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onPickupHitFunction ( thePlayer ) --when someone hits a pickup
function onPickupHitFunction ( thePlayer )
     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", thePlayer)
         outputChatBox ( "You picked up " .. amount .. " health", thePlayer)
     end
     end
end
end
addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) --add an event handler for onPickupHit  
addEventHandler ( "onPickupHit", root, onPickupHitFunction )   -- add an event handler for onPickupHit  
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Pickup functions}}
{{Pickup functions}}

Latest revision as of 09:57, 15 December 2023

This function retrieves the amount of health or armor 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, 0 if it's no health or amor pickup.

Example

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

Click to collapse [-]
Server
function onPickupHitFunction ( thePlayer )
    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", root, onPickupHitFunction )   -- add an event handler for onPickupHit 

See Also