Skip to main content
Member of ML.SDK.MLPlayer
Method

void MLPlayer.Portal(string worldGUID, string region, PortalBehavior behavior, string instanceId = null)

 void MLPlayer.Portal(string worldGUID, string region, PortalBehavior behavior, string instanceId = null);

Parameters

ParameterTypeDescription
worldGUIDstringThe 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.
regionstringThe region token of the target instance. Set it to nil for best region or use on of the region tokens listed below.
behaviorPortalBehaviorThe behavior of the portal in regard to the instance of the target world.
instanceIdstringOptional 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.

Returns

void

Summary

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/Editor Mode.