Component:SessionInfoSource

CollapseComponent image 

SessionInfoSource component as seen in the Scene Inspector

The SessionInfoSource component can be used to receive an assortment of useful information from an inputted SessionId.

Fields

Fields Collapse

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.
SessionId	String	The session ID to get information on.
IsOpen	Bool	Whether the session is open.
LastUpdated	DateTime	The last time the info on this component was updated.
Name	String	The name of the session
Description	String	The session description.
Tags	direct SyncFieldList`1<String>	Tags that the session world has.
CorrespondingRecordId	String	The record ID of the world of the session
CorrespondingOwnerId	String	The owner UserID of the session's world.
HostUserId	String	The UserID of the session host.
HostUsername	String	The username of the session host.
SanitizedHostUsername	String	The username of the session host which escapes special characters.
AppVersion	String	The App version of the client of the session being hosted.
HeadlessHost	Bool	Whether the session is being hosted by a headless client.
SessionURLs	direct SyncFieldList`1<String>	A list of other session URLs using the same world.
Thumbnail	String	The link for the session thumbnail in text form.
JoinedUsers	Int	How many users are in the world.
ActiveUsers	Int	Of the people joined, how many are active/focused?
TotalJoinedUsers	Int	How many users have ever joined the world?
TotalActiveUsers	Int	How many users are active??
MaximumUsers	Int	The maximum users that can be in the session.
MobileFriendly	Bool	Whether the session is compatible with a mobile/quest build of the game.
AccessLevel	SessionAccessLevel	The sessions level of access to users joining.
IsOnLAN	Bool	Whether the session is set to Local Access Network.
AwayKickEnabled	Bool	Whether away kick is enabled or not
AwayKickInterval	TimeSpan	How long till a user is kicked for being away in a session.

Usage

The SessionInfoSource component can give us the name, description, tags, and many other useful pieces of information about a session from an inputted SessionId. The current SessionId can be obtained using the WorldSessionID ProtoFlux node.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.