OnResourcePreStart: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Improve example.)
 
(4 intermediate revisions by 3 users not shown)
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 12: Line 9:
</syntaxhighlight>  
</syntaxhighlight>  


*'''startingResource''': The resource that is starting
*'''startingResource''': the [[resource]] that is starting.


==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==
Line 23: Line 20:
This code will output the name of any resource that is starting.
This code will output the name of any resource that is starting.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function displayStartingRes ( res )
function displayStartingRes(res)
outputChatBox ( "Resource " .. getResourceName(res) .. " is going to start", getRootElement(), 255, 255, 255 )
outputChatBox("Resource "..getResourceName(res).." is going to start.", root, 255, 255, 255)
end
end
addEventHandler ( "onResourcePreStart", getRootElement(), displayStartingRes )
addEventHandler("onResourcePreStart", root, displayStartingRes)
</syntaxhighlight>
</syntaxhighlight>


{{See also/Server event|Resource events}}
{{See also/Server event|Resource events}}

Latest revision as of 08:07, 16 September 2021

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.", root, 255, 255, 255)
end
addEventHandler("onResourcePreStart", root, displayStartingRes)

See Also

Resource events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnResourcePreStart?oldid=72071"