SetElementSyncer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
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.


Revision as of 00:40, 14 November 2011


Accessories-text-editor.png Script Example Missing Function SetElementSyncer needs a script example, help out by writing one.
Before submitting check out Editing Guidelines Script Examples.

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.

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.

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. It should also be noted that certain network changes to an element do not require a syncer. Actions such as destroying an element or explicitly setting the element's position (in a server side script), will still be updated on all clients regardless of this setting.

Syntax

bool setElementSyncer ( element theElement, player thePlayer )

Required Arguments

  • 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.

Returns

Returns true if the syncer was changed successfully, false if the element passed was not a ped or vehicle.

Example

Click to collapse [-]
Server
-- TODO

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementSyncer?oldid=27806"