OnResourcePreStart: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Improve example.)
 
(8 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Server event}}
{{Server event}}
__NOTOC__
__NOTOC__
{{Needs_Checking|first parameter isn't the same resource/memory adress like getThisResource()}}  
Analogous to [[onResourceStart]], but triggered before script files are initialised.
This event is triggered before a resource is loaded.
{{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, 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==
==Parameters==
Line 11: Line 9:
</syntaxhighlight>  
</syntaxhighlight>  


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


==Source==
==Source==
Line 17: Line 15:


==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.
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 starting", 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"