Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Universe Status | |Name=Universe Status | ||
}} | }} | ||
The '''UniverseStatus''' component provides information on the current [[Universes|universe]]. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|UniverseId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv0=true| | |UniverseId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv0=true| The ID of the universe current Universe. | ||
|UniverseName|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv1=true| | |UniverseName|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv1=true| The universe's name. | ||
|PrimaryGroupId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| | |PrimaryGroupId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| The ID of the primary group of the universe. | ||
|InUniverse|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv3=true| | |InUniverse|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv3=true| Whether we are in a universe or not. | ||
}} | }} | ||
== | == Usage == | ||
Attach to a slot and it will start giving data on the current universe. | |||
== Examples == | == Examples == | ||
{{stub}} | |||
== See Also == | == See Also == | ||
* [[Universes]] | |||
[[Category:Components:Cloud:Indicators{{#translation:}}|Universe Status]] | [[Category:Components:Cloud:Indicators{{#translation:}}|Universe Status]] | ||
[[Category:Components{{#translation:}}|Universe Status]] | [[Category:Components{{#translation:}}|Universe Status]] | ||
Latest revision as of 14:54, 6 February 2025
Component image File:UniverseStatusComponent.pngUniverse Status component as seen in the Scene Inspector
The UniverseStatus component provides information on the current universe.
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. Some components stop their functionality when this field is disabled, but some don't. |
UniverseId
|
raw output of String | The ID of the universe current Universe. |
UniverseName
|
raw output of String | The universe's name. |
PrimaryGroupId
|
raw output of String | The ID of the primary group of the universe. |
InUniverse
|
raw output of Bool | Whether we are in a universe or not. |
Usage
Attach to a slot and it will start giving data on the current universe.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.