OnPlayerResourceStart

From Multi Theft Auto: Wiki
Revision as of 22:43, 15 October 2023 by Srslyyyy (talk | contribs) (→‎Example)
Jump to navigation Jump to search

This event is triggered when a resource has loaded client-side for a player.

Parameters

resource loadedResource
  • loadedResource: The resource that was loaded on the client.

Source

The source of this event is the player who loaded the resource.

Example

This example shows how you can trigger a custom event client-side defined in the same resource as soon as the player is ready (resource loaded on client): 

function onPlayerResourceStart(startedResource)
	local resourceName = getResourceName(startedResource)
	local playerName = getPlayerName(source)
	local matchingResource = (startedResource == resource) -- 'resource' is predefined variable, see: https://wiki.multitheftauto.com/wiki/Predefined_variables_list#MTA_Predefined_variables
	local chatMessage = (resourceName.." has started for "..playerName)

	outputChatBox(chatMessage) -- display message when any resource starts for player

	if (not matchingResource) then -- check if startedResource matches current, if it doesn't do not trigger custom event
		return false
	end

	triggerClientEvent(source, "onClientCustomEvent", resourceRoot) -- send a custom clientside event defined in this resource, for specific player (source) only
end
addEventHandler("onPlayerResourceStart", root, onPlayerResourceStart)

Requirements

This template will be deleted.

See Also

Resource events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerResourceStart?oldid=78239"