GetPickupAmount: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | |||
This function retreives the amount of health or armour given from a pickup. | This function retreives the amount of health or armour given from a pickup. | ||
| Line 15: | Line 16: | ||
==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 ) --when someone hits a pickup | ||
| Line 24: | Line 26: | ||
addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) --add an event handler for onPickupHit | addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) --add an event handler for onPickupHit | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Pickup functions}} | {{Pickup functions}} | ||
Revision as of 22:16, 4 August 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, 0 if it's no health or amor pickup.
Example
This example outputs the amount of health a player picked up.
Click to collapse [-]
Serverfunction 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
- createPickup
- getPickupAmmo
- getPickupAmount
- getPickupRespawnInterval
- getPickupType
- getPickupWeapon
- isPickupSpawned
- setPickupRespawnInterval
- setPickupType
- usePickup