OnResourceStart: Difference between revisions
Jump to navigation
Jump to search
Zangomangu (talk | contribs) No edit summary |
|||
| Line 18: | Line 18: | ||
If this event is [[Event system#Canceling|canceled]], the resource starting is aborted and is stopped again. | If this event is [[Event system#Canceling|canceled]], the resource starting is aborted and is stopped again. | ||
= | |||
<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 ) | ||
| Line 26: | Line 30: | ||
addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes ) | addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
{{See also/Server event|Resource events}} | {{See also/Server event|Resource events}} | ||
Revision as of 20:13, 23 June 2017
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 getResourceRootElement(getThisResource()).
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.
Click to collapse [-]
Example 1This code will output the name of any resource that is started.
function displayLoadedRes ( res ) outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", getRootElement(), 255, 255, 255 ) end addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes )
See Also
Resource events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled