Component:ButtonWorldLink: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
This is no longer a stub. Added a description, added a usage description, added field descriptions.
 
Line 3: Line 3:
|Name=Button World Link
|Name=Button World Link
}}
}}
{{stub}}


== Usage ==
The '''ButtonWorldLink''' component takes in a [[Component:WorldLink|WorldLink]] Component. When an [[Type:IButton|IButton]] is pressed while this component is in the same [[Slot|slot]] as it, this component will attempt to open a [[World|world]] that is provided from that world link component.
 
{{Table ComponentFields
{{Table ComponentFields
|LastOpened|{{RootFieldType|SyncTime}}|TypeAdv0=true|
|LastOpened|{{RootFieldType|SyncTime}}|TypeAdv0=true| Shows the last opened time (not seen in the component).
|WorldLink|'''[[Component:WorldLink|WorldLink]]'''|TypeAdv1=true|
|WorldLink|'''[[Component:WorldLink|WorldLink]]'''|TypeAdv1=true| The [[Component:WorldLink|WorldLink]] component that contains the world information.
}}
}}


== Behavior ==
== Usage ==
This allows a user to make customizable world loading buttons, either as a way to go to another world or to pre-load a world.


== Examples ==
== Examples ==
Line 19: Line 20:
[[Category:Components:Common UI:Button Interactions{{#translation:}}|Button World Link]]
[[Category:Components:Common UI:Button Interactions{{#translation:}}|Button World Link]]
[[Category:Components{{#translation:}}|Button World Link]]
[[Category:Components{{#translation:}}|Button World Link]]
[[Category:ComponentStubs]]

Latest revision as of 00:36, 12 September 2024

Component image 
Button World Link component as seen in the Scene Inspector


The ButtonWorldLink component takes in a WorldLink Component. When an IButton is pressed while this component is in the same slot as it, this component will attempt to open a world that is provided from that world link component.

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.
LastOpened direct SyncTime Shows the last opened time (not seen in the component).
WorldLink WorldLink The WorldLink component that contains the world information.

Usage

This allows a user to make customizable world loading buttons, either as a way to go to another world or to pre-load a world.

Examples

See Also