OnResourceStart: Difference between revisions
Jump to navigation
Jump to search
m (See Also for server events) |
No edit summary |
||
| (11 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{Server event}} | {{Server event}} | ||
__NOTOC__ | __NOTOC__ | ||
This event is triggered when a resource is | This event is triggered when a resource is started. | ||
'''Important:''' If you attach this event to the root element it will called when ''any'' resource starts, not just the resource your script is running inside. As such, most of the time you will want to check that the resource passed to this event matches your resource (compare with the value returned by [[getThisResource]] | '''Important:''' If you attach this event to the root element it will called when ''any'' resource starts, not just the resource your script is running inside. As such, most of the time you will want to check that the resource passed to this event matches your resource (compare with the value returned by [[getThisResource]] before doing anything. Alternatively you can attach the event to resourceRoot. | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
resource startedResource | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''startedResource''': | *'''startedResource''': the [[resource]] that was started. | ||
==Source== | ==Source== | ||
| Line 16: | Line 16: | ||
==Cancel effect== | ==Cancel effect== | ||
If this event is [[Event system#Canceling|canceled]], the resource starting is aborted and is | If this event is [[Event system#Canceling|canceled]], the resource starting is aborted and is stopped again. | ||
==Example== | ==Example== | ||
<section name="Example 1" class="server" show="true"> | |||
This code will output the name of any resource that is started. | This code will output the name of any resource that is started. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function displayLoadedRes ( res ) | function displayLoadedRes ( res ) | ||
outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", | outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", root, 255, 255, 255 ) | ||
end | end | ||
addEventHandler ( "onResourceStart", | addEventHandler ( "onResourceStart", root, displayLoadedRes ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
{{See also/Server event|Resource events}} | {{See also/Server event|Resource events}} | ||
Latest revision as of 14:02, 2 June 2021
This event is triggered when a resource is started.
Important: If you attach this event to the root element it will called when any resource starts, not just the resource your script is running inside. As such, most of the time you will want to check that the resource passed to this event matches your resource (compare with the value returned by getThisResource before doing anything. Alternatively you can attach the event to resourceRoot.
Parameters
resource startedResource
- startedResource: the resource that was started.
Source
The source of this event is the root element in the resource that started.
Cancel effect
If this event is canceled, the resource starting is aborted and is stopped again.
Example
Click to collapse [-]
Example 1This code will output the name of any resource that is started.
function displayLoadedRes ( res ) outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", root, 255, 255, 255 ) end addEventHandler ( "onResourceStart", root, displayLoadedRes )
See Also
Resource events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled