Component:FocusedWorldStatus

This is a Userspace component — It has reduced or no functionality outside of userspace but it can be attached to objects in a normal world. Changing components in userspace is not recommended and may break functionality of your dashboard. Proceed with caution even if you know what you're doing.

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

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.
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.