Mirror::Cloud::ListServerService::ListServerServerApi
Inherits from ListServerBaseApi, IListServerServerApi, BaseApi, IBaseApi
Public Functions
Name | |
---|---|
ListServerServerApi(ICoroutineRunner runner, IRequestCreator requestCreator) | |
void | Shutdown() Cleans up any data created by the instance |
void | AddServer(ServerJson server) Add a server to the list |
void | UpdateServer(int newPlayerCount) Update the current server |
void | UpdateServer(ServerJson server) Update the current server |
void | RemoveServer() Removes the current server |
Public Attributes
Name | |
---|---|
bool | ServerInList |
Additional inherited members
Protected Functions inherited from ListServerBaseApi
Name | |
---|---|
ListServerBaseApi(ICoroutineRunner runner, IRequestCreator requestCreator) |
Protected Functions inherited from BaseApi
Name | |
---|---|
BaseApi(ICoroutineRunner runner, IRequestCreator requestCreator) |
Protected Attributes inherited from BaseApi
Name | |
---|---|
readonly ICoroutineRunner | runner |
readonly IRequestCreator | requestCreator |
Public Functions Documentation
function ListServerServerApi
inline ListServerServerApi(
ICoroutineRunner runner,
IRequestCreator requestCreator
)
function Shutdown
inline void Shutdown()
Cleans up any data created by the instance
Reimplements: Mirror::Cloud::IBaseApi::Shutdown
For Example: removing server from list
function AddServer
inline void AddServer(
ServerJson server
)
Add a server to the list
Parameters:
- server
Reimplements: Mirror::Cloud::ListServerService::IListServerServerApi::AddServer
function UpdateServer
inline void UpdateServer(
int newPlayerCount
)
Update the current server
Parameters:
- newPlayerCount
Reimplements: Mirror::Cloud::ListServerService::IListServerServerApi::UpdateServer
function UpdateServer
inline void UpdateServer(
ServerJson server
)
Update the current server
Parameters:
- server
Reimplements: Mirror::Cloud::ListServerService::IListServerServerApi::UpdateServer
function RemoveServer
inline void RemoveServer()
Removes the current server
Reimplements: Mirror::Cloud::ListServerService::IListServerServerApi::RemoveServer
Public Attributes Documentation
variable ServerInList
bool ServerInList => added;
Updated on 18 January 2021 at 09:53:55 UTC