Type:SessionAccessLevel: Difference between revisions

From Resonite Wiki
m Add categories
m fix possible syntax error
 
(3 intermediate revisions by one other user not shown)
Line 2: Line 2:


{{Table EnumValues
{{Table EnumValues
|Private|0|
|Private|0|Only Invited users can join this Session.
|LAN|1|
|LAN|1|Only users on the same Local Area Network(LAN), can join this Session.
|Contacts|2|
|Contacts|2|Only Contacts of the Host can join this Session.
|Friends|2|This is an obsolete alternative name for <code>Contacts</code>.
|ContactsPlus|3|Contacts of the Host and any Contacts of any Guests can join this Session.
|ContactsPlus|3|
|RegisteredUsers|4|Users who have a registered Resonite account can join this Session.
|FriendsOfFriends|3|This is an obsolete alternative name for <code>ContactsPlus</code>.
|Anyone|5|Anyone can join this Session.
|RegisteredUsers|4|
|Anyone|5|
}}
}}
== Obsolete Values ==
This enum, has some Obsolete values. These values may appear from time to time but are in the process of being phased out. '''Do not use these'''.
{{Table EnumValues
|Friends|2|This is an obsolete name for <code>Contacts</code>. ''Do not use this''.
|FriendsOfFriends|3|This is an obsolete name for <code>ContactsPlus</code>. ''Do not use this''.
}}
The values were made obsolete, when the entire "Friends" system was renamed to "Contacts".


[[Category:Type]]
[[Category:Type]]
[[Category:Enums]]
[[Category:Enums]]
== See Also ==
* [[LAN Sessions]]

Latest revision as of 19:19, 4 November 2024

SessionAccessLevel is an Enum that represents the different Access Levels a Session can have. It has the following values:

Values
Name Value Description
Private 0 Only Invited users can join this Session.
LAN 1 Only users on the same Local Area Network(LAN), can join this Session.
Contacts 2 Only Contacts of the Host can join this Session.
ContactsPlus 3 Contacts of the Host and any Contacts of any Guests can join this Session.
RegisteredUsers 4 Users who have a registered Resonite account can join this Session.
Anyone 5 Anyone can join this Session.


Obsolete Values

This enum, has some Obsolete values. These values may appear from time to time but are in the process of being phased out. Do not use these.

Values
Name Value Description
Friends 2 This is an obsolete name for Contacts. Do not use this.
FriendsOfFriends 3 This is an obsolete name for ContactsPlus. Do not use this.


The values were made obsolete, when the entire "Friends" system was renamed to "Contacts".

See Also