SetElementSyncer - Revision history

FileEX: /* See Also */

2024-09-06T22:32:14Z

Megadreams: Add persist parameter

2024-03-30T23:15:48Z

Add persist parameter

← Older revision		Revision as of 23:15, 30 March 2024
Line 5:		Line 5:
	Only [[vehicle]] and [[ped]] elements can have a syncer, other element types are not currently automatically synced by MTA.		Only [[vehicle]] and [[ped]] elements can have a syncer, other element types are not currently automatically synced by MTA.

	Please note that using this function to change an element's syncer will only last as long as the element is within syncable range of the player. This is within 140 units for vehicles and 100 units for peds. As soon as it becomes impossible for your chosen player to sync the element, another player (or no player) will be automatically selected, and your setting will be lost. With vehicles, the last occupant to leave a vehicle will be selected as the syncer and override any setting you may have made.		Please note that using this function to change an element's syncer will only last as long as the element is within syncable range of the player unless persist is set to true. This is within 140 units for vehicles and 100 units for peds. As soon as it becomes impossible for your chosen player to sync the element, another player (or no player) will be automatically selected, and your setting will be lost. With vehicles, the last occupant to leave a vehicle will be selected as the syncer and override any setting you may have made.

	Using this function to remove an element's syncer, means no player will be assigned to syncing the element. That will not be changed until setElementSyncer is called again.		Using this function to remove an element's syncer, means no player will be assigned to syncing the element. That will not be changed until setElementSyncer is called again.
Line 12:		Line 12:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setElementSyncer ( element theElement, player thePlayer )		bool setElementSyncer ( element theElement, player thePlayer[, bool persist=false ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[element]]:setSyncer\|syncer\|getElementSyncer}}		{{OOP\|\|[[element]]:setSyncer\|syncer\|getElementSyncer}}
Line 19:		Line 19:
	*'''theElement:''' The [[element]] whose syncer you wish to change.		*'''theElement:''' The [[element]] whose syncer you wish to change.
	*'''thePlayer:''' The [[player]] who should be the new syncer of the element. If set to ''false'', this element will not have a syncer. If set to ''true'', MTA will pick automatically the nearest or most relevant player to that element.		*'''thePlayer:''' The [[player]] who should be the new syncer of the element. If set to ''false'', this element will not have a syncer. If set to ''true'', MTA will pick automatically the nearest or most relevant player to that element.

			===Optional Arguments===
			*'''persist:''' If ''true'', the server will not automatically change the syncer. If set to ''false'', default syncer behavior resumes.

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

Walid: Fix oop syntax

2016-08-06T13:42:57Z

Fix oop syntax

← Older revision		Revision as of 13:42, 6 August 2016
Line 14:		Line 14:
	bool setElementSyncer ( element theElement, player thePlayer )		bool setElementSyncer ( element theElement, player thePlayer )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[element]]:setSyncer\|\|}}		{{OOP\|\|[[element]]:setSyncer\|syncer\|getElementSyncer}}

	===Required Arguments===		===Required Arguments===

Qaisjp: fix oop syntax

2015-01-01T22:58:41Z

fix oop syntax

← Older revision		Revision as of 22:58, 1 January 2015
Line 14:		Line 14:
	bool setElementSyncer ( element theElement, player thePlayer )		bool setElementSyncer ( element theElement, player thePlayer )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the Element class.~~\|[[element]]:setSyncer\|\|}}		{{OOP\|\|[[element]]:setSyncer\|\|}}

	===Required Arguments===		===Required Arguments===

Jaysds: /* Syntax */ OOP

2014-08-16T16:46:45Z

Syntax: OOP

← Older revision		Revision as of 16:46, 16 August 2014
Line 11:		Line 11:

	==Syntax==		==Syntax==

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setElementSyncer ( element theElement, player thePlayer )		bool setElementSyncer ( element theElement, player thePlayer )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:setSyncer\|\|}}

	===Required Arguments===		===Required Arguments===

Jaysds: /* Example */ No need for section

2014-08-16T14:43:42Z

Example: No need for section

← Older revision		Revision as of 14:43, 16 August 2014
Line 24:		Line 24:

	==Example==		==Example==
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler ( "createMyVehicle", function ( player, command )		addCommandHandler ( "createMyVehicle", function ( player, command )
Line 33:		Line 32:
	)		)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	==See Also==		==See Also==
	{{Element_functions}}		{{Element_functions}}

Jaysds: Example is provided

2014-08-16T14:42:55Z

Example is provided

← Older revision		Revision as of 14:42, 16 August 2014
Line 1:		Line 1:
	{{Server function}}		{{Server function}}
	__NOTOC__		__NOTOC__
	~~{{Needs Example}}~~
	This function can be used to change the syncer ([[player]]) of an element. The syncer is the player who is responsible for informing the server about the state of that element - it's position, orientation and other state information. The function can be also used to remove an element's syncer.		This function can be used to change the syncer ([[player]]) of an element. The syncer is the player who is responsible for informing the server about the state of that element - it's position, orientation and other state information. The function can be also used to remove an element's syncer.

Thisdp .: /* Example */

2014-08-15T15:10:57Z

Example

← Older revision		Revision as of 15:10, 15 August 2014
Line 27:		Line 27:
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- TODO~~		addCommandHandler ( "createMyVehicle", function ( player, command )
			local x, y, z = getElementPosition ( player )
			local myVehicle = createVehicle ( 411, x, y, z )
			setElementSyncer ( myVehicle, player )
			end
			)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

AlexTMjugador: /* Required Arguments */

2014-06-22T10:17:45Z

Required Arguments

← Older revision		Revision as of 10:17, 22 June 2014
Line 19:		Line 19:
	===Required Arguments===		===Required Arguments===
	*'''theElement:''' The [[element]] whose syncer you wish to change.		*'''theElement:''' The [[element]] whose syncer you wish to change.
	*'''thePlayer:''' The [[player]] who should be the new syncer of the element. If set to [[false]], this element will not have a syncer. If set to [[true]], the most relevant player ~~will become the~~ element~~'s syncer~~.		*'''thePlayer:''' The [[player]] who should be the new syncer of the element. If set to ''false'', this element will not have a syncer. If set to ''true'', MTA will pick automatically the nearest or most relevant player to that element.

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

The Kid at 00:40, 14 November 2011

2011-11-14T00:40:47Z

← Older revision		Revision as of 00:40, 14 November 2011
Line 1:		Line 1:
	{{Server function}}		{{Server function}}
	__NOTOC__		__NOTOC__
			{{Needs Example}}
	This function can be used to change the syncer ([[player]]) of an element. The syncer is the player who is responsible for informing the server about the state of that element - it's position, orientation and other state information. The function can be also used to remove an element's syncer.		This function can be used to change the syncer ([[player]]) of an element. The syncer is the player who is responsible for informing the server about the state of that element - it's position, orientation and other state information. The function can be also used to remove an element's syncer.

← Older revision		Revision as of 22:32, 6 September 2024
Line 37:		Line 37:

	==See Also==		==See Also==
	{{Element_functions}}		{{Element_functions\|server}}