A Room that supports the following requests:

JoinGameRequest
RaiseEventRequest
SetPropertiesRequest
GetPropertiesRequest
LeaveRequest

Inheritance diagram for Photon.Hive.HiveGame:

Public Member Functions
	HiveGame (string gameName, RoomCacheBase roomCache, IGameStateFactory gameStateFactory=null, int maxEmptyRoomTTL=0, int lastTouchLimitMilliseconds=0, int lastTouchCheckIntervalMilliseconds=0, ExtendedPoolFiber executionFiber=null)
	Initializes a new instance of the HiveGame class. More...

override string	ToString ()

bool	CheckBeforeJoinThisIsNewCreatedRoom (JoinGameRequest request)

bool	CheckAfterJoinThisIsNewCreatedRoom (bool isNewActor)

virtual void	RemoveInactiveActor (Actor actor)

void	PublishEventDiconnected (Actor actor, int? newMasterClientId)

void	OnActorRemoved (Actor actor)

void	OnActorDeactivated (Actor actor)

Public Member Functions inherited from Photon.Hive.Room
	Room (string name, RoomCacheBase roomCache=null, IGameStateFactory gameStateFactory=null, int maxEmptyRoomTTL=0, ExtendedPoolFiber executionFiber=null)
	Initializes a new instance of the Room class without a room name. More...

override string	ToString ()

virtual bool	BeforeRemoveFromCache ()
	Called by the RoomCacheBase if the room is about to be removed from the cache. More...

void	EnqueueMessage (IMessage message)
	Enqueues an IMessage to the end of the execution queue. More...

void	EnqueueOperation (HivePeer peer, OperationRequest operationRequest, SendParameters sendParameters)
	Enqueues an OperationRequest to the end of the execution queue. More...

IDisposable	ScheduleMessage (IMessage message, long timeMs)
	Schedules a message to be processed after a specified time. More...

void	Dispose ()
	Releases resources used by this instance. More...

virtual void	OnClose ()

void	Release ()

Protected Member Functions
virtual void	CleanupActor (Actor actor)

virtual void	DeactivateActor (Actor actor)

bool	CreateGame (HivePeer peer, JoinGameRequest request, SendParameters sendParameters)

override void	ExecuteOperation (HivePeer peer, OperationRequest operationRequest, SendParameters sendParameters)
	Called for each operation in the execution queue. Every Room has a queue of incoming operations to execute. Per game ExecuteOperation is never executed multi-threaded, thus all code executed here has thread safe access to all instance members. More...

Actor	GetActorByPeer (HivePeer peer)
	Gets the actor for a HivePeer. More...

Hashtable	GetLobbyGameProperties (Hashtable source)

Hashtable	GetLobbyGameProperties (Hashtable source, HashSet< object > list)

virtual void	HandleChangeGroupsOperation (HivePeer peer, ChangeGroups changeGroupsRequest, SendParameters sendParameters)

bool	UpdateCacheSlice (HivePeer peer, byte op, int? sliceIndex, ref string message)

virtual void	HandleCreateGameOperation (HivePeer peer, SendParameters sendParameters, CreateGameRequest createGameRequest)

virtual void	HandleDebugGameOperation (HivePeer peer, DebugGameRequest request, SendParameters sendParameters)

virtual void	HandleGetPropertiesOperation (HivePeer peer, GetPropertiesRequest getPropertiesRequest, SendParameters sendParameters)
	Handles the GetPropertiesRequest operation: Sends the properties with the OperationResponse. More...

virtual void	HandleJoinGameOperation (HivePeer peer, SendParameters sendParameters, JoinGameRequest joinGameRequest)
	Handles the JoinGameRequest: Joins a peer to a room and calls PublishJoinEvent. Before a JoinOperation reaches this point (inside a room), the HivePeer made sure that it is removed from the previous Room (if there was any). More...

virtual void	HandleLeaveOperation (HivePeer peer, SendParameters sendParameters, LeaveRequest leaveOperation)
	Handles the LeaveRequest and calls RemovePeerFromGame. More...

virtual void	HandleRaiseEventOperation (HivePeer peer, RaiseEventRequest raiseEventRequest, SendParameters sendParameters)
	Handles the RaiseEventRequest: Sends a CustomEvent to actors in the room. More...

