The NWN ingame GUI elements. More...

#include <ingame.h>

Collaboration diagram for Engines::NWN::IngameGUI:

[legend]

Public Member Functions
	IngameGUI (Module &module, ::Engines::Console *console=0)

	~IngameGUI ()

uint32	showMain ()
	Show the ingame main menu. More...

void	abortMain ()
	Abort the ingame main menu. More...

void	show ()
	Show the ingame GUI elements. More...

void	hide ()
	Hide the ingame GUI elements. More...

void	addEvent (const Events::Event &event)

void	processEventQueue ()

void	setArea (const Common::UString &area)
	Set the current area. More...

void	updatePartyMember (size_t partyMember, const Creature &creature, bool force=false)
	Update the party member. More...

bool	hasRunningConversation () const
	Do we have a currently running conversation? More...

bool	startConversation (const Common::UString &conv, Creature &pc, Object &obj, bool playHello=true)
	Start a conversation. More...

void	stopConversation ()
	Stop a conversation. More...

Private Member Functions
void	setPortrait (size_t partyMember, const Common::UString &portrait)
	Set the party member's portrait. More...

void	setName (size_t partyMember, const Common::UString &name)
	Set the party member's name. More...

void	setHealth (size_t partyMember, uint32 current, uint32 max)
	Set the party member's health. More...

void	setHealthy (size_t partyMember)
	Set party member to "healthy" (red health bar). More...

void	setSick (size_t partyMember)
	Set party member to "sick" (brown health bar). More...

void	setPoisoned (size_t partyMember)
	Set party member to "poisoned" (green health bar). More...

Private Attributes
Module *	_module

Common::ScopedPtr< IngameMainMenu >	_main
	The ingame main menu. More...

Common::ScopedPtr< Quickbar >	_quickbar
	The quick bar. More...

Common::ScopedPtr< Quickchat >	_quickchat
	The quick chat. More...

Common::ScopedPtr< Compass >	_compass
	The compass. More...

Common::ScopedPtr< Dialog >	_dialog
	The current dialog. More...

uint32	_lastCompassChange
	The time the compass was changed last. More...

std::vector< uint32 >	_lastPartyMemberChange
	The time that party member was changed last. More...

Common::PtrVector< CharacterInfo >	_party
	The party member character panels. More...

Detailed Description

The NWN ingame GUI elements.

Definition at line 58 of file ingame.h.

Constructor & Destructor Documentation

◆ IngameGUI()

Engines::NWN::IngameGUI::IngameGUI	(	Module &	module,
		::Engines::Console *	console = `0`
	)

Definition at line 44 of file ingame.cpp.

References _compass, _lastPartyMemberChange, _main, _module, _party, _quickbar, _quickchat, and Engines::NWN::Module::getGameVersion().

Here is the call graph for this function:

◆ ~IngameGUI()

Engines::NWN::IngameGUI::~IngameGUI ( )

Definition at line 59 of file ingame.cpp.

References hide().

Here is the call graph for this function:

Member Function Documentation

◆ abortMain()

void Engines::NWN::IngameGUI::abortMain ( )

Abort the ingame main menu.

Definition at line 71 of file ingame.cpp.

References _main.

◆ addEvent()

void Engines::NWN::IngameGUI::addEvent ( const Events::Event & event )

Definition at line 99 of file ingame.cpp.

References _compass, _dialog, _party, _quickbar, and _quickchat.

◆ hasRunningConversation()

bool Engines::NWN::IngameGUI::hasRunningConversation ( ) const

Do we have a currently running conversation?

Definition at line 174 of file ingame.cpp.

References _dialog.

◆ hide()

void Engines::NWN::IngameGUI::hide ( )

Hide the ingame GUI elements.

Definition at line 87 of file ingame.cpp.

References _compass, _dialog, _party, _quickbar, and _quickchat.

Referenced by ~IngameGUI().

Here is the caller graph for this function:

◆ processEventQueue()

void Engines::NWN::IngameGUI::processEventQueue ( )

Definition at line 114 of file ingame.cpp.

References _compass, _dialog, _party, _quickbar, _quickchat, and stopConversation().

Here is the call graph for this function:

◆ setArea()

void Engines::NWN::IngameGUI::setArea ( const Common::UString & area )

Set the current area.

Definition at line 143 of file ingame.cpp.

References _party.

◆ setHealth()

void Engines::NWN::IngameGUI::setHealth	(	size_t	partyMember,
		uint32	current,
		uint32	max
	)

private

Set the party member's health.

Definition at line 135 of file ingame.cpp.

References _party.

Referenced by updatePartyMember().

Here is the caller graph for this function:

◆ setHealthy()

void Engines::NWN::IngameGUI::setHealthy ( size_t partyMember )

private

Set party member to "healthy" (red health bar).

Definition at line 148 of file ingame.cpp.

References _party.

◆ setName()

void Engines::NWN::IngameGUI::setName	(	size_t	partyMember,
		const Common::UString &	name
	)

private

Set the party member's name.

Definition at line 139 of file ingame.cpp.

References _party.

Referenced by updatePartyMember().

Here is the caller graph for this function:

◆ setPoisoned()

void Engines::NWN::IngameGUI::setPoisoned ( size_t partyMember )

private

Set party member to "poisoned" (green health bar).

Definition at line 156 of file ingame.cpp.

References _party.

