OnResourceStart: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 3: Line 3:
This event is triggered when a resource is loaded.
This event is triggered when a resource is loaded.


'''Important:''' It is important to note that this event is 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 name of the resource passed to this event matches the name returned by [[getThisResource]] before doing anything.
'''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]]()).


==Syntax==  
==Syntax==  

Revision as of 12:56, 5 December 2007

This event is triggered when a resource is loaded.

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()).

Syntax

void onResourceStart ( resource startedResource )

Parameters

  • startedResource: The resource that was started

Example

This code will output the name of any resource that is started.

function displayLoadedRes ( res )
	outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", getRootElement(), 255, 255, 255 )
end
addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes )

See Also