Interface IPhoenixClientManager<TClient>

An interface that manages connections to a game instance via Phoenix.

Inherited Members
Namespace: Phoenix.ClientManager
Assembly: Phoenix.ClientManager.dll
Syntax
public interface IPhoenixClientManager<TClient> : IClientManager<IDevice, TClient>, IClientManager<IDevice>, ICanDisconnect<IDevice>, IHoldsBaggage<IDevice> where TClient : class, IGameConnect
Type Parameters
Name Description
TClient

The type of client used to connect to a game instance.

Properties

View Source

ConnectionStatus

Gets the Phoenix.Controls.GameConnection.GameConnectionStatus of the client on the current device.

Declaration
GameConnectionStatus ConnectionStatus { get; }
Property Value
Type Description
GameConnectionStatus
View Source

Current

Gets the active client that is associated with the current device.

Declaration
TClient? Current { get; }
Property Value
Type Description
TClient
View Source

CurrentDevice

Gets the current device selected by user. Null if no device is selected.

Declaration
IDevice? CurrentDevice { get; }
Property Value
Type Description
IDevice
View Source

IsConnected

Gets a value indicating whether a client is connected to the current device or not.

Declaration
bool IsConnected { get; }
Property Value
Type Description
bool

Methods

View Source

OptionsFor(IDevice)

Gets the connection options for a specific device.

Declaration
object OptionsFor(IDevice device)
Parameters
Type Name Description
IDevice device

The device to get the options for.
Returns
Type Description
object

The connection options.
View Source

SetOptionsFor(IDevice, object)

Sets the options for a given device.

Declaration
void SetOptionsFor(IDevice device, object options)
Parameters
Type Name Description
IDevice device

The device to set options for.
object options

The options to set.

Events

View Source

OnCurrentClientChanged

Event triggered when the current active client changes.

Declaration
event EventHandler? OnCurrentClientChanged
Event Type
Type Description
EventHandler