Component:SessionInfoSource: Difference between revisions

From Resonite Wiki
imported>Chemicalcrux
Creating the page (with a bot!)
 
Automated: update Fields, Categories
 
(6 intermediate revisions by 4 users not shown)
Line 4: Line 4:
{{stub}}
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=SessionInfoSourceComponent.png
|Image=SessionInfoSourceComponent.webp
|Name=SessionInfoSource
|Name=SessionInfoSource
}}
}}


<!--T:2-->
The SessionInfoSource component can be used to receive an assortment of useful information from an inputted SessionId.
== Intoduction ==
 
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|SessionId|String|  
|SessionId|String|
|IsOpen|Bool|  
|IsOpen|Bool|
|LastUpdated|DateTime|  
|LastUpdated|DateTime|
|Name|String|  
|Name|String|
|Description|String|  
|Description|String|
|Tags|String|  
|Tags|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv5=true|
|CorrespondingRecordId|String|  
|CorrespondingRecordId|String|
|CorrespondingOwnerId|String|  
|CorrespondingOwnerId|String|
|HostUserId|String|  
|HostUserId|String|
|HostUsername|String|  
|HostUsername|String|
|NeosVersion|String|  
|SanitizedHostUsername|String|
|HeadlessHost|Bool|  
|AppVersion|String|
|SessionURLs|String|  
|HeadlessHost|Bool|
|Thumbnail|String|  
|SessionURLs|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv13=true|
|JoinedUsers|Int|  
|Thumbnail|String|
|ActiveUsers|Int|  
|JoinedUsers|Int|
|MaximumUsers|Int|  
|ActiveUsers|Int|
|MobileFriendly|Bool|  
|TotalJoinedUsers|Int|
|AccessLevel|SessionAccessLevel|  
|TotalActiveUsers|Int|
|IsOnLAN|Bool|  
|MaximumUsers|Int|
|MobileFriendly|Bool|
|AccessLevel|SessionAccessLevel|
|IsOnLAN|Bool|
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== 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.


<!--T:5-->
== Examples ==
== Examples ==


Line 45: Line 45:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|SessionInfoSource (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Session Info Source]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components:World{{#translation:}}|SessionInfoSource (Component){{#translation:}}]]
[[Category:Components:World{{#translation:}}|Session Info Source]]

Latest revision as of 23:07, 3 March 2024


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


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

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.
SessionId String
IsOpen Bool
LastUpdated DateTime
Name String
Description String
Tags direct SyncFieldList`1<String>
CorrespondingRecordId String
CorrespondingOwnerId String
HostUserId String
HostUsername String
SanitizedHostUsername String
AppVersion String
HeadlessHost Bool
SessionURLs direct SyncFieldList`1<String>
Thumbnail String
JoinedUsers Int
ActiveUsers Int
TotalJoinedUsers Int
TotalActiveUsers Int
MaximumUsers Int
MobileFriendly Bool
AccessLevel SessionAccessLevel
IsOnLAN Bool

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

Related Components