GetResourceRootElement - Revision history

IManGaaX at 09:33, 26 January 2026

2026-01-26T09:33:28Z

← Older revision		Revision as of 09:33, 26 January 2026
Line 1:		Line 1:
			<!-- i believe this function is unnecessary because there is a constant variable called resourceRoot / iManGaaX / @MTA_DEV -->

	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__

Tracer at 18:38, 17 December 2023

2023-12-17T18:38:31Z

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{Shared function}}
+This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).
-{{Disabled}}
-{{New feature/item|3.0160|1.6|7485|
+Note: every resource has a [[Predefined_variables_list|predefined global variable]] called ''resourceRoot'' whose value is the root element of that resource.
 }}

AirNewSCR at 04:52, 17 December 2023

2023-12-17T04:52:25Z

← Older revision		Revision as of 04:52, 17 December 2023
Line 3:		Line 3:
	{{Disabled}}		{{Disabled}}
	{{New feature/item\|3.0160\|1.6\|7485\|		{{New feature/item\|3.0160\|1.6\|7485\|
	~~Sets the track of a train~~
	}}		}}

AirNewSCR: Replaced content with "NOTOC {{Shared function}} {{Disabled}} {{New feature/item|3.0160|1.6|7485| Sets the track of a train }}"

2023-12-17T04:52:17Z

Replaced content with "__NOTOC__ {{Shared function}} {{Disabled}} {{New feature/item|3.0160|1.6|7485| Sets the track of a train }}"

@@ Line 1: / Line 1: @@
 __NOTOC__
-This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).
+{{Shared function}}
+{{Disabled}}
-Note: every resource has a [[Predefined_variables_list|predefined global variable]] called ''resourceRoot'' whose value is the root element of that resource.
+{{New feature/item|3.0160|1.6|7485|
+Sets the track of a train
-==Syntax==
+}}

Strix: add oop syntax

2015-01-01T16:32:29Z

add oop syntax

← Older revision		Revision as of 16:32, 1 January 2015
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element getResourceRootElement ( [resource theResource=getThisResource()] )		element getResourceRootElement ( [resource theResource=getThisResource()] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[resource]]:getRootElement\|rootElement}}
	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}

Jaysds1: Fixed link issue

2013-04-07T07:28:13Z

Fixed link issue

← Older revision		Revision as of 07:28, 7 April 2013
Line 3:		Line 3:
	This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).		This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).

	Note: every resource has a [[~~Global variables~~\|predefined global variable]] called ''resourceRoot'' whose value is the root element of that resource.		Note: every resource has a [[Predefined_variables_list\|predefined global variable]] called ''resourceRoot'' whose value is the root element of that resource.

	==Syntax==		==Syntax==

Ccw at 17:55, 18 June 2011

2011-06-18T17:55:41Z

← Older revision		Revision as of 17:55, 18 June 2011
Line 3:		Line 3:
	This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).		This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).

	Note: every resource has a predefined global variable called ''resourceRoot'' whose value is the root element of that resource.		Note: every resource has a [[Global variables\|predefined global variable]] called ''resourceRoot'' whose value is the root element of that resource.

	==Syntax==		==Syntax==

Sebassje at 11:54, 22 May 2009

2009-05-22T11:54:18Z

← Older revision		Revision as of 11:54, 22 May 2009
Line 18:		Line 18:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	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)		-- get the root element of this resource (the resource that the script is a part of)
	resourceRoot = getResourceRootElement(~~getThisResource()~~)		resourceRoot = getResourceRootElement()

	-- create a function to handle the onResourceStart event		-- create a function to handle the onResourceStart event
Line 32:		Line 33:
	addEventHandler("onResourceStart", resourceRoot, onCurrentResourceStart)		addEventHandler("onResourceStart", resourceRoot, onCurrentResourceStart)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

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

Mekorea at 13:17, 18 February 2009

2009-02-18T13:17:44Z

← Older revision		Revision as of 13:17, 18 February 2009
Line 12:		Line 12:
	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
	*'''theResource:''' the resource whose root element we are getting. If not specified, assumes the current resource (the resource returned from [[getThisResource]].		*'''theResource:''' the resource whose root element we are getting. If not specified, assumes the current resource. (the resource returned from [[getThisResource]])

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

Arc at 22:35, 24 January 2008

2008-01-24T22:35:16Z

← Older revision		Revision as of 22:35, 24 January 2008
Line 3:		Line 3:
	This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).		This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).

	Note: every resource has a predefined global variable called "resourceRoot" whose value is the root element of that resource.		Note: every resource has a predefined global variable called ''resourceRoot'' whose value is the root element of that resource.

	==Syntax==		==Syntax==