Predefined variables list - Revision history

FileEX: Beta header

2024-07-16T09:39:32Z

Beta header

← Older revision		Revision as of 09:39, 16 July 2024
Line 16:		Line 16:
	== MTA Predefined variables ==		== MTA Predefined variables ==
	=== Global ===		=== Global ===
			{{New feature/item\|3.161\|1.6.0\|22960\|resourceName -- returns the name of the resource the snippet was executed in}}
	<section name="Shared" class="both" show="true">		<section name="Shared" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

2024-07-15T20:54:09Z

Add resourceName

← Older revision		Revision as of 20:54, 15 July 2024
Line 21:		Line 21:
	resource -- returns a resource element of the resource the snippet was executed in		resource -- returns a resource element of the resource the snippet was executed in
	resourceRoot -- returns a resource root element of the resource the snippet was executed in		resourceRoot -- returns a resource root element of the resource the snippet was executed in
			resourceName -- returns the name of the resource the snippet was executed in
	root -- returns the root element of the server		root -- returns the root element of the server
	</syntaxhighlight>		</syntaxhighlight>

2024-07-05T13:02:14Z

Undo revision 79723 by Nico834 (talk)

← Older revision		Revision as of 13:02, 5 July 2024
Line 21:		Line 21:
	resource -- returns a resource element of the resource the snippet was executed in		resource -- returns a resource element of the resource the snippet was executed in
	resourceRoot -- returns a resource root element of the resource the snippet was executed in		resourceRoot -- returns a resource root element of the resource the snippet was executed in
	~~resourceName -- returns the name of the resource the snippet was executed in~~
	root -- returns the root element of the server		root -- returns the root element of the server
	</syntaxhighlight>		</syntaxhighlight>

2024-06-30T10:57:08Z

Add resourceName

← Older revision		Revision as of 10:57, 30 June 2024
Line 21:		Line 21:
	resource -- returns a resource element of the resource the snippet was executed in		resource -- returns a resource element of the resource the snippet was executed in
	resourceRoot -- returns a resource root element of the resource the snippet was executed in		resourceRoot -- returns a resource root element of the resource the snippet was executed in
			resourceName -- returns the name of the resource the snippet was executed in
	root -- returns the root element of the server		root -- returns the root element of the server
	</syntaxhighlight>		</syntaxhighlight>

2023-11-11T15:34:45Z

move sourceResource and sourceResourceRoot variables to shared section

← Older revision		Revision as of 15:34, 11 November 2023
Line 41:		Line 41:
	this -- Element, which was attached function-handler.		this -- Element, which was attached function-handler.
	eventName -- the name of the event ("onResourceStart", "onPlayerWasted" etc.)		eventName -- the name of the event ("onResourceStart", "onPlayerWasted" etc.)
			sourceResource -- the resource that called the event
			sourceResourceRoot -- the root of the resource that called the event
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
Line 47:		Line 49:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	client -- the client that called the event		client -- the client that called the event
	~~sourceResource -- the resource that called the event~~
	~~sourceResourceRoot -- the root of the resource that called the event~~
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

2021-12-13T21:45:11Z

← Older revision		Revision as of 21:45, 13 December 2021
Line 58:		Line 58:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function init(~~resource~~)		function init()
	local player = source -- source is a pre-defined variable for this event, containing the player element		local player = source -- source is a pre-defined variable for this event, containing the player element

2021-12-13T21:44:12Z

Add event handlers variable info

← Older revision		Revision as of 21:44, 13 December 2021
Line 52:		Line 52:
	</section>		</section>


			Please note, the above pre-defined variables may only be accessible in the relevant scope (i.e, an event handler callback function). Further functions defined within that scope may not have access to these pre-defined variables at the time of their execution.

			For this reason, you should always explicitly redefine pre-defined variables as local variables, to ensure they are always available to new functions declared within that scope - for example:

			<syntaxhighlight lang="lua">
			function init(resource)
			local player = source -- source is a pre-defined variable for this event, containing the player element

			local func = function()
			print(source) -- prints 'nil', source isn't available anymore
			print(player) -- prints player element
			end

			setTimer(func, 1000, 1) -- run above function after 1 second
			end
			addEventHandler("onPlayerResourceStart", root, init)
			</syntaxhighlight>

	=== Timer Callbacks ===		=== Timer Callbacks ===

2021-01-20T18:34:09Z

Undo revision 68343 by Luxy.c (talk)

← Older revision		Revision as of 18:34, 20 January 2021
Line 9:		Line 9:
	_VERSION -- returns a string of the version of lua in format "Lua 5.1"		_VERSION -- returns a string of the version of lua in format "Lua 5.1"
	self -- used in methods		self -- used in methods
			arg -- used in functions which use '...' as an argument (https://www.lua.org/pil/5.2.html)
	</syntaxhighlight>		</syntaxhighlight>

2021-01-20T12:11:52Z

removed `arg` (Not supported by Lua 5.1)

← Older revision		Revision as of 12:11, 20 January 2021
Line 9:		Line 9:
	_VERSION -- returns a string of the version of lua in format "Lua 5.1"		_VERSION -- returns a string of the version of lua in format "Lua 5.1"
	self -- used in methods		self -- used in methods
	~~arg -- used in functions which use '...' as an argument (https://www.lua.org/pil/5.2.html)~~
	</syntaxhighlight>		</syntaxhighlight>

2020-02-24T12:56:40Z

← Older revision		Revision as of 12:56, 24 February 2020
Line 41:		Line 41:
	this -- Element, which was attached function-handler.		this -- Element, which was attached function-handler.
	eventName -- the name of the event ("onResourceStart", "onPlayerWasted" etc.)		eventName -- the name of the event ("onResourceStart", "onPlayerWasted" etc.)
	~~sourceResourceRoot -- the root of the resource that called the event~~
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
Line 48:		Line 47:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	client -- the client that called the event		client -- the client that called the event
	sourceResource -- the resource that called the event		sourceResource -- the resource that called the event
			sourceResourceRoot -- the root of the resource that called the event
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>