Difference between revisions of "OnResourcePreStart"

From Multi Theft Auto: Wiki
Jump to: navigation, search
(Mention that OnResourcePreStart source is root element, not resource root element...)
Line 3: Line 3:
 
Analogous to [[onResourceStart]], but triggered before script files are initialised.
 
Analogous to [[onResourceStart]], but triggered before script files are initialised.
 
{{Note|This event isn't triggered within the resource starting.}}
 
{{Note|This event isn't triggered within the resource starting.}}
 
 
'''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 15: Line 12:
  
 
==Source==
 
==Source==
The [[event system#Event source|source]] of this event is the root [[element]] of the resource.
+
The [[event system#Event source|source]] of this event is the root [[element]].
  
 
==Cancel effect==
 
==Cancel effect==

Revision as of 20:00, 21 March 2018

Analogous to onResourceStart, but triggered before script files are initialised.

[[{{{image}}}|link=]] Note: This event isn't triggered within the resource starting.

Parameters

resource startingResource
  • startingResource: The resource that is starting

Source

The source of this event is the root element.

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