SetPlayerDimension: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|Sets the dimension (Virtual World) of this player. Players can only see players in the same dimension.
{{FuncDescription|Sets the dimension (Virtual World) of this player. Players can only see players and other entities in the same dimension.
* Default dimension: 0
* Default dimension: 0
* Maximum dimension: 4294967295
* Maximum dimension: 4294967295
Line 16: Line 16:


== Example ==
== Example ==
__EDIT_ME__
Player dimension example can be found in the race package: https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/master/race/server/race.lua#L422


{{RelatedFunctions}}
{{RelatedFunctions}}
{{Template:DimensionFunctions}}
{{ServerPlayerFunctions}}

Revision as of 11:05, 2 September 2020

SetPlayerDimension

Type: Function
Context: Server
Introduced: v1.0

Description

Sets the dimension (Virtual World) of this player. Players can only see players and other entities in the same dimension.

  • Default dimension: 0
  • Maximum dimension: 4294967295

You should set the players voice dimension as well SetPlayerVoiceDimension.

Syntax

SetPlayerDimension(player, dimension)

Parameters

  • player
    The player identifier.
  • dimension
    The new dimension to set.

Return Value

  • This function returns nothing.

Example

Player dimension example can be found in the race package: https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/master/race/server/race.lua#L422

See also