OnResourceStart: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 5: | Line 5: | ||
'''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]]()). | '''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== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
void onResourceStart ( resource startedResource ) | void onResourceStart ( resource startedResource ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''startedResource''': The resource that was started | *'''startedResource''': The resource that was started | ||
==Source== | |||
The [[event system#Event source|source]] of this event is the root [[element]] in the resource that started. | |||
==Cancel effect== | |||
If this event is [[Event system#Canceling|canceled]], the resource starting is aborted and is gets unloaded again. | |||
==Example== | ==Example== | ||
Revision as of 05:50, 30 December 2007
This event is triggered when a resource is loaded.
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
void onResourceStart ( 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 gets unloaded again.
Example
This 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
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled