OnPlayerResourceStart - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:29:09Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:29, 7 November 2024
Line 31:		Line 31:
	addEventHandler("onPlayerResourceStart", root, onPlayerResourceStart)		addEventHandler("onPlayerResourceStart", root, onPlayerResourceStart)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|1.5.8-9.20957\|n/a\|}}~~

	{{See also/Server event\|Resource events}}		{{See also/Server event\|Resource events}}

Srslyyyy: /* Example */

2023-10-15T22:43:52Z

Example

← Older revision		Revision as of 22:43, 15 October 2023
Line 15:		Line 15:
	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):		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):
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler~~(~~"onPlayerResourceStart", root, function~~(~~loadedResource~~)		function onPlayerResourceStart(startedResource)
	~~outputChatBox~~(~~getResourceName~~(~~loadedResource~~) .. " started for " .. ~~getPlayerName(source)~~)		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)

	-- ~~Trigger a custom clientside event defined in this~~ resource		outputChatBox(chatMessage) -- display message when any resource starts for player
	if ~~loadedResource == resource~~ then
	~~triggerClientEvent(source, "onClientCustomEvent", resourceRoot)~~		if (not matchingResource) then -- check if startedResource matches current, if it doesn't do not trigger custom event
			return false
	end		end
	end)
			triggerClientEvent(source, "onClientCustomEvent", resourceRoot) -- send a custom clientside event defined in this resource, for specific player (source) only
			end
			addEventHandler("onPlayerResourceStart", root, onPlayerResourceStart)
	</syntaxhighlight>		</syntaxhighlight>

Tracer: Example has been changed to a slightly cleaner one

2022-01-06T14:36:11Z

Example has been changed to a slightly cleaner one

← Older revision		Revision as of 14:36, 6 January 2022
Line 19:		Line 19:

	-- Trigger a custom clientside event defined in this resource		-- Trigger a custom clientside event defined in this resource
	if ~~(getResourceRootElement(~~loadedResource) == ~~resourceRoot)~~ then		if loadedResource == resource then
	triggerClientEvent(source, "onClientCustomEvent", resourceRoot)		triggerClientEvent(source, "onClientCustomEvent", resourceRoot)
	end		end

Lvrent at 21:25, 23 September 2021

2021-09-23T21:25:43Z

← Older revision		Revision as of 21:25, 23 September 2021
Line 1:		Line 1:
	{{Server event}}		{{Server event}}
	{{Added feature/item~~\|3.0159~~\|1.5.8\|1.5.8\|20957\|This event is triggered when a [[resource]] has loaded client-side for a [[player]].}}		{{Added feature/item\|1.5.9\|1.5.8\|20957\|This event is triggered when a [[resource]] has loaded client-side for a [[player]].}}
	__NOTOC__		__NOTOC__
	==Parameters==		==Parameters==

LopSided: Update styling of code example, remove ugly spacing

2021-09-23T10:58:45Z

Update styling of code example, remove ugly spacing

← Older revision		Revision as of 10:58, 23 September 2021
Line 15:		Line 15:
	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):		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):
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler ("onPlayerResourceStart", root, function (loadedResource)		addEventHandler("onPlayerResourceStart", root, function(loadedResource)
	outputChatBox (getResourceName (loadedResource) .. " started for " .. getPlayerName (source))		outputChatBox(getResourceName(loadedResource) .. " started for " .. getPlayerName(source))

	-- Trigger a custom clientside event defined in this resource		-- Trigger a custom clientside event defined in this resource
	if getResourceRootElement (loadedResource) == resourceRoot then		if (getResourceRootElement(loadedResource) == resourceRoot) then
	triggerClientEvent (source, "onClientCustomEvent", resourceRoot)		triggerClientEvent(source, "onClientCustomEvent", resourceRoot)
	end		end
	end)		end)

Lvrent at 10:14, 21 September 2021

2021-09-21T10:14:07Z

