m ProbablePrime moved page FocusedWorldStatus (Component) to Component:FocusedWorldStatus: Creating component Namespace |
assorted copyedit |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{ | {{UserspaceComponent}} | ||
{{Infobox Component | {{Infobox Component | ||
|Image=FocusedWorldStatusComponent.png | |Image=FocusedWorldStatusComponent.png | ||
|Name= | |Name=Focused World Status | ||
}} | }} | ||
'''FocusedWorldStatus''' is a component that displays information about the currently focused world. It's used in the session tab in the [[dash]]. | |||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|WorldName|String| | |WorldName|String| The name of the currently focused world. | ||
|IsHost|Bool| | |RawWorldName|String| The raw unfiltered name of the currently focused world. | ||
|CanSave|Bool| | |SessionId|String| The session ID of the currently focused world. | ||
|ShouldSave|Bool| | |IsHost|Bool| Whether the user is the host of the focused world. | ||
|CanClose|Bool| | |CanSave|Bool| Whether the user is allowed to save the focused world. | ||
|ShouldSave|Bool| Whether the focused world has unsaved changes or not. | |||
|CanClose|Bool| Whether the focused world can be closed. False for the [[Local Home]]. | |||
|RoleName|String| The name of the role that the user currently has in the focused world. | |||
|UserCount|Int| The amount of users currently in the focused world. | |||
|ActiveUserCount|Int| How many of the users in the focused world aren't AFK. | |||
|MaxUserCount|Int| The maximum amount of users that can be in the focused world. | |||
|AccessLevel|SessionAccessLevel| The access level of the focused world. | |||
|HideFromListing|Bool| Whether or not the focused world should not be shown in world listings or shown to other users. | |||
|AwayKickEnabled|Bool| Whether the focused world has AFK kick enabled. | |||
|AwayKickMinutes|Float| How many minutes a user can be AFK before being kicked from the focused world. | |||
|UnsafeMode|Bool| Whether the focused world is in [[unsafe mode]], which allows for some features to work. Can only be true in private worlds. | |||
}} | }} | ||
<!--T:4--> | <!--T:4--> | ||
== | == Usage == | ||
Used in the dash, and isn't utilizable in normal gameplay. | |||
<!--T:5--> | <!--T:5--> | ||
== Examples == | == Examples == | ||
Used in the dash. | |||
<!--T:6--> | <!--T:6--> | ||
== | == See Also == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}| | [[Category:Components{{#translation:}}|Focused World Status]] | ||
[[Category:Components:World{{#translation:}}|Focused World Status]] | |||
[[Category:Components:World{{#translation:}}| |
Latest revision as of 13:22, 23 September 2025
Component image 
Focused World Status component as seen in the Scene Inspector

FocusedWorldStatus is a component that displays information about the currently focused world. It's used in the session tab in the dash.
Usage
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. |
WorldName
|
String | The name of the currently focused world. |
RawWorldName
|
String | The raw unfiltered name of the currently focused world. |
SessionId
|
String | The session ID of the currently focused world. |
IsHost
|
Bool | Whether the user is the host of the focused world. |
CanSave
|
Bool | Whether the user is allowed to save the focused world. |
ShouldSave
|
Bool | Whether the focused world has unsaved changes or not. |
CanClose
|
Bool | Whether the focused world can be closed. False for the Local Home. |
RoleName
|
String | The name of the role that the user currently has in the focused world. |
UserCount
|
Int | The amount of users currently in the focused world. |
ActiveUserCount
|
Int | How many of the users in the focused world aren't AFK. |
MaxUserCount
|
Int | The maximum amount of users that can be in the focused world. |
AccessLevel
|
SessionAccessLevel | The access level of the focused world. |
HideFromListing
|
Bool | Whether or not the focused world should not be shown in world listings or shown to other users. |
AwayKickEnabled
|
Bool | Whether the focused world has AFK kick enabled. |
AwayKickMinutes
|
Float | How many minutes a user can be AFK before being kicked from the focused world. |
UnsafeMode
|
Bool | Whether the focused world is in unsafe mode, which allows for some features to work. Can only be true in private worlds. |
Usage
Used in the dash, and isn't utilizable in normal gameplay.
Examples
Used in the dash.