Component:OnlineStatistics: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
Automated: update Fields
add info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=OnlineStatisticsComponent.png
|Image=OnlineStatisticsComponent.png
|Name=Online Statistics
|Name=Online Statistics
}}
}}
The '''OnlineStatistics''' component shows information about current session numbers and the number of users in them.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Timestamp|{{RootFieldType|RawOutput`1|[[Type:DateTime|DateTime]]}}|TypeAdv0=true|
|Timestamp|{{RootFieldType|RawOutput`1|[[Type:DateTime|DateTime]]}}|TypeAdv0=true| The last time the component got the online statistics successfully.
|VisibleSessions|{{RootFieldType|(nested)|[[#SessionStats|SessionStats]]}}|TypeAdv1=true|
|VisibleSessions|{{RootFieldType|(nested)|[[#SessionStats|SessionStats]]}}|TypeAdv1=true| Statistics of visible sessions.
|HiddenSessions|{{RootFieldType|(nested)|[[#SessionStats|SessionStats]]}}|TypeAdv2=true|
|HiddenSessions|{{RootFieldType|(nested)|[[#SessionStats|SessionStats]]}}|TypeAdv2=true| Statistics of hidden sessions.
|ActiveVisibleSessions|{{RootFieldType|(nested)|[[#SessionStats|SessionStats]]}}|TypeAdv3=true|
|ActiveVisibleSessions|{{RootFieldType|(nested)|[[#SessionStats|SessionStats]]}}|TypeAdv3=true| Statistics of visible sessions with users active in them.
|ActiveHiddenSessions|{{RootFieldType|(nested)|[[#SessionStats|SessionStats]]}}|TypeAdv4=true|
|ActiveHiddenSessions|{{RootFieldType|(nested)|[[#SessionStats|SessionStats]]}}|TypeAdv4=true| Statistics of hidden sessions with users active in them.
|RegisteredOnlineUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv5=true|How many users with a Resonite account are online
|RegisteredOnlineUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv5=true|How many users with a Resonite account are online
|TotalOnlineUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv6=true|How many users are online in total
|TotalOnlineUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv6=true|How many users are online in total
|PresentUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv7=true|
|PresentUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv7=true| How many users are at their keyboard or in headset.
|AwayUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv8=true|
|AwayUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv8=true| How many users have their status set to away?
|UsersInVR|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv9=true|
|UsersInVR|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv9=true| How many users are in VR?
|UsersInScreen|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv10=true|
|UsersInScreen|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv10=true| How many users are in screen mode?
|UsersOnDesktop|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv11=true|
|UsersOnDesktop|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv11=true| How many users are on desktop?
|UsersOnMobile|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv12=true|
|UsersOnMobile|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv12=true| How many users are using the mobile binary of the game?
|UsersInVisiblePublicSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv13=true|
|UsersInVisiblePublicSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv13=true| How many users are in visible sessions?
|UsersInVisibleSemiAccessibleSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv14=true|
|UsersInVisibleSemiAccessibleSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv14=true| How many users are in semi accessible sessions like contacts or contacts plus?
|UsersInHiddenSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv15=true|
|UsersInHiddenSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv15=true| How many users are in hidden sessions
|UsersInPrivateSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv16=true|
|UsersInPrivateSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv16=true| How many users are in private sessions?
|UsersInPrivate|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv17=true|
|UsersInPrivate|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv17=true| How many users are in private?
|UsersInLAN|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv18=true|
|UsersInLAN|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv18=true| How many users are in Local Access Network sessions?
|UsersInContacts|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv19=true|
|UsersInContacts|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv19=true| How many users are in contacts sessions?
|UsersInContactsPlus|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv20=true|
|UsersInContactsPlus|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv20=true| How many users are in contacts plus sessions?
|UsersInRegistered|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv21=true|
|UsersInRegistered|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv21=true| How many users are in sessions that require a logged in user? (Not nessarily resonite account because SAML)
|UsersInPublic|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv22=true|How many users are currently online in public sessions
|UsersInPublic|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv22=true|How many users are currently online in public sessions
|GraphicalClientUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv23=true|
|GraphicalClientUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv23=true| How many users are not headlesses
|ChatClientUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv24=true|
|ChatClientUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv24=true| How many users are using chat clients? (Like recon)
|HeadlessUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv25=true|How many of the online users are [[Headless_Client|Headless Accounts]]
|HeadlessUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv25=true|How many of the online users are [[Headless_Client|Headless Accounts]]
|BotUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv26=true|
|BotUsers|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv26=true| How many users are bot accounts (occasionally 1 when the resonite bot is online)
}}
 
== SessionStats ==
{{Table TypeFields
|PublicSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv0=true| How many public sessions are in this category?
|RegisteredSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv1=true| How many sessions open only to registered users are in this category?
|ContactsPlusSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv2=true| How many sessions open only to contacts of contacts are in this category?
|ContactsSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv3=true| How many sessions open to only contacts of the host are in this category?
|LANSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv4=true| How many sessions that are Local access network sessions are in this category?
|PrivateSessions|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;}}|TypeAdv5=true| How many sessions that are invite only are in this category?
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Can be used to get session statistic data or make a hermit counter.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Online Statistics]]
[[Category:Components{{#translation:}}|Online Statistics]]
[[Category:Components With Nested Types{{#translation:}}|Online Statistics]]
[[Category:Components With Nested Types{{#translation:}}|Online Statistics]]
[[Category:Components:Cloud:Indicators{{#translation:}}|Online Statistics]]
[[Category:Components:Cloud:Indicators{{#translation:}}|Online Statistics]]

Latest revision as of 18:47, 29 January 2025

Component image 
Online Statistics component as seen in the Scene Inspector

The OnlineStatistics component shows information about current session numbers and the number of users in them.

Fields

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.
Timestamp raw output of DateTime The last time the component got the online statistics successfully.
VisibleSessions direct SessionStats Statistics of visible sessions.
HiddenSessions direct SessionStats Statistics of hidden sessions.
ActiveVisibleSessions direct SessionStats Statistics of visible sessions with users active in them.
ActiveHiddenSessions direct SessionStats Statistics of hidden sessions with users active in them.
RegisteredOnlineUsers raw output of Nullable`1<Int> How many users with a Resonite account are online
TotalOnlineUsers raw output of Nullable`1<Int> How many users are online in total
PresentUsers raw output of Nullable`1<Int> How many users are at their keyboard or in headset.
AwayUsers raw output of Nullable`1<Int> How many users have their status set to away?
UsersInVR raw output of Nullable`1<Int> How many users are in VR?
UsersInScreen raw output of Nullable`1<Int> How many users are in screen mode?
UsersOnDesktop raw output of Nullable`1<Int> How many users are on desktop?
UsersOnMobile raw output of Nullable`1<Int> How many users are using the mobile binary of the game?
UsersInVisiblePublicSessions raw output of Nullable`1<Int> How many users are in visible sessions?
UsersInVisibleSemiAccessibleSessions raw output of Nullable`1<Int> How many users are in semi accessible sessions like contacts or contacts plus?
UsersInHiddenSessions raw output of Nullable`1<Int> How many users are in hidden sessions
UsersInPrivateSessions raw output of Nullable`1<Int> How many users are in private sessions?
UsersInPrivate raw output of Nullable`1<Int> How many users are in private?
UsersInLAN raw output of Nullable`1<Int> How many users are in Local Access Network sessions?
UsersInContacts raw output of Nullable`1<Int> How many users are in contacts sessions?
UsersInContactsPlus raw output of Nullable`1<Int> How many users are in contacts plus sessions?
UsersInRegistered raw output of Nullable`1<Int> How many users are in sessions that require a logged in user? (Not nessarily resonite account because SAML)
UsersInPublic raw output of Nullable`1<Int> How many users are currently online in public sessions
GraphicalClientUsers raw output of Nullable`1<Int> How many users are not headlesses
ChatClientUsers raw output of Nullable`1<Int> How many users are using chat clients? (Like recon)
HeadlessUsers raw output of Nullable`1<Int> How many of the online users are Headless Accounts
BotUsers raw output of Nullable`1<Int> How many users are bot accounts (occasionally 1 when the resonite bot is online)

SessionStats

Fields
Name Type Description
PublicSessions raw output of Nullable`1<Int> How many public sessions are in this category?
RegisteredSessions raw output of Nullable`1<Int> How many sessions open only to registered users are in this category?
ContactsPlusSessions raw output of Nullable`1<Int> How many sessions open only to contacts of contacts are in this category?
ContactsSessions raw output of Nullable`1<Int> How many sessions open to only contacts of the host are in this category?
LANSessions raw output of Nullable`1<Int> How many sessions that are Local access network sessions are in this category?
PrivateSessions raw output of Nullable`1<Int> How many sessions that are invite only are in this category?

Usage

Can be used to get session statistic data or make a hermit counter.

Examples

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


See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:OnlineStatistics&oldid=95314"