Forge.Networking.Pausing.PauseManager Class Reference

API for interacting with the pausing subsystem. More...

Public Member Functions
	PauseManager (NetworkContext context)
	Create a new PauseManager instance. More...
void	Dispose ()
	Cleans up resources that the PauseManager uses in the NetworkContext. More...

Properties
bool	IsPaused [get, set]
	Returns the current pause status for the game. Setting this value emits a network message that changes the pause status to the given value for all computers in the network. More...
Maybe< Player >	PausedBy [get]
	If the game is paused, then this returns who paused the game. If the game is not paused, then this returns nothing. More...

Detailed Description

API for interacting with the pausing subsystem.

Constructor & Destructor Documentation

Forge.Networking.Pausing.PauseManager.PauseManager

(

NetworkContext

context

)

Create a new PauseManager instance.

Parameters

context

The networking context to use.

Member Function Documentation

void Forge.Networking.Pausing.PauseManager.Dispose

(

)

Cleans up resources that the PauseManager uses in the NetworkContext.

Property Documentation

bool Forge.Networking.Pausing.PauseManager.IsPaused

getset

Returns the current pause status for the game. Setting this value emits a network message that changes the pause status to the given value for all computers in the network.

Maybe<Player> Forge.Networking.Pausing.PauseManager.PausedBy

get

If the game is paused, then this returns who paused the game. If the game is not paused, then this returns nothing.

---

The documentation for this class was generated from the following file:

• Forge.Networking/Pausing/PauseManager.cs