PauseToken Class Reference

#include <engine.h>

Public Member Functions
	PauseToken (const PauseToken &)
void	operator= (const PauseToken &)
void	clear ()
bool	isActive () const

Friends
class	Engine

Detailed Description

Class for managing pausing by Engine::pauseEngine that hands out pause tokens.

Each token represents one requested level of pause.

Constructor & Destructor Documentation

PauseToken()

PauseToken::PauseToken

(

const PauseToken &

)

Construct a pause token.

Member Function Documentation

operator=()

void PauseToken::operator=

(

const PauseToken &

)

Assign the pause token.

clear()

void PauseToken::clear

(

)

Manually release the PauseToken.

Only allowed if the token currently represents a pause request.

isActive()

bool PauseToken::isActive ( ) const

inline

Return true if the PauseToken represents a pause level, false if it is empty.

Friends And Related Function Documentation

Engine

friend class Engine

friend

See also

Engine

---

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

• engines/engine.h