OnPickupHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added dimension function param)
No edit summary
 
(6 intermediate revisions by 4 users not shown)
Line 5: Line 5:
==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
player thePlayer, bool matchingDimension
player thePlayer
</syntaxhighlight>  
</syntaxhighlight>  


*'''thePlayer''': a player [[element]] referring to the player who moved over the pickup.
*'''thePlayer''': a [[player]] element referring to the player who moved over the [[pickup]].
*'''matchingDimension''': Whether the player and the pickup he hit are in the same dimension


==Source==
==Source==
Line 20: Line 19:
This example creates a pickup and outputs a message to the chat box when a 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">
local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts
local thePickup = createPickup( 10, 10, 10, 2, 31, 3000, 50 ) -- Create a M4 weapon pickup when the script starts


function pickedUpWeaponCheck ( player )
function pickedUpWeaponCheck( player )
  outputChatBox ( "You have picked up a M4.", player ) --Display this message in the chat box
    outputChatBox( "You have picked up a M4.", player ) -- Output a message to the chatbox
end
end
addEventHandler ( "onPickupHit", aPickup, pickedUpWeaponCheck )
addEventHandler( "onPickupHit", thePickup, pickedUpWeaponCheck )
</syntaxhighlight>
</syntaxhighlight>


{{See also/Server event|Pickup events}}
{{See also/Server event|Pickup events}}

Latest revision as of 02:57, 27 September 2018

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 does not receive its bonus.

Example

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

local thePickup = createPickup( 10, 10, 10, 2, 31, 3000, 50 ) -- Create a M4 weapon pickup when the script starts

function pickedUpWeaponCheck( player )
    outputChatBox( "You have picked up a M4.", player ) -- Output a message to the chatbox
end
addEventHandler( "onPickupHit", thePickup, pickedUpWeaponCheck )

See Also

Pickup events


Event functions