OnResourcePreStart: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
No edit summary |
||
Line 1: | Line 1: | ||
{{Server event}} | {{Server event}} | ||
__NOTOC__ | __NOTOC__ | ||
{{Needs_Checking|first parameter isn't the same resource/memory adress like getThisResource()}} | |||
This event is triggered before a resource is loaded. | This event is triggered before a resource is loaded. | ||
Line 13: | Line 14: | ||
==Source== | ==Source== | ||
The [[event system#Event source|source]] of this event is the root [[element]] | The [[event system#Event source|source]] of this event is the root [[element]]. | ||
==Cancel effect== | ==Cancel effect== |
Revision as of 19:24, 9 January 2012
This article needs checking. | |
Reason(s): first parameter isn't the same resource/memory adress like getThisResource() |
This event is triggered before 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
resource startingResource
- startingResource: The resource that is starting
Source
The source of this event is the root element.
Cancel effect
Example
This code will output the name of any resource that is starting.
function displayStartingRes ( res ) outputChatBox ( "Resource " .. getResourceName(res) .. " is starting", getRootElement(), 255, 255, 255 ) end addEventHandler ( "onResourcePreStart", getRootElement(), displayStartingRes )
See Also
Resource events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled