OnResourceStart: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
void onResourceStart ( | void onResourceStart ( resource startedResource ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== | ==Parameters== | ||
*'''startedResource''': The resource that was started | |||
*''' | |||
==Example== | ==Example== | ||
This | This code will output the name of any resource that is started. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function displayLoadedRes ( res ) | |||
function | outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", getRootElement(), 255, 255, 255 ) | ||
outputChatBox ( " | |||
end | end | ||
addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Event_functions}} | {{Event_functions}} | ||
Revision as of 12:52, 5 December 2007
This event is triggered when a resource is loaded.
Important: It is important to note that this event is 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 name of the resource passed to this event matches the name returned by getThisResource before doing anything.
Syntax
void onResourceStart ( resource startedResource )
Parameters
- startedResource: The resource that was started
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