OnResourcePreStart: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Zangomangu (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Server event}} | {{Server event}} | ||
__NOTOC__ | __NOTOC__ | ||
This event | Analogous to [[onResourceStart]], but triggered before script files are initialised. | ||
{{Note|This event isn't triggered within the resource starting.}} | |||
'''Important:''' If you attach this event to the root element it will called when ''any'' resource starts | |||
'''Important:''' If you attach this event to the [[root element]] it will be called when ''any'' [[resource]] starts - attach it to to the [[root element]] of the desired resource, eg. [[getResourceRootElement]]([[getResourceFromName]]("freeroam")). | |||
==Parameters== | ==Parameters== | ||
| Line 13: | Line 15: | ||
==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]] of the resource. | ||
==Cancel effect== | ==Cancel effect== | ||
If this event is cancelled, the resource won't begin starting. | |||
==Example== | ==Example== | ||
| Line 21: | Line 24: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function displayStartingRes ( res ) | function displayStartingRes ( res ) | ||
outputChatBox ( "Resource " .. getResourceName(res) .. " is | outputChatBox ( "Resource " .. getResourceName(res) .. " is going to start", getRootElement(), 255, 255, 255 ) | ||
end | end | ||
addEventHandler ( "onResourcePreStart", getRootElement(), displayStartingRes ) | addEventHandler ( "onResourcePreStart", getRootElement(), displayStartingRes ) | ||
Revision as of 14:49, 12 January 2014
Analogous to onResourceStart, but triggered before script files are initialised.
Important: If you attach this event to the root element it will be called when any resource starts - attach it to to the root element of the desired resource, eg. getResourceRootElement(getResourceFromName("freeroam")).
Parameters
resource startingResource
- startingResource: The resource that is starting
Source
The source of this event is the root element of the resource.
Cancel effect
If this event is cancelled, the resource won't begin starting.
Example
This code will output the name of any resource that is starting.
function displayStartingRes ( res ) outputChatBox ( "Resource " .. getResourceName(res) .. " is going to start", 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