Component:WorldLink: Difference between revisions

From Resonite Wiki
This is no longer a stub. Added a description, added field descriptions, added usage descriptions.
fix some info
 
Line 17: Line 17:
|WorldRelation|WorldRelation| The relation of the world.
|WorldRelation|WorldRelation| The relation of the world.
|AutoFocus|Bool| After the world loads, focus to this world automatically.
|AutoFocus|Bool| After the world loads, focus to this world automatically.
|GetExisting|Bool| If a world we are looking for already exists, then create or focus onto it.
|GetExisting|Bool| If a world we are looking for already exists, then don't make a new one and then optionally focus onto it.
}}
}}



Latest revision as of 13:53, 20 October 2024

Component image 
WorldLink component as seen in the Scene Inspector


The WorldLink component is used to set the world information, either to use as a way to jump to different worlds or to pre-load worlds.

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
URL Uri The world to link.
ActiveSessionURLs direct SyncFieldList`1<Uri> Used for session orbs.
CreateIfNotExists WorldCreator If the world we are going to does not exist, then make one.
WorldRelation WorldRelation The relation of the world.
AutoFocus Bool After the world loads, focus to this world automatically.
GetExisting Bool If a world we are looking for already exists, then don't make a new one and then optionally focus onto it.

Usage

Examples

Related Components