Difference between revisions of "OnPickupLeave"

From Multi Theft Auto: Wiki
m
Line 18: 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, pickedUpWeaponCheck )
 
</syntaxhighlight>
 
</syntaxhighlight>
  
{{See also/Server event|Pickup events}}
+
==See Also==
 +
{{Pickup events}}

Revision as of 00:14, 2 July 2018

BETA: FROM VERSION 1.5.5 r11783 ONWARDS

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, pickedUpWeaponCheck )

See Also