GetThisResource - Revision history

Tracer: Added comments to example usage

2023-03-14T19:40:09Z

Added comments to example usage

← Older revision		Revision as of 19:40, 14 March 2023
Line 22:		Line 22:
	local resourceName = getResourceName(thisResource)		local resourceName = getResourceName(thisResource)
	iprint("You are in the " .. resourceName .. " resource!")		iprint("You are in the " .. resourceName .. " resource!")
	iprint(thisResource == resource)		iprint(thisResource == resource) -- true
	iprint(resRoot == resourceRoot)		iprint(resRoot == resourceRoot) -- true
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>

Tracer: Changed example; it didnt match the description of the usage

2023-03-14T19:39:36Z

Changed example; it didnt match the description of the usage

← Older revision		Revision as of 19:39, 14 March 2023
Line 16:		Line 16:
	This example retrieves the current resource's root element and attaches it to an onResourceStart event handler. This causes the event handler to get called only when the ''current'' resource is started rather than when ''any'' resource is started, thereby reducing unnecessary overhead.		This example retrieves the current resource's root element and attaches it to an onResourceStart event handler. This causes the event handler to get called only when the ''current'' resource is started rather than when ''any'' resource is started, thereby reducing unnecessary overhead.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- get the root element of this resource~~ (~~the resource that the script is a part of~~)		local thisResource = getThisResource()
	~~resourceRoot~~ = getResourceRootElement(~~getThisResource())~~		local resRoot = getResourceRootElement(thisResource)
	~~--getThisResource(~~) ~~is the same thing as MTA's secret global variable~~
	~~--"resource" as explained in the note above.~~

	~~-- create a~~ function ~~to handle the command~~		addEventHandler("onResourceStart", resRoot, function()
	~~function onResourceCommand()~~
	~~local thisResource = getThisResource~~()
	local resourceName = getResourceName(thisResource)		local resourceName = getResourceName(thisResource)
	~~outputChatBox~~("You are in the " .. resourceName .. " resource!")		iprint("You are in the " .. resourceName .. " resource!")
	~~end~~		iprint(thisResource == resource)
			iprint(resRoot == resourceRoot)
	~~-- add the command handler~~		end)
	~~addCommandHandler("what", onResourceCommand~~)
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}

Pawelo: Add missing OOP info

2021-08-10T15:29:23Z

Add missing OOP info

← Older revision		Revision as of 15:29, 10 August 2021
Line 8:		Line 8:
	resource getThisResource ( )		resource getThisResource ( )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is a static function underneath the Resource class.\|[[Resource]].getThis}}

	===Returns===		===Returns===

Danilo at 04:41, 11 August 2019

2019-08-11T04:41:46Z

← Older revision		Revision as of 04:41, 11 August 2019
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function retrieves the resource from which the function call was made.		This function retrieves the resource from which the function call was made.
	{{Note\| ~~every~~ resource has a predefined global variable called ''resource'' that contains the resource pointer for that resource, in other words, the value that this function returns.}}		{{Note\| Every resource has a predefined global variable called ''resource'' that contains the resource pointer for that resource, in other words, the value that this function returns.}}

	==Syntax==		==Syntax==

Danilo at 04:41, 11 August 2019

2019-08-11T04:41:37Z

← Older revision		Revision as of 04:41, 11 August 2019
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function retrieves the resource from which the function call was made.		This function retrieves the resource from which the function call was made.
			{{Note\| every resource has a predefined global variable called ''resource'' that contains the resource pointer for that resource, in other words, the value that this function returns.}}
	Note: every resource has a predefined global variable called ''resource'' that contains the resource pointer for that resource, in other words, the value that this function returns.

	==Syntax==		==Syntax==

Adolfram: changed "event" to "command"

2016-12-22T21:26:48Z

changed "event" to "command"

← Older revision		Revision as of 21:26, 22 December 2016
Line 28:		Line 28:
	end		end

	-- add the ~~event~~ handler		-- add the command handler
	addCommandHandler("what", onResourceCommand)		addCommandHandler("what", onResourceCommand)
	</syntaxhighlight>		</syntaxhighlight>

Arran Fortuna: Fixed another failure

2011-07-30T15:26:01Z

Fixed another failure

← Older revision		Revision as of 15:26, 30 July 2011
Line 24:		Line 24:
	function onResourceCommand()		function onResourceCommand()
	local thisResource = getThisResource()		local thisResource = getThisResource()
	local resourceName = getResourceName(~~theResource~~)		local resourceName = getResourceName(thisResource)
	outputChatBox("You are in the " .. resourceName .. " resource!")		outputChatBox("You are in the " .. resourceName .. " resource!")
	end		end

Arran Fortuna: Fixed failure

2011-07-30T15:25:20Z

Fixed failure

← Older revision		Revision as of 15:25, 30 July 2011
Line 29:		Line 29:

	-- add the event handler		-- add the event handler
	addCommandHandler("what"~~, resourceRoot~~, onResourceCommand)		addCommandHandler("what", onResourceCommand)
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}

Qaisjp at 06:22, 30 July 2011

2011-07-30T06:22:39Z

← Older revision		Revision as of 06:22, 30 July 2011
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	~~{{Needs_Checking\|Example lacks this function? (Fixed by Qais)}}~~
	__NOTOC__		__NOTOC__
	This function retrieves the resource from which the function call was made.		This function retrieves the resource from which the function call was made.

Qaisjp at 06:22, 30 July 2011

2011-07-30T06:22:22Z

← Older revision		Revision as of 06:22, 30 July 2011
Line 23:		Line 23:

	-- create a function to handle the command		-- create a function to handle the command
	function onResourceCommand(~~theResource~~)		function onResourceCommand()
	local thisResource = getThisResource()		local thisResource = getThisResource()
	local resourceName = getResourceName(theResource)		local resourceName = getResourceName(theResource)