m ProbablePrime moved page WorldLink (Component) to Component:WorldLink: Creating component Namespace |
fix some info |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=WorldLinkComponent.png | |Image=WorldLinkComponent.png | ||
Line 9: | Line 8: | ||
<!--T:2--> | <!--T:2--> | ||
The '''WorldLink''' component is used to set the [[World|world]] information, either to use as a way to jump to different worlds or to pre-load worlds. | |||
<!--T:3--> | <!--T:3--> | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|URL|Uri| | |URL|Uri| The world to link. | ||
|ActiveSessionURLs|Uri| | |ActiveSessionURLs|{{RootFieldType|SyncFieldList`1|[[Type:Uri|Uri]]}}|TypeAdv1=true| Used for session orbs. | ||
|CreateIfNotExists|WorldCreator| | |CreateIfNotExists|{{RootFieldType|SyncDelegate`1|[[Type:WorldCreator|WorldCreator]]}}|TypeAdv2=true| If the world we are going to does not exist, then make one. | ||
|WorldRelation|WorldRelation| | |WorldRelation|WorldRelation| The relation of the world. | ||
|AutoFocus|Bool| | |AutoFocus|Bool| After the world loads, focus to this world automatically. | ||
|GetExisting|Bool| | |GetExisting|Bool| If a world we are looking for already exists, then don't make a new one and then optionally focus onto it. | ||
}} | }} | ||
<!--T:4--> | <!--T:4--> | ||
== | == Usage == | ||
* This can be combined with the [[Component:ButtonWorldLink|ButtonWorldLink]] component to setup a button for loading a world for a user. | |||
* This can be hooked up into [[ProtoFlux]] with the [[ProtoFlux:Open World|Open World]] or [[ProtoFlux:Focus World|Focus World]] nodes to open or jump to another world. | |||
<!--T:5--> | <!--T:5--> | ||
Line 31: | Line 31: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}| | [[Category:Components{{#translation:}}|World Link]] | ||
[[Category:Components:World{{#translation:}}|World Link]] | |||
[[Category:Components:World{{#translation:}}| |
Latest revision as of 13:53, 20 October 2024
Component image
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.
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
- This can be combined with the ButtonWorldLink component to setup a button for loading a world for a user.
- This can be hooked up into ProtoFlux with the Open World or Focus World nodes to open or jump to another world.