◆ setPortrait()

void Engines::NWN::IngameGUI::setPortrait	(	size_t	partyMember,
		const Common::UString &	portrait
	)

private

Set the party member's portrait.

Definition at line 131 of file ingame.cpp.

References _party.

Referenced by updatePartyMember().

Here is the caller graph for this function:

◆ setSick()

void Engines::NWN::IngameGUI::setSick ( size_t partyMember )

private

Set party member to "sick" (brown health bar).

Definition at line 152 of file ingame.cpp.

References _party.

◆ show()

void Engines::NWN::IngameGUI::show ( )

Show the ingame GUI elements.

Definition at line 75 of file ingame.cpp.

References _compass, _dialog, _party, _quickbar, and _quickchat.

◆ showMain()

uint32 Engines::NWN::IngameGUI::showMain ( )

Show the ingame main menu.

Definition at line 63 of file ingame.cpp.

References _main.

◆ startConversation()

bool Engines::NWN::IngameGUI::startConversation	(	const Common::UString &	conv,
		Creature &	pc,
		Object &	obj,
		bool	playHello = `true`
	)

Start a conversation.

Definition at line 178 of file ingame.cpp.

References _dialog, _module, Common::UString::c_str(), Common::UString::empty(), Common::exceptionDispatcherWarning(), and stopConversation().

Here is the call graph for this function:

◆ stopConversation()

void Engines::NWN::IngameGUI::stopConversation ( )

Stop a conversation.

Definition at line 199 of file ingame.cpp.

References _dialog.

Referenced by processEventQueue(), and startConversation().

Here is the caller graph for this function:

◆ updatePartyMember()

void Engines::NWN::IngameGUI::updatePartyMember	(	size_t	partyMember,
		const Creature &	creature,
		bool	force = `false`
	)

Update the party member.

Definition at line 160 of file ingame.cpp.

References _lastPartyMemberChange, _party, Engines::NWN::Creature::getCurrentHP(), Engines::NWN::Creature::getMaxHP(), Engines::NWN::Object::getName(), Engines::NWN::Creature::getPortrait(), Engines::NWN::Creature::lastChangedGUIDisplay(), setHealth(), setName(), and setPortrait().

Here is the call graph for this function:

Member Data Documentation

◆ _compass

Common::ScopedPtr<Compass> Engines::NWN::IngameGUI::_compass

private

The compass.

Definition at line 94 of file ingame.h.

Referenced by addEvent(), hide(), IngameGUI(), processEventQueue(), and show().

◆ _dialog

Common::ScopedPtr<Dialog> Engines::NWN::IngameGUI::_dialog

private

The current dialog.

Definition at line 96 of file ingame.h.

Referenced by addEvent(), hasRunningConversation(), hide(), processEventQueue(), show(), startConversation(), and stopConversation().

◆ _lastCompassChange

uint32 Engines::NWN::IngameGUI::_lastCompassChange

private

The time the compass was changed last.

Definition at line 99 of file ingame.h.

◆ _lastPartyMemberChange

std::vector<uint32> Engines::NWN::IngameGUI::_lastPartyMemberChange

private

The time that party member was changed last.

Definition at line 101 of file ingame.h.

Referenced by IngameGUI(), and updatePartyMember().

◆ _main

Common::ScopedPtr<IngameMainMenu> Engines::NWN::IngameGUI::_main

private

The ingame main menu.

Definition at line 90 of file ingame.h.

Referenced by abortMain(), IngameGUI(), and showMain().

◆ _module

Module* Engines::NWN::IngameGUI::_module

private

Definition at line 88 of file ingame.h.

Referenced by IngameGUI(), and startConversation().

◆ _party

Common::PtrVector<CharacterInfo> Engines::NWN::IngameGUI::_party

private

The party member character panels.

Definition at line 103 of file ingame.h.

Referenced by addEvent(), hide(), IngameGUI(), processEventQueue(), setArea(), setHealth(), setHealthy(), setName(), setPoisoned(), setPortrait(), setSick(), show(), and updatePartyMember().

◆ _quickbar

Common::ScopedPtr<Quickbar> Engines::NWN::IngameGUI::_quickbar

private

The quick bar.

Definition at line 92 of file ingame.h.

Referenced by addEvent(), hide(), IngameGUI(), processEventQueue(), and show().

◆ _quickchat

Common::ScopedPtr<Quickchat> Engines::NWN::IngameGUI::_quickchat

private

The quick chat.

Definition at line 93 of file ingame.h.

Referenced by addEvent(), hide(), IngameGUI(), processEventQueue(), and show().

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

src/engines/nwn/gui/ingame/ingame.h
src/engines/nwn/gui/ingame/ingame.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IngameGUI()

◆ ~IngameGUI()

Member Function Documentation

◆ abortMain()

◆ addEvent()

◆ hasRunningConversation()

◆ hide()

◆ processEventQueue()

◆ setArea()

◆ setHealth()

◆ setHealthy()

◆ setName()

◆ setPoisoned()

◆ setPortrait()

◆ setSick()

◆ show()

◆ showMain()

◆ startConversation()

◆ stopConversation()

◆ updatePartyMember()

Member Data Documentation

◆ _compass

◆ _dialog

◆ _lastCompassChange

◆ _lastPartyMemberChange

◆ _main

◆ _module

◆ _party

◆ _quickbar

◆ _quickchat