OnResourcePreStart: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Started with onResourcePreStart, format? (not in the source found))
 
(Improve example.)
 
(12 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Server event}}
{{Server event}}
__NOTOC__
__NOTOC__
This event is triggered before a resource is loaded.
Analogous to [[onResourceStart]], but triggered before script files are initialised.
{{Note|This event isn't triggered within the resource starting.}}


==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
resource startingResource
</syntaxhighlight>
</syntaxhighlight>  
 
*'''startingResource''': the [[resource]] that is starting.


==Source==
==Source==
The [[event system#Event source|source]] of this event is the root [[element]].


==Cancel effect==
==Cancel effect==
If this event is cancelled, the resource won't begin starting.


==Example==
==Example==
This code will output the name of any resource that is starting.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function displayStartingRes(res)
outputChatBox("Resource "..getResourceName(res).." is going to start.", root, 255, 255, 255)
end
addEventHandler("onResourcePreStart", root, displayStartingRes)
</syntaxhighlight>
</syntaxhighlight>


{{See also/Server event|Resource events}}
{{See also/Server event|Resource events}}
[[Category: Incomplete]]
[[Category: Needs Example]]

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