Inheritance diagram for Room:
Public Member Functions | |
| proto native bool | Official () |
| Returns true for official dedicated server and false for community servers. | |
| proto native bool | PasswordProtected () |
| Does the server require a password to join. | |
| proto native bool | IsAuthorized () |
| Was the password verified and may the client join the server or view its content. | |
| proto native bool | Joinable () |
| Returns false if the server is not ready to receive players (e.g. | |
| proto native bool | IsModded () |
| proto native bool | IsFavorite () |
| proto native int | PlayerLimit () |
| proto native int | PlayerCount () |
| proto native string | GameVersion () |
| proto native string | Region () |
| proto native string | Name () |
| proto native string | ScenarioName () |
| proto native Dependency | HostScenarioMod () |
| Addon that contains the hosted scenario. | |
| proto native string | HostAddress () |
| proto native string | HostType () |
| Specifies type of server. | |
| proto native string | OwnerName () |
| BI-account name of the server owner (if known) | |
| proto native string | GameMode () |
| proto native void | Join (BackendCallback callback, JsonApiStruct params) |
| proto native int | GetItems (out notnull array< Dependency > items) |
| Get the list of addons that are present on the server. | |
| proto native void | SetFavorite (bool favorite, BackendCallback callback) |
| proto native bool | IsClientReady () |
| Are client's mods the same as in this room? | |
| proto native bool | IsCrossPlatform () |
| proto native MissionWorkshopItem | HostScenario () |
| proto native void | LoadDownloadList (BackendCallback callback) |
| Load informations about hosted addons. | |
| proto native float | GetPing () |
| Get the last measured ping value. | |
| proto native bool | HasBattlEye () |
| proto native void | VerifyPassword (string password, BackendCallback callback) |
| Check if the server is matching. | |
| proto native void | CheckAuthorization (BackendCallback callback) |
| Check on reconnect for password protected server. | |
| proto native bool | IsDownloadListLoaded () |
| Is the list of hosted addons ready or should we load it (LoadDownloadList) | |
 Public Member Functions inherited from Managed | |
| proto external ref Managed | Clone () |
| Return shallow copy of object, or null if it is not allowed (not public constructor) | |
Member Function Documentation
◆ CheckAuthorization()
| proto native void Room.CheckAuthorization | ( | BackendCallback | callback | ) |
Check on reconnect for password protected server.
- player should be able to rejoin without reentering the password
◆ GameMode()
| proto native string Room.GameMode | ( | ) |
◆ GameVersion()
| proto native string Room.GameVersion | ( | ) |
◆ GetItems()
| proto native int Room.GetItems | ( | out notnull array< Dependency > | items | ) |
Get the list of addons that are present on the server.
Available just if IsAuthorized() returns true
◆ GetPing()
| proto native float Room.GetPing | ( | ) |
Get the last measured ping value.
The ping is measured between client and a ping site that corresponds to the server
◆ HasBattlEye()
| proto native bool Room.HasBattlEye | ( | ) |
◆ HostAddress()
| proto native string Room.HostAddress | ( | ) |
◆ HostScenario()
| proto native MissionWorkshopItem Room.HostScenario | ( | ) |
◆ HostScenarioMod()
| proto native Dependency Room.HostScenarioMod | ( | ) |
Addon that contains the hosted scenario.
◆ HostType()
| proto native string Room.HostType | ( | ) |
Specifies type of server.
Check backend documentation for specific values.
◆ IsAuthorized()
| proto native bool Room.IsAuthorized | ( | ) |
Was the password verified and may the client join the server or view its content.
◆ IsClientReady()
| proto native bool Room.IsClientReady | ( | ) |
Are client's mods the same as in this room?
◆ IsCrossPlatform()
| proto native bool Room.IsCrossPlatform | ( | ) |
◆ IsDownloadListLoaded()
| proto native bool Room.IsDownloadListLoaded | ( | ) |
Is the list of hosted addons ready or should we load it (LoadDownloadList)
◆ IsFavorite()
| proto native bool Room.IsFavorite | ( | ) |
◆ IsModded()
| proto native bool Room.IsModded | ( | ) |
◆ Join()
| proto native void Room.Join | ( | BackendCallback | callback, |
| JsonApiStruct | params | ||
| ) |
◆ Joinable()
| proto native bool Room.Joinable | ( | ) |
Returns false if the server is not ready to receive players (e.g.
is restarting / has some network issues / just crashed etc.)
◆ LoadDownloadList()
| proto native void Room.LoadDownloadList | ( | BackendCallback | callback | ) |
Load informations about hosted addons.
User has to be authorized first.
◆ Name()
| proto native string Room.Name | ( | ) |
◆ Official()
| proto native bool Room.Official | ( | ) |
Returns true for official dedicated server and false for community servers.
◆ OwnerName()
| proto native string Room.OwnerName | ( | ) |
BI-account name of the server owner (if known)
◆ PasswordProtected()
| proto native bool Room.PasswordProtected | ( | ) |
Does the server require a password to join.
◆ PlayerCount()
| proto native int Room.PlayerCount | ( | ) |
◆ PlayerLimit()
| proto native int Room.PlayerLimit | ( | ) |
◆ Region()
| proto native string Room.Region | ( | ) |
◆ ScenarioName()
| proto native string Room.ScenarioName | ( | ) |
◆ SetFavorite()
| proto native void Room.SetFavorite | ( | bool | favorite, |
| BackendCallback | callback | ||
| ) |
◆ VerifyPassword()
| proto native void Room.VerifyPassword | ( | string | password, |
| BackendCallback | callback | ||
| ) |
Check if the server is matching.
The documentation for this interface was generated from the following file:
- GameLib/online/serverBrowser.c
