rtp::client::scenes::PauseScene Class Reference

Scene for the pause menu. More...

#include <PauseScene.hpp>

Inheritance diagram for rtp::client::scenes::PauseScene:

Collaboration diagram for rtp::client::scenes::PauseScene:

Public Types
using	ChangeStateFn = std::function< void(GameState)>
	Type alias for a function that changes the game state.

Public Member Functions
	PauseScene (ecs::Registry &UiRegistry, Settings &settings, TranslationManager &translationManager, NetworkSyncSystem &network, graphics::UiFactory &uiFactory, std::function< void(GameState)> changeState)
	Constructor for PauseScene.
void	onEnter (void) override
	Called when the scene is entered.
void	onExit (void) override
	Called when the scene is exited.
void	handleEvent (const sf::Event &event) override
	Handle an incoming event.
void	update (float dt) override
	Update the scene state.
Public Member Functions inherited from rtp::client::interfaces::IScene
virtual	~IScene (void)=default

Private Attributes
ecs::Registry &	_uiRegistry
	Reference to the ECS registry.
Settings &	_settings
	Reference to the application settings.
TranslationManager &	_translationManager
	Reference to the translation manager.
NetworkSyncSystem &	_network
	Reference to the client network.
graphics::UiFactory &	_uiFactory
	UI Factory for creating UI components.
ChangeStateFn	_changeState
	Function to change the game state.

Detailed Description

Scene for the pause menu.

This scene is displayed when the game is paused. It provides options to resume the game, access settings, or return to the main menu.

Definition at line 31 of file PauseScene.hpp.

Member Typedef Documentation

ChangeStateFn

using rtp::client::scenes::PauseScene::ChangeStateFn = std::function<void(GameState)>

Type alias for a function that changes the game state.

Definition at line 51 of file PauseScene.hpp.

Constructor & Destructor Documentation

PauseScene()

rtp::client::scenes::PauseScene::PauseScene	(	ecs::Registry &	UiRegistry,
		Settings &	settings,
		TranslationManager &	translationManager,
		NetworkSyncSystem &	network,
		graphics::UiFactory &	uiFactory,
		std::function< void(GameState)>	changeState
	)

Constructor for PauseScene.

Parameters

registry	Reference to the ECS registry
settings	Reference to the application settings
network	Reference to the client network
window	Reference to the SFML render window

Definition at line 17 of file PauseScene.cpp.

Member Function Documentation

handleEvent()

void rtp::client::scenes::PauseScene::handleEvent ( const sf::Event &  event )

overridevirtual

Handle an incoming event.

Parameters

event

The event to handle.

Implements rtp::client::interfaces::IScene.

Definition at line 73 of file PauseScene.cpp.

References _changeState, and rtp::client::Playing.

onEnter()

void rtp::client::scenes::PauseScene::onEnter ( void  )

overridevirtual

Called when the scene is entered.

Implements rtp::client::interfaces::IScene.

Definition at line 32 of file PauseScene.cpp.

References _changeState, _network, _translationManager, _uiFactory, _uiRegistry, rtp::client::graphics::UiFactory::createButton(), rtp::client::graphics::UiFactory::createText(), rtp::client::TranslationManager::get(), rtp::log::info(), rtp::client::Menu, rtp::client::Playing, and rtp::client::NetworkSyncSystem::tryLeaveRoom().

onExit()

void rtp::client::scenes::PauseScene::onExit ( void  )

overridevirtual

Called when the scene is exited.

Implements rtp::client::interfaces::IScene.

Definition at line 68 of file PauseScene.cpp.

References rtp::log::info().

update()

void rtp::client::scenes::PauseScene::update ( float  dt )

overridevirtual

Update the scene state.

Parameters

dt	Time delta since the last update.

Implements rtp::client::interfaces::IScene.

Definition at line 82 of file PauseScene.cpp.

Member Data Documentation

_changeState

ChangeStateFn rtp::client::scenes::PauseScene::_changeState

private

Function to change the game state.

Definition at line 81 of file PauseScene.hpp.

Referenced by handleEvent(), and onEnter().

_network

NetworkSyncSystem& rtp::client::scenes::PauseScene::_network

private

Reference to the client network.

Definition at line 79 of file PauseScene.hpp.

Referenced by onEnter().

_settings

Settings& rtp::client::scenes::PauseScene::_settings

private

Reference to the application settings.

Definition at line 77 of file PauseScene.hpp.

_translationManager

TranslationManager& rtp::client::scenes::PauseScene::_translationManager

private

Reference to the translation manager.

Definition at line 78 of file PauseScene.hpp.

Referenced by onEnter().

_uiFactory

graphics::UiFactory& rtp::client::scenes::PauseScene::_uiFactory

private

UI Factory for creating UI components.

Definition at line 80 of file PauseScene.hpp.

Referenced by onEnter().

_uiRegistry

ecs::Registry& rtp::client::scenes::PauseScene::_uiRegistry

private

Reference to the ECS registry.

Definition at line 76 of file PauseScene.hpp.

Referenced by onEnter().

---

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

• client/include/Scenes/PauseScene.hpp
• client/src/Scenes/PauseScene.cpp