OnPickupSpawn: Difference between revisions
Jump to navigation
Jump to search
JonChappell (talk | contribs) No edit summary |
No edit summary |
||
| (6 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
[[ | __NOTOC__ | ||
{{Server event}} | |||
This event is triggered when a [[pickup]] is spawned or respawned. | |||
==Parameters== | |||
No parameters. | |||
== | ==Source== | ||
The [[event system#Event source|source]] of this event is the [[pickup]] that just spawned or respawned. | |||
==Example== | ==Example== | ||
This example | This example gets the area and city name when a pickup spawns and outputs it to all the players. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function outputSpawn( ) | ||
local area = getElementZoneName( source ) -- Get the area name where the pickup spawned | |||
-- | local city = getElementZoneName( source, true ) -- Get the city name where the pickup spawned | ||
outputChatBox( "A pickup has spawned in " .. area .. " ( " .. city .. " )", root, 255, 0, 0 ) -- Output a message to the chatbox | |||
end | |||
addEventHandler( "onPickupSpawn", root, outputSpawn ) -- Trigger the function when a pickup spawns | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Pickup events}} | |||
Latest revision as of 02:58, 27 September 2018
This event is triggered when a pickup is spawned or respawned.
Parameters
No parameters.
Source
The source of this event is the pickup that just spawned or respawned.
Example
This example gets the area and city name when a pickup spawns and outputs it to all the players.
function outputSpawn( )
local area = getElementZoneName( source ) -- Get the area name where the pickup spawned
local city = getElementZoneName( source, true ) -- Get the city name where the pickup spawned
outputChatBox( "A pickup has spawned in " .. area .. " ( " .. city .. " )", root, 255, 0, 0 ) -- Output a message to the chatbox
end
addEventHandler( "onPickupSpawn", root, outputSpawn ) -- Trigger the function when a pickup spawns
See Also
Pickup events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled