OnPickupLeave: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server event}} This event is triggered when a player leaves a pickup. ==Parameters== <syntaxhighlight lang="lua"> player thePlayer </syntaxhighlight> *...")
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server event}}  
{{Server event}}  
{{New feature/item|3.0156|1.5.5|11783|
This event is triggered when a [[player]] leaves a [[pickup]].
This event is triggered when a [[player]] leaves a [[pickup]].
}}


==Parameters==
==Parameters==
Line 16: Line 18:
This example creates a pickup and outputs a message to the chat box when a player leaves it.
This example creates a pickup and outputs a message to the chat box when a player leaves 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 leftWeaponPickup( player )
function leftWeaponPickup( player )
  outputChatBox ( "You have left the M4 weapon pickup.", player ) --Display this message in the chat box
    outputChatBox( "You have left the M4 weapon pickup.", player ) -- Output a message to the chatbox
end
end
addEventHandler ( "onPickupLeave", aPickup, pickedUpWeaponCheck )
addEventHandler( "onPickupLeave", thePickup, leftWeaponPickup)
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 11:35, 27 May 2022

This event is triggered when a player leaves a pickup.

Parameters

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

Source

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

Example

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

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

function leftWeaponPickup( player )
    outputChatBox( "You have left the M4 weapon pickup.", player ) -- Output a message to the chatbox
end
addEventHandler( "onPickupLeave", thePickup, leftWeaponPickup)

See Also

Pickup events


Event functions