OnPickupHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Added new template, improved example a bit.)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This event is triggered when a player hits a pickup. A pickup is health, armor, or a weapon.
{{Server event}}


==Syntax==  
This event is triggered when a [[player]] hits a [[pickup]].
 
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onPickupHit ( player player )
player thePlayer
</syntaxhighlight>  
</syntaxhighlight>  


==Parameters==
*'''thePlayer''': a player [[element]] referring to the player who moved over the pickup.
*The '''source''' of this event refers to the pickup which was hit by the player.
 
*'''thePlayer''': a [[player]] element referring to the player who moved over the pickup.
==Source==
The [[event system#Event source|source]] of this event is the [[pickup]] that was hit by the player.
 
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the pickup does not disappear and the player doesn't receive its bonus.


==Example==  
==Example==  
This example creates a pickup and outputs a message to the chat box when the player walks over it
This example creates a pickup and outputs a message to the chat box when a player walks over it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts
local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts


function pickedUpWeaponCheck ( player, matchingDimension )
function pickedUpWeaponCheck ( player )
if source == myPickup then --If the pickup I grabbed was myPickup
  outputChatBox ( "You have picked up a M4.", player ) --Display this message in the chat box
    outputChatBox ( "You have picked up your pickup weapon" ) --Display this message in the chat box
end
end
end
addEventHandler ( "onPickupHit", getRootElement(), pickedUpWeaponCheck )
addEventHandler ( "onPickupHit", aPickup, pickedUpWeaponCheck )
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{Event_functions}}

Revision as of 01:02, 30 September 2007

This event is triggered when a player hits a pickup.

Parameters

player thePlayer
  • thePlayer: a player element referring to the player who moved over the pickup.

Source

The source of this event is the pickup that was hit by the player.

Cancel effect

If this event is canceled, the pickup does not disappear and the player doesn't receive its bonus.

Example

This example creates a pickup and outputs a message to the chat box when a player walks over it. 

local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts

function pickedUpWeaponCheck ( player )
   outputChatBox ( "You have picked up a M4.", player ) --Display this message in the chat box
end
addEventHandler ( "onPickupHit", aPickup, pickedUpWeaponCheck )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPickupHit?oldid=12337"