MLPlayer.Portal(string worldGuid, string region, PortalBehavior behavior, string insntanceId = nil)
Send player to another world. This method only take effect if player is the local player. Note that this method also will not work in Local Mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| worldGuid | string | The id of the target world defined in GUID (globally unique id). You can use the world browser in massive loop website to find the GUID of any world, including the built-in worlds. |
| region | string | The region token of the target instance. Set it to nil for best region or use on of the region tokens listed below. |
| behavior | PortalBehavior | The behavior of the portal in regard to the instance of the target world. |
| insntanceId | string | Optional instance id of the target instance if the PortalBehavior.JoinSpecific selected. Use this only if you are trying to create a portal to a persistent instance. Note that the instance id of the none-persistent (basically any normal) instance is fluid and will change, destroyed when everybody in that instance leave. |
Usage
---@type MLPlayer
local mlplayer;
---@type string
local worldGuid;
---@type string
local region;
---@type PortalBehavior
local behavior;
---@type string
local insntanceId;
mlplayer.Portal(worldGuid, region, behavior, insntanceId)