SetElementSyncer

From Multi Theft Auto: Wiki
Revision as of 23:15, 23 April 2010 by Ccw (talk | contribs)
Jump to navigation Jump to search

This function can be used to change the syncer (player) of an element. The function can be also used to remove element's syncer.

Using the function to change an elements syncer will only last as long as the element is within syncable range of the player. (i.e. It is streamed in for that player). As soon as it becomes impossible for your chosen player to sync the element, another player will be automatically selected, and your setting will be lost. With vehicles, the last passenger to leave a vehicle will be selected as the syncer and override any setting you may have made.

Using the function to turn off an elements syncer, means no player will be assigned to syncing the element. That will not be changed until setElementSyncer is called again. It should be noted that certain network changes to an element do not require a syncer. Things such as destroying an element or explicitly setting the elements 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 elements syncer.

Returns

Returns true if the syncer was changed succesfully, false otherwise.

Example

Click to collapse [-]
Server
-- TODO

See Also