GetPickupAmmo: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
No edit summary  | 
				mNo edit summary  | 
				||
| Line 16: | Line 16: | ||
This example outputs a message with the picked up weapon and ammo to the player.  | This example outputs a message with the picked up weapon and ammo to the player.  | ||
<syntaxhighlight lang="lua">  | <syntaxhighlight lang="lua">  | ||
function onPickupHitFunction (   | function onPickupHitFunction ( thePlayer ) --when a pickup is hit  | ||
	if (getPickupType(source) ~= 2) then return end -- if the pickup is no weapon, stop  | 	if (getPickupType(source) ~= 2) then return end -- if the pickup is no weapon, stop  | ||
	local ammo = getPickupAmmo ( source ) -- get the amount of ammo  | 	local ammo = getPickupAmmo ( source ) -- get the amount of ammo  | ||
	local weapon = getPickupWeapon ( source ) -- define weapon as the weapon of the pickup  | 	local weapon = getPickupWeapon ( source ) -- define weapon as the weapon of the pickup  | ||
	outputChatBox("You just picked up "..getWeaponNameFromID(weapon).." with "..ammo.." ammo",  | 	outputChatBox("You just picked up "..getWeaponNameFromID(weapon).." with "..ammo.." ammo",thePlayer) -- output a message to the player  | ||
end  | end  | ||
addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) -- add an event for onPickupHit  | addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) -- add an event for onPickupHit  | ||
Revision as of 15:07, 29 July 2007
This function retreives 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
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.
Example
This example outputs a message with the picked up weapon and ammo to the player.
function onPickupHitFunction ( thePlayer ) --when a pickup is hit
	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 ) -- define weapon as the weapon of the pickup
	outputChatBox("You just picked up "..getWeaponNameFromID(weapon).." with "..ammo.." ammo",thePlayer) -- output a message to the player
end
addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) -- add an event for onPickupHit
See Also