Automated: create new component page |
This is no longer a stub. Added a description. Added field descriptions, added usage description. |
||
| Line 3: | Line 3: | ||
|Name=Button Open Home | |Name=Button Open Home | ||
}} | }} | ||
The '''ButtonOpenHome''' component, when pressed with an [[Type:IButton|IButton]], takes the [[User]] to their favorite home [[World|world]] (usually the [[Resonite Cloud Home]] by default). There is an optional [[Type:string|string]] input for a [[Homes#Group_Home|group home]]. | |||
{{Table ComponentFields | {{Table ComponentFields | ||
|LastOpened|{{RootFieldType|SyncTime}}|TypeAdv0=true| | |LastOpened|{{RootFieldType|SyncTime}}|TypeAdv0=true| Shows when the world was last opened (not shown in the component). | ||
|GroupOwnerId|String| | |GroupOwnerId|String| An optional [[Type:string|string]] input for a [[Homes#Group_Home|group home]]. | ||
}} | }} | ||
== | == Usage == | ||
This is an easy way to set up a way to get to your favorite home faster. | |||
== Examples == | == Examples == | ||
| Line 19: | Line 20: | ||
[[Category:Components:Common UI:Button Interactions:Specialized{{#translation:}}|Button Open Home]] | [[Category:Components:Common UI:Button Interactions:Specialized{{#translation:}}|Button Open Home]] | ||
[[Category:Components{{#translation:}}|Button Open Home]] | [[Category:Components{{#translation:}}|Button Open Home]] | ||
Latest revision as of 02:53, 12 September 2024
Component image 
Button Open Home component as seen in the Scene Inspector
The ButtonOpenHome component, when pressed with an IButton, takes the User to their favorite home world (usually the Resonite Cloud Home by default). There is an optional string input for a group home.
| 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 when the world was last opened (not shown in the component). |
GroupOwnerId
|
String | An optional string input for a group home. |
Usage
This is an easy way to set up a way to get to your favorite home faster.