virtual void	HandleRemovePeerMessage (HivePeer peer, int reason, string details)

virtual void	HandleSetPropertiesOperation (HivePeer peer, SetPropertiesRequest request, SendParameters sendParameters)
	Handles the SetPropertiesRequest and sends event PropertiesChangedEvent to all Actors in the room. More...

bool	Join (HivePeer peer, JoinGameRequest joinRequest, SendParameters sendParameters)

virtual void	JoinFailureHandler (byte leaveReason, HivePeer peer, JoinGameRequest request)

bool	JoinApplyGameStateChanges (HivePeer peer, JoinGameRequest joinRequest, SendParameters sendParameters, out Actor actor)

virtual void	SendErrorResponse (HivePeer peer, byte opCode, ErrorCode errorCode, string msg, SendParameters sendParameters, Dictionary< byte, object > errorData=null)

virtual bool	AddExpectedUsers (JoinGameRequest joinRequest)

bool	JoinSendResponseAndEvents (HivePeer peer, JoinGameRequest joinRequest, SendParameters sendParameters, int actorNr, ProcessJoinParams prms)

virtual OperationResponse	GetUserJoinResponse (JoinGameRequest joinRequest, int actorNr, ProcessJoinParams prms)

void	LeaveOperationHandler (HivePeer peer, SendParameters sendParameters, LeaveRequest request)

void	LogOperation (HivePeer peer, OperationRequest operationRequest)

override void	ProcessMessage (IMessage message)
	Processes a game message. Messages are used for internal communication. Per default only message RemovePeerFromGame is handled, a message that is sent when a player leaves a game due to disconnect or due to a subsequent join to a different game. More...

void	PublishEventCache (HivePeer litePeer, JoinGameRequest joinRequest)
	Sends all cached events to a peer. More...

virtual void	PublishJoinEvent (HivePeer peer, JoinGameRequest joinRequest)
	Sends a JoinEvent to all Actors. More...

virtual void	PublishLeaveEvent (Actor actor, int? newMasterClientId)
	Sends a LeaveEvent to all Actors. More...

bool	RaiseEventOperationHandler (HivePeer peer, RaiseEventRequest raiseEventRequest, SendParameters sendParameters, Actor actor)

virtual int	RemovePeerFromGame (HivePeer peer, bool isCommingBack)
	Removes a peer from the game. This method is called if a client sends a LeaveRequest or disconnects. More...

bool	SetPropertiesRequestHandler (HivePeer peer, SetPropertiesRequest request, SendParameters sendParameters)

void	RevertProperties (IDictionary oldPropertyValues, SetPropertiesRequest request)

Hashtable	GetOldPropertyValues (SetPropertiesRequest request)

bool	ValidateAndFillSetPropertiesRequest (HivePeer peer, SetPropertiesRequest request, out string errorMsg)

virtual void	OnGamePropertiesChanged (SetPropertiesRequest request)

void	PublishResultsAndSetGameProperties (bool propertiesUpdateResult, string errorMessage, SetPropertiesRequest request, HivePeer peer, SendParameters sendParameters)

virtual bool	SetNewPropertyValues (SetPropertiesRequest request, out string errorMessage)

virtual bool	TryAddPeerToGame (HivePeer peer, int actorNr, out Actor actor, out bool isNewActor, out ErrorCode errorcode, out string reason, JoinGameRequest joinRequest)
	Tries to add a HivePeer to this game instance. More...

bool	UpdateEventCache (Actor actor, RaiseEventRequest raiseEventRequest, out string msg)
	Helper method of HandleRaiseEventOperation. Stores an event for new actors. More...

bool	UpdateEventCache (Actor actor, byte eventCode, object data, byte cacheOp, out string msg)

bool	UpdateEventCache (Actor actor, byte evCode, object data, CacheOperation cacheOp, ref string msg)

bool	ValidateGame (HivePeer peer, JoinGameRequest joinGameRequest, SendParameters sendParameters)

Protected Member Functions inherited from Photon.Hive.Room
	Room (string name, ExtendedPoolFiber executionFiber, RoomCacheBase roomCache, IGameStateFactory gameStateFactory=null, int maxEmptyRoomTTL=0)
	Initializes a new instance of the Room class. More...