← Older revision		Revision as of 10:14, 21 September 2021
Line 1:		Line 1:
	{{Server event}}		{{Server event}}
	{{Added feature/item\|3.0159\|1.5.9\|1.5.8\|20957\|This event is triggered when a [[resource]] has loaded client-side for a [[player]].}}		{{Added feature/item\|3.0159\|1.5.8\|1.5.8\|20957\|This event is triggered when a [[resource]] has loaded client-side for a [[player]].}}
	__NOTOC__		__NOTOC__
	==Parameters==		==Parameters==

Lvrent at 17:07, 20 September 2021

2021-09-20T17:07:28Z

← Older revision		Revision as of 17:07, 20 September 2021
Line 1:		Line 1:
	{{Server event}}		{{Server event}}
	{{Added feature/item\|3.0159\|1.5.8\|1.5.8\|20957\|This event is triggered when a [[resource]] has loaded ~~clientside~~ for a [[player]]}}		{{Added feature/item\|3.0159\|1.5.9\|1.5.8\|20957\|This event is triggered when a [[resource]] has loaded client-side for a [[player]].}}
	__NOTOC__		__NOTOC__
	==Parameters==		==Parameters==
Line 7:		Line 7:
	</syntaxhighlight>		</syntaxhighlight>

	*'''loadedResource''': The [[resource]] that was loaded on the client		*'''loadedResource''': The [[resource]] that was loaded on the client.

	==Source==		==Source==
Line 13:		Line 13:

	==Example==		==Example==
	This example shows how you can trigger a custom event ~~clientside~~ defined in the same resource as soon as the player is ready (resource loaded on client).		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):
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler("onPlayerResourceStart", root, function(loadedResource)		addEventHandler ("onPlayerResourceStart", root, function (loadedResource)
	outputChatBox(getResourceName(loadedResource) .. " started for " .. getPlayerName(source))		outputChatBox (getResourceName (loadedResource) .. " started for " .. getPlayerName (source))

	-- Trigger a custom clientside event defined in this resource		-- Trigger a custom clientside event defined in this resource
	if (getResourceRootElement(loadedResource) == resourceRoot) then		if getResourceRootElement (loadedResource) == resourceRoot then
	triggerClientEvent(source, "onClientCustomEvent", resourceRoot)		triggerClientEvent (source, "onClientCustomEvent", resourceRoot)
	end		end
	end)		end)

LopSided: typo

2021-09-20T15:25:51Z

typo

← Older revision		Revision as of 15:25, 20 September 2021
Line 1:		Line 1:
	{{Server event}}		{{Server event}}
	{{Added feature/item\|3.0159\|1.5.8\|1.5.8\|20957\|This event is triggered when a [[resource]] is loaded clientside for a [[player]]}}		{{Added feature/item\|3.0159\|1.5.8\|1.5.8\|20957\|This event is triggered when a [[resource]] has loaded clientside for a [[player]]}}
	__NOTOC__		__NOTOC__
	==Parameters==		==Parameters==

LopSided: /* Example */

2021-09-20T15:25:31Z

Example

← Older revision		Revision as of 15:25, 20 September 2021
Line 20:		Line 20:
	-- Trigger a custom clientside event defined in this resource		-- Trigger a custom clientside event defined in this resource
	if (getResourceRootElement(loadedResource) == resourceRoot) then		if (getResourceRootElement(loadedResource) == resourceRoot) then
	triggerClientEvent(source, "onClientCustomEvent", ~~source~~)		triggerClientEvent(source, "onClientCustomEvent", resourceRoot)
	end		end
	end)		end)

LopSided: Update version

2021-09-20T15:24:53Z

Update version

← Older revision		Revision as of 15:24, 20 September 2021
Line 1:		Line 1:
	{{Server event}}		{{Server event}}
	{{Added feature/item\|3.0159\|1.5.9\|1.5.8\|~~20809~~\|This event is triggered when a [[resource]] is loaded clientside for a [[player]]}}		{{Added feature/item\|3.0159\|1.5.8\|1.5.8\|20957\|This event is triggered when a [[resource]] is loaded clientside for a [[player]]}}
	__NOTOC__		__NOTOC__
	==Parameters==		==Parameters==