OnResourceStart: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 23: Line 23:
function displayLoadedRes ( res )
function displayLoadedRes ( res )
outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", getRootElement(), 255, 255, 255 )
outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", getRootElement(), 255, 255, 255 )
        outputConsole ( "Resource " ..getResourceName(res).. " Succesfuly started and is the ready to be used", getRootElement(), 255, 255, 255 )
end
end
addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes )
addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes )

Revision as of 10:20, 25 March 2012

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

Parameters

resource startedResource
  • startedResource: The resource that was started

Source

The source of this event is the root element in the resource that started.

Cancel effect

If this event is canceled, the resource starting is aborted and is gets unloaded again.

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 )
        outputConsole ( "Resource " ..getResourceName(res).. " Succesfuly started and is the ready to be used", getRootElement(), 255, 255, 255 )
end
addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes )

See Also

Resource events


Event functions