virtual void	Dispose (bool dispose)
	Releases unmanaged and - optionally - managed resources More...

void	PublishEvent (HiveEventBase e, Actor actor, SendParameters sendParameters)
	Publishes an event to a single actor on a specified channel. More...

void	PublishEvent (HiveEventBase e, IEnumerable< Actor > actorList, SendParameters sendParameters)
	Publishes an event to a list of actors on a specified channel. More...

void	PublishEvent (EventData e, IEnumerable< Actor > actorList, SendParameters sendParameters)
	Publishes an event to a list of actors on a specified channel. More...

void	ScheduleRoomRemoval (int roomLiveTime)
	Schedules the removal of the room instance from the cache. The room will be removed after the specified time if there are no room references left. More...

void	TryRemoveRoomFromCache ()
	Removes the room instance from the cache if there are no references to the instance left. More...

Protected Attributes
readonly LogQueue	LogQueue

readonly int	LastTouchLimitMilliseconds

readonly int	LastTouchCheckIntervalMilliseconds

IHiveGameAppCounters	gameAppCounters = NullHiveGameAppCounters.Instance

Protected Attributes inherited from Photon.Hive.Room
readonly RoomCacheBase	roomCache

readonly IGameStateFactory	gameStateFactory

string	RemoveRoomPathString

GameState	roomState

Properties
IHiveGameAppCounters	GameAppCounters `[get, set]`

int	MasterClientId `[get]`

virtual bool	IsPersistent `[get]`

IEnumerable< Actor >	InactiveActors `[get]`

IEnumerable< Actor >	Actors `[get]`

bool	PublishUserId `[get, set]`

bool	IsOpen `[get, set]`

bool	IsVisible `[get, set]`

string	LobbyId `[get, set]`

bool	DeleteCacheOnLeave `[get, set]`
	Gets or sets a value indicating whether cached events are automaticly deleted for actors which are leaving a room. More...

HashSet< object >	LobbyProperties `[get, set]`
	Contains the keys of the game properties hashtable which should be listet in the lobby. More...

AppLobbyType	LobbyType `[get, set]`

byte	MaxPlayers `[get, set]`

int	PlayerTTL `[get, set]`
	Player live time More...

bool	SuppressRoomEvents `[get, set]`
	Gets or sets a value indicating if common room events (Join, Leave) will suppressed. More...

RoomEventCacheManager	EventCache `[get]`

EventCacheDictionary	ActorEventCache `[get]`
	Contains Caching.EventCaches for all actors. More...

GroupManager	GroupManager `[get]`

ActorsManager	ActorsManager `[get]`

GameState	RoomState `[get]`

bool	CheckUserOnJoin `[get, set]`

Properties inherited from Photon.Hive.Room
RemoveState	RemoveRoomPath `[get, set]`

ExtendedPoolFiber	ExecutionFiber `[get]`
	Gets a PoolFiber instance used to synchronize access to this instance. More...

bool	IsDisposed `[get]`
	Gets a value indicating whether IsDisposed. More...

string	Name `[get]`
	Gets the name (id) of the room. More...

int	EmptyRoomLiveTime `[get, protected set]`
	Gets or sets a value indicating how long the room instance will be keeped alive in the room cache after all peers have left the room. More...

int	MaxEmptyRoomTTL `[get]`

IDisposable	RemoveTimer `[get, set]`
	Timer for removing room More...

PropertyBag< object >	Properties `[get]`
	Gets a PropertyBag instance used to store custom room properties. More...

Additional Inherited Members
Protected Types inherited from Photon.Hive.Room
enum	RemoveState { RemoveState.Alive, RemoveState.TryRemoveRoomFromCacheCalled, RemoveState.RoomRemoved, RemoveState.TryRemoveRoomFromCacheCalledRoomNotRemoved, RemoveState.ProcessCloseGameCalled, RemoveState.TriggerPluginOnCloseCalled, RemoveState.AliveGotNewPlayer, RemoveState.ScheduleTriggerPluginOnCloseCalled, RemoveState.ProcessBeforeCloseGameCalled, RemoveState.ProcessBeforeCloseGameCalledEmptyRoomLiveTimeLECalled, RemoveState.BeforeRemoveFromCacheCalled, RemoveState.BeforeRemoveFromCacheActionCalled, RemoveState.GameDisposeCalled }

Detailed Description

A Room that supports the following requests:

JoinGameRequest
RaiseEventRequest
SetPropertiesRequest
GetPropertiesRequest
LeaveRequest

Constructor & Destructor Documentation

◆ HiveGame()

Photon.Hive.HiveGame.HiveGame	(	string	gameName,
		RoomCacheBase	roomCache,
		IGameStateFactory	gameStateFactory = `null`,
		int	maxEmptyRoomTTL = `0`,
		int	lastTouchLimitMilliseconds = `0`,
		int	lastTouchCheckIntervalMilliseconds = `0`,
		ExtendedPoolFiber	executionFiber = `null`
	)

inline

Initializes a new instance of the HiveGame class.

Parameters

gameName	The name of the game.
roomCache	The RoomCacheBase instance to which the room belongs.
gameStateFactory	Custom factory for GameState. if null is set, default factory is used
maxEmptyRoomTTL	A value indicating how long the room instance will be kept alive in the room cache after all peers have left the room.
lastTouchLimitMilliseconds	Specifies to maximum value for a peers GetLastTouch in milliseconds before a peer will removed from the room. If set to zero no check will bew performed.
lastTouchCheckIntervalMilliseconds	Specifies the in interval in milliseconds to check peer in the room for the GetLastTouched value. If set to zero no check will be performed.
executionFiber

Member Function Documentation

◆ AddExpectedUsers()

virtual bool Photon.Hive.HiveGame.AddExpectedUsers ( JoinGameRequest joinRequest )

inlineprotectedvirtual

◆ CheckAfterJoinThisIsNewCreatedRoom()

bool Photon.Hive.HiveGame.CheckAfterJoinThisIsNewCreatedRoom ( bool isNewActor )

inline

◆ CheckBeforeJoinThisIsNewCreatedRoom()

bool Photon.Hive.HiveGame.CheckBeforeJoinThisIsNewCreatedRoom ( JoinGameRequest request )

inline

◆ CleanupActor()

virtual void Photon.Hive.HiveGame.CleanupActor ( Actor actor )

inlineprotectedvirtual

Reimplemented in Photon.LoadBalancing.GameServer.Game, and Photon.Hive.Tests.TestGame.

◆ CreateGame()

bool Photon.Hive.HiveGame.CreateGame	(	HivePeer	peer,
		JoinGameRequest	request,
		SendParameters	sendParameters
	)

inlineprotected

◆ DeactivateActor()

virtual void Photon.Hive.HiveGame.DeactivateActor ( Actor actor )

inlineprotectedvirtual

Reimplemented in Photon.LoadBalancing.GameServer.Game.

◆ ExecuteOperation()

override void Photon.Hive.HiveGame.ExecuteOperation	(	HivePeer	peer,
		OperationRequest	operationRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Called for each operation in the execution queue. Every Room has a queue of incoming operations to execute. Per game ExecuteOperation is never executed multi-threaded, thus all code executed here has thread safe access to all instance members.

Parameters

peer	The peer.
operationRequest	The operation request to execute.
sendParameters	The send Parameters.

Reimplemented from Photon.Hive.Room.

◆ GetActorByPeer()

Actor Photon.Hive.HiveGame.GetActorByPeer ( HivePeer peer )

inlineprotected

Gets the actor for a HivePeer.

Parameters

peer The peer.

Returns: The actor for the peer or null if no actor for the peer exists (this should not happen).

◆ GetLobbyGameProperties() [1/2]

Hashtable Photon.Hive.HiveGame.GetLobbyGameProperties ( Hashtable source )

inlineprotected

◆ GetLobbyGameProperties() [2/2]

Hashtable Photon.Hive.HiveGame.GetLobbyGameProperties	(	Hashtable	source,
		HashSet< object >	list
	)

inlineprotected

◆ GetOldPropertyValues()

Hashtable Photon.Hive.HiveGame.GetOldPropertyValues ( SetPropertiesRequest request )

inlineprotected

◆ GetUserJoinResponse()

virtual OperationResponse Photon.Hive.HiveGame.GetUserJoinResponse	(	JoinGameRequest	joinRequest,
		int	actorNr,
		ProcessJoinParams	prms
	)

inlineprotectedvirtual

Reimplemented in Photon.Hive.HiveHostGame.

◆ HandleChangeGroupsOperation()

virtual void Photon.Hive.HiveGame.HandleChangeGroupsOperation	(	HivePeer	peer,
		ChangeGroups	changeGroupsRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

◆ HandleCreateGameOperation()

virtual void Photon.Hive.HiveGame.HandleCreateGameOperation	(	HivePeer	peer,
		SendParameters	sendParameters,
		CreateGameRequest	createGameRequest
	)

inlineprotectedvirtual

Reimplemented in Photon.Hive.HiveHostGame.

◆ HandleDebugGameOperation()

virtual void Photon.Hive.HiveGame.HandleDebugGameOperation	(	HivePeer	peer,
		DebugGameRequest	request,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

◆ HandleGetPropertiesOperation()

virtual void Photon.Hive.HiveGame.HandleGetPropertiesOperation	(	HivePeer	peer,
		GetPropertiesRequest	getPropertiesRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Handles the GetPropertiesRequest operation: Sends the properties with the OperationResponse.

Parameters

peer	The peer.
getPropertiesRequest	The operation to handle.
sendParameters	The send Parameters.

◆ HandleJoinGameOperation()

virtual void Photon.Hive.HiveGame.HandleJoinGameOperation	(	HivePeer	peer,
		SendParameters	sendParameters,
		JoinGameRequest	joinGameRequest
	)

inlineprotectedvirtual

Handles the JoinGameRequest: Joins a peer to a room and calls PublishJoinEvent. Before a JoinOperation reaches this point (inside a room), the HivePeer made sure that it is removed from the previous Room (if there was any).

Parameters

peer	The peer.
sendParameters	The send Parameters.
joinGameRequest	The join Game Request.

Reimplemented in Photon.Hive.HiveHostGame.

◆ HandleLeaveOperation()

virtual void Photon.Hive.HiveGame.HandleLeaveOperation	(	HivePeer	peer,
		SendParameters	sendParameters,
		LeaveRequest	leaveOperation
	)

inlineprotectedvirtual

Handles the LeaveRequest and calls RemovePeerFromGame.

Parameters

peer	The peer.
sendParameters	The send Parameters.
leaveOperation	The operation.

Reimplemented in Photon.Hive.HiveHostGame.

◆ HandleRaiseEventOperation()

virtual void Photon.Hive.HiveGame.HandleRaiseEventOperation	(	HivePeer	peer,
		RaiseEventRequest	raiseEventRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Handles the RaiseEventRequest: Sends a CustomEvent to actors in the room.

Parameters

peer	The peer.
raiseEventRequest	The operation
sendParameters	The send Parameters.

Reimplemented in Photon.Hive.HiveHostGame.

◆ HandleRemovePeerMessage()

virtual void Photon.Hive.HiveGame.HandleRemovePeerMessage	(	HivePeer	peer,
		int	reason,
		string	details
	)

inlineprotectedvirtual

Reimplemented in Photon.Hive.HiveHostGame.

◆ HandleSetPropertiesOperation()

virtual void Photon.Hive.HiveGame.HandleSetPropertiesOperation	(	HivePeer	peer,
		SetPropertiesRequest	request,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Handles the SetPropertiesRequest and sends event PropertiesChangedEvent to all Actors in the room.

Parameters

peer	The peer.
request	The SetPropertiesRequest operation to handle.
sendParameters	The send Parameters.

Reimplemented in Photon.Hive.HiveHostGame.

◆ Join()

bool Photon.Hive.HiveGame.Join	(	HivePeer	peer,
		JoinGameRequest	joinRequest,
		SendParameters	sendParameters
	)

inlineprotected

◆ JoinApplyGameStateChanges()

bool Photon.Hive.HiveGame.JoinApplyGameStateChanges	(	HivePeer	peer,
		JoinGameRequest	joinRequest,
		SendParameters	sendParameters,
		out Actor	actor
	)

inlineprotected

◆ JoinFailureHandler()

virtual void Photon.Hive.HiveGame.JoinFailureHandler	(	byte	leaveReason,
		HivePeer	peer,
		JoinGameRequest	request
	)

inlineprotectedvirtual

Reimplemented in Photon.Hive.HiveHostGame, and Photon.LoadBalancing.GameServer.Game.

◆ JoinSendResponseAndEvents()

bool Photon.Hive.HiveGame.JoinSendResponseAndEvents	(	HivePeer	peer,
		JoinGameRequest	joinRequest,
		SendParameters	sendParameters,
		int	actorNr,
		ProcessJoinParams	prms
	)

inlineprotected

◆ LeaveOperationHandler()

void Photon.Hive.HiveGame.LeaveOperationHandler	(	HivePeer	peer,
		SendParameters	sendParameters,
		LeaveRequest	request
	)

inlineprotected

◆ LogOperation()

void Photon.Hive.HiveGame.LogOperation	(	HivePeer	peer,
		OperationRequest	operationRequest
	)

inlineprotected

◆ OnActorDeactivated()

void Photon.Hive.HiveGame.OnActorDeactivated ( Actor actor )

inline

◆ OnActorRemoved()

void Photon.Hive.HiveGame.OnActorRemoved ( Actor actor )

inline

◆ OnGamePropertiesChanged()

virtual void Photon.Hive.HiveGame.OnGamePropertiesChanged ( SetPropertiesRequest request )

inlineprotectedvirtual

Reimplemented in Photon.LoadBalancing.GameServer.Game.

◆ ProcessMessage()

override void Photon.Hive.HiveGame.ProcessMessage ( IMessage message )

inlineprotectedvirtual

Processes a game message. Messages are used for internal communication. Per default only message RemovePeerFromGame is handled, a message that is sent when a player leaves a game due to disconnect or due to a subsequent join to a different game.

Parameters

message Message to process.

Reimplemented from Photon.Hive.Room.

◆ PublishEventCache()

void Photon.Hive.HiveGame.PublishEventCache	(	HivePeer	litePeer,
		JoinGameRequest	joinRequest
	)

inlineprotected

Sends all cached events to a peer.

Parameters

litePeer	The lite peer that receives the events.
joinRequest

◆ PublishEventDiconnected()

void Photon.Hive.HiveGame.PublishEventDiconnected	(	Actor	actor,
		int?	newMasterClientId
	)

inline

◆ PublishJoinEvent()

virtual void Photon.Hive.HiveGame.PublishJoinEvent	(	HivePeer	peer,
		JoinGameRequest	joinRequest
	)

inlineprotectedvirtual

Sends a JoinEvent to all Actors.

Parameters

peer	The peer.
joinRequest	The join request.

◆ PublishLeaveEvent()

virtual void Photon.Hive.HiveGame.PublishLeaveEvent	(	Actor	actor,
		int?	newMasterClientId
	)

inlineprotectedvirtual

Sends a LeaveEvent to all Actors.

Parameters

actor	The actor which sents the event.
newMasterClientId

◆ PublishResultsAndSetGameProperties()

void Photon.Hive.HiveGame.PublishResultsAndSetGameProperties	(	bool	propertiesUpdateResult,
		string	errorMessage,
		SetPropertiesRequest	request,
		HivePeer	peer,
		SendParameters	sendParameters
	)

inlineprotected

◆ RaiseEventOperationHandler()

bool Photon.Hive.HiveGame.RaiseEventOperationHandler	(	HivePeer	peer,
		RaiseEventRequest	raiseEventRequest,
		SendParameters	sendParameters,
		Actor	actor
	)

inlineprotected

◆ RemoveInactiveActor()

virtual void Photon.Hive.HiveGame.RemoveInactiveActor ( Actor actor )

inlinevirtual

Reimplemented in Photon.Hive.HiveHostGame.

◆ RemovePeerFromGame()

virtual int Photon.Hive.HiveGame.RemovePeerFromGame	(	HivePeer	peer,
		bool	isCommingBack
	)

inlineprotectedvirtual

Removes a peer from the game. This method is called if a client sends a LeaveRequest or disconnects.

Parameters

peer	The HivePeer to remove.
isCommingBack	whether we expect peer will come back or not

Returns: The actor number of the removed actor. If the specified peer does not exists -1 will be returned.

◆ RevertProperties()

void Photon.Hive.HiveGame.RevertProperties	(	IDictionary	oldPropertyValues,
		SetPropertiesRequest	request
	)

inlineprotected

◆ SendErrorResponse()

virtual void Photon.Hive.HiveGame.SendErrorResponse	(	HivePeer	peer,
		byte	opCode,
		ErrorCode	errorCode,
		string	msg,
		SendParameters	sendParameters,
		Dictionary< byte, object >	errorData = `null`
	)

inlineprotectedvirtual

◆ SetNewPropertyValues()

virtual bool Photon.Hive.HiveGame.SetNewPropertyValues	(	SetPropertiesRequest	request,
		out string	errorMessage
	)

inlineprotectedvirtual

◆ SetPropertiesRequestHandler()

bool Photon.Hive.HiveGame.SetPropertiesRequestHandler	(	HivePeer	peer,
		SetPropertiesRequest	request,
		SendParameters	sendParameters
	)

inlineprotected

◆ ToString()

override string Photon.Hive.HiveGame.ToString ( )

inline

◆ TryAddPeerToGame()

virtual bool Photon.Hive.HiveGame.TryAddPeerToGame	(	HivePeer	peer,
		int	actorNr,
		out Actor	actor,
		out bool	isNewActor,
		out ErrorCode	errorcode,
		out string	reason,
		JoinGameRequest	joinRequest
	)

inlineprotectedvirtual

Tries to add a HivePeer to this game instance.

Parameters

peer	The peer to add.
actorNr	The actor Nr.
actor	When this method returns this out param contains the Actor associated with the peer .
errorcode	returns error code if we fail to add actor
reason	reason why player can not be added
isNewActor	returns true if actor is new
joinRequest	join request which was sent by client

Returns: Returns true if no actor exists for the specified peer and a new actor for the peer has been successfully added. The actor parameter is set to the newly created Actor instance. Returns false if an actor for the specified peer already exists. The actor parameter is set to the existing Actor for the specified peer.

◆ UpdateCacheSlice()

bool Photon.Hive.HiveGame.UpdateCacheSlice	(	HivePeer	peer,
		byte	op,
		int?	sliceIndex,
		ref string	message
	)

inlineprotected

◆ UpdateEventCache() [1/3]

bool Photon.Hive.HiveGame.UpdateEventCache	(	Actor	actor,
		byte	evCode,
		object	data,
		CacheOperation	cacheOp,
		ref string	msg
	)

inlineprotected

◆ UpdateEventCache() [2/3]

bool Photon.Hive.HiveGame.UpdateEventCache	(	Actor	actor,
		byte	eventCode,
		object	data,
		byte	cacheOp,
		out string	msg
	)

inlineprotected

◆ UpdateEventCache() [3/3]

bool Photon.Hive.HiveGame.UpdateEventCache	(	Actor	actor,
		RaiseEventRequest	raiseEventRequest,
		out string	msg
	)

inlineprotected

Helper method of HandleRaiseEventOperation. Stores an event for new actors.

Parameters

actor	The actor.
raiseEventRequest	The raise event request.
msg	Contains an error message if the method returns false.

Returns: True if RaiseEventRequest.Cache is valid.

◆ ValidateAndFillSetPropertiesRequest()

bool Photon.Hive.HiveGame.ValidateAndFillSetPropertiesRequest	(	HivePeer	peer,
		SetPropertiesRequest	request,
		out string	errorMsg
	)

inlineprotected

◆ ValidateGame()

bool Photon.Hive.HiveGame.ValidateGame	(	HivePeer	peer,
		JoinGameRequest	joinGameRequest,
		SendParameters	sendParameters
	)

inlineprotected

Member Data Documentation

◆ gameAppCounters

IHiveGameAppCounters Photon.Hive.HiveGame.gameAppCounters = NullHiveGameAppCounters.Instance

protected

◆ LastTouchCheckIntervalMilliseconds

readonly int Photon.Hive.HiveGame.LastTouchCheckIntervalMilliseconds

protected

◆ LastTouchLimitMilliseconds

readonly int Photon.Hive.HiveGame.LastTouchLimitMilliseconds

protected

◆ LogQueue

readonly LogQueue Photon.Hive.HiveGame.LogQueue

protected

Property Documentation

◆ ActorEventCache

EventCacheDictionary Photon.Hive.HiveGame.ActorEventCache

get

Contains Caching.EventCaches for all actors.

◆ Actors

IEnumerable<Actor> Photon.Hive.HiveGame.Actors

get

◆ ActorsManager

ActorsManager Photon.Hive.HiveGame.ActorsManager

get

◆ CheckUserOnJoin

bool Photon.Hive.HiveGame.CheckUserOnJoin

getset

◆ DeleteCacheOnLeave

bool Photon.Hive.HiveGame.DeleteCacheOnLeave

◆ LobbyType

AppLobbyType Photon.Hive.HiveGame.LobbyType

getset

◆ MasterClientId

int Photon.Hive.HiveGame.MasterClientId

get

◆ MaxPlayers

byte Photon.Hive.HiveGame.MaxPlayers

getset

◆ PlayerTTL

int Photon.Hive.HiveGame.PlayerTTL

getset

Player live time

◆ PublishUserId

bool Photon.Hive.HiveGame.PublishUserId

getset

◆ RoomState

GameState Photon.Hive.HiveGame.RoomState

get

◆ SuppressRoomEvents

bool Photon.Hive.HiveGame.SuppressRoomEvents

getset

Gets or sets a value indicating if common room events (Join, Leave) will suppressed.

Photon Server API

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HiveGame()

Member Function Documentation

◆ AddExpectedUsers()

◆ CheckAfterJoinThisIsNewCreatedRoom()

◆ CheckBeforeJoinThisIsNewCreatedRoom()

◆ CleanupActor()

◆ CreateGame()

◆ DeactivateActor()

◆ ExecuteOperation()

◆ GetActorByPeer()

◆ GetLobbyGameProperties() [1/2]

◆ GetLobbyGameProperties() [2/2]

◆ GetOldPropertyValues()

◆ GetUserJoinResponse()

◆ HandleChangeGroupsOperation()

◆ HandleCreateGameOperation()

◆ HandleDebugGameOperation()

◆ HandleGetPropertiesOperation()

◆ HandleJoinGameOperation()

◆ HandleLeaveOperation()

◆ HandleRaiseEventOperation()

◆ HandleRemovePeerMessage()

◆ HandleSetPropertiesOperation()

◆ Join()

◆ JoinApplyGameStateChanges()

◆ JoinFailureHandler()

◆ JoinSendResponseAndEvents()

◆ LeaveOperationHandler()

◆ LogOperation()

◆ OnActorDeactivated()

◆ OnActorRemoved()

◆ OnGamePropertiesChanged()

◆ ProcessMessage()

◆ PublishEventCache()

◆ PublishEventDiconnected()

◆ PublishJoinEvent()

◆ PublishLeaveEvent()

◆ PublishResultsAndSetGameProperties()

◆ RaiseEventOperationHandler()

◆ RemoveInactiveActor()

◆ RemovePeerFromGame()

◆ RevertProperties()

◆ SendErrorResponse()

◆ SetNewPropertyValues()

◆ SetPropertiesRequestHandler()

◆ ToString()

◆ TryAddPeerToGame()

◆ UpdateCacheSlice()

◆ UpdateEventCache() [1/3]

◆ UpdateEventCache() [2/3]

◆ UpdateEventCache() [3/3]

◆ ValidateAndFillSetPropertiesRequest()

◆ ValidateGame()

Member Data Documentation

◆ gameAppCounters

◆ LastTouchCheckIntervalMilliseconds

◆ LastTouchLimitMilliseconds

◆ LogQueue

Property Documentation

◆ ActorEventCache

◆ Actors

◆ ActorsManager

◆ CheckUserOnJoin

◆ DeleteCacheOnLeave

◆ EventCache

◆ GameAppCounters

◆ GroupManager

◆ InactiveActors

◆ IsOpen

◆ IsPersistent

◆ IsVisible

◆ LobbyId