Photon Quantum 2.1.1

Public Member Functions | Public Attributes | Properties | List of all members
Photon.Deterministic.DeterministicPlugin Class Reference

Override the Quantum plugin class to create a custom server object. More...

Inherits PluginBase, and IHost.

Public Member Functions

 DeterministicPlugin ()
 Create a DeterministicPlugin instance which creates a new instance of Server.DeterministicServer More...
 
 DeterministicPlugin (IServer server)
 Create a DeterministicPlugin instance passing in a server object. More...
 
void Disconnect (int actorNr, string message)
 Removed the actor from the plugin host. Is automatically called when the DeterministicServer is closed. More...
 
void LogError (string message)
 Directs log to PluginHost. More...
 
void LogException (Exception exn)
 Directs log to PluginHost. More...
 
void LogFatal (string message)
 Directs log to PluginHost. More...
 
void LogInfo (string message)
 Directs log to PluginHost. More...
 
void LogWarning (string message)
 Directs log to PluginHost. More...
 

Public Attributes

string GameId => PluginHost == null ? string.Empty : PluginHost.GameId
 Returns the room name. More...
 

Properties

int EmptyRoomTTL [get]
 Retrieve the EmptyRoomTTL value from GameProperties, return 0 when nothing was found. More...
 
override string Name [get]
 Plugin name. This will correspond with the plugin name that the client selects when connecting to a room. More...
 
IServer Server [get]
 Server object that the plugin needs as an entry to call rudimentary callbacks. More...
 

Detailed Description

Override the Quantum plugin class to create a custom server object.

Constructor & Destructor Documentation

◆ DeterministicPlugin() [1/2]

Photon.Deterministic.DeterministicPlugin.DeterministicPlugin ( )
inline

Create a DeterministicPlugin instance which creates a new instance of Server.DeterministicServer

◆ DeterministicPlugin() [2/2]

Photon.Deterministic.DeterministicPlugin.DeterministicPlugin ( IServer  server)
inline

Create a DeterministicPlugin instance passing in a server object.

Parameters
serverServer object of type Server.DeterministicServer

Member Function Documentation

◆ LogInfo()

void Photon.Deterministic.DeterministicPlugin.LogInfo ( string  message)
inline

Directs log to PluginHost.

◆ LogFatal()

void Photon.Deterministic.DeterministicPlugin.LogFatal ( string  message)
inline

Directs log to PluginHost.

◆ LogWarning()

void Photon.Deterministic.DeterministicPlugin.LogWarning ( string  message)
inline

Directs log to PluginHost.

◆ LogError()

void Photon.Deterministic.DeterministicPlugin.LogError ( string  message)
inline

Directs log to PluginHost.

◆ LogException()

void Photon.Deterministic.DeterministicPlugin.LogException ( Exception  exn)
inline

Directs log to PluginHost.

◆ Disconnect()

void Photon.Deterministic.DeterministicPlugin.Disconnect ( int  actorNr,
string  message 
)
inline

Removed the actor from the plugin host. Is automatically called when the DeterministicServer is closed.

Parameters
actorNrActor Number from DeterministicPluginClient.ActorNr
messageDisconnect message

Member Data Documentation

◆ GameId

string Photon.Deterministic.DeterministicPlugin.GameId => PluginHost == null ? string.Empty : PluginHost.GameId

Returns the room name.

Property Documentation

◆ Server

IServer Photon.Deterministic.DeterministicPlugin.Server
get

Server object that the plugin needs as an entry to call rudimentary callbacks.

◆ Name

override string Photon.Deterministic.DeterministicPlugin.Name
get

Plugin name. This will correspond with the plugin name that the client selects when connecting to a room.

RoomOptions roomOptions = new RoomOptions {
Plugins = new string[] { "QuantumPlugin" }
};

◆ EmptyRoomTTL

int Photon.Deterministic.DeterministicPlugin.EmptyRoomTTL
get

Retrieve the EmptyRoomTTL value from GameProperties, return 0 when nothing was found.