xoreos  0.0.5
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Engines::NWN::PartyLeader Class Reference

The NWN ingame party leader bar. More...

#include <partyleader.h>

Inheritance diagram for Engines::NWN::PartyLeader:
Inheritance graph
[legend]
Collaboration diagram for Engines::NWN::PartyLeader:
Collaboration graph
[legend]

Public Member Functions

 PartyLeader (Module &module)
 
 ~PartyLeader ()
 
void setPortrait (const Common::UString &portrait)
 Set the portrait image. More...
 
void setName (const Common::UString &name)
 Set the character name. More...
 
void setArea (const Common::UString &area)
 Set the area the character is in. More...
 
void setHealthColor (float r, float g, float b, float a)
 Set the health bar color. More...
 
void setHealth (int32 current, int32 max)
 Set the character health. More...
 
- Public Member Functions inherited from Engines::NWN::CharacterInfo
 CharacterInfo ()
 
virtual ~CharacterInfo ()
 
- Public Member Functions inherited from Engines::NWN::GUI
 GUI (::Engines::Console *console=0)
 
 ~GUI ()
 
- Public Member Functions inherited from Engines::GUI
 GUI (Console *console=0)
 
virtual void show ()
 Show the GUI. More...
 
virtual void hide ()
 Hide the GUI. More...
 
uint32 run (uint32 startCode=kStartCodeNone)
 Run the GUI. More...
 
virtual void abort ()
 Abort the currently running GUI. More...
 
void addEvent (const Events::Event &event)
 Add a single event for consideration into the GUI event queue. More...
 
uint32 processEventQueue ()
 Process the current event queue. More...
 
virtual Common::UString getName () const
 
- Public Member Functions inherited from Events::Notifyable
 Notifyable ()
 
virtual ~Notifyable ()
 

Protected Member Functions

void callbackActive (Widget &widget)
 Callback that's triggered when a widget was activated. More...
 
- Protected Member Functions inherited from Engines::NWN::GUI
void load (const Common::UString &resref)
 
virtual void fixWidgetType (const Common::UString &tag, WidgetType &type)
 
virtual void initWidget (Widget &widget)
 
WidgetFramegetFrame (const Common::UString &tag, bool vital=false)
 
WidgetClosegetClose (const Common::UString &tag, bool vital=false)
 
WidgetCheckBoxgetCheckBox (const Common::UString &tag, bool vital=false)
 
WidgetPanelgetPanel (const Common::UString &tag, bool vital=false)
 
WidgetLabelgetLabel (const Common::UString &tag, bool vital=false)
 
WidgetSlidergetSlider (const Common::UString &tag, bool vital=false)
 
WidgetEditBoxgetEditBox (const Common::UString &tag, bool vital=false)
 
WidgetButtongetButton (const Common::UString &tag, bool vital=false)
 
WidgetListBoxgetListBox (const Common::UString &tag, bool vital=false)
 
WidgetScrollbargetScrollbar (const Common::UString &tag, bool vital=false)
 
- Protected Member Functions inherited from Engines::GUI
void addWidget (Widget *widget)
 Add a widget. More...
 
void removeWidget (Widget *widget)
 Remove a widget. More...
 
void clearWidgets ()
 Clear all widgets. More...
 
bool empty ()
 Check if the gui is currently empty. More...
 
bool hasWidget (const Common::UString &tag) const
 Does this specific widget exist within the GUI? More...
 
WidgetgetWidget (const Common::UString &tag, bool vital=false)
 Return a widget in the GUI. More...
 
const WidgetgetWidget (const Common::UString &tag, bool vital=false) const
 Return a widget in the GUI. More...
 
void declareGroup (const std::list< Widget *> &group)
 Put these widgets together into a group. More...
 
void removeFocus ()
 Forcefully remove the focus from the current widget. More...
 
void updateMouse ()
 Force an update of the mouse position. More...
 
virtual void mouseUp ()
 The mouse state has changed. More...
 
virtual void mouseDown ()
 
uint32 sub (GUI &gui, uint32 startCode=kStartCodeNone, bool showSelf=true, bool hideSelf=true)
 Open up a sub GUI. More...
 
void setPosition (float x, float y, float z)
 Set the GUI's position. More...
 
void getPosition (float &x, float &y, float &z) const
 Get the GUI's position. More...
 
virtual void callbackRun ()
 Callback that's triggered periodically in the run() method. More...
 
virtual void callbackTextInput (const Common::UString &text)
 Callback that's triggered when a text input is received. More...
 
virtual void callbackKeyInput (const Events::Key &key, const Events::EventType &type)
 Callback that's triggered when a key is pressed or released. More...
 
void addChild (GUI *gui)
 Add a child GUI object to this GUI. More...
 
void removeChild (GUI *gui)
 Remove a child GUI object from this GUI. More...
 

Private Member Functions

void updatePortraitTooltip ()
 
void notifyResized (int oldWidth, int oldHeight, int newWidth, int newHeight)
 

Private Attributes

Module_module
 
PortraitWidget_portrait
 
QuadWidget_health
 
Common::UString _currentPortrait
 
Common::UString _name
 
Common::UString _area
 
int32 _currentHP
 
int32 _maxHP
 

Additional Inherited Members

- Static Public Attributes inherited from Engines::GUI
static const uint32 kStartCodeNone = 0
 
static const uint32 kReturnCodeNone = 0
 
static const uint32 kReturnCodeAbort = 0xFFFFFFFF
 
- Protected Types inherited from Engines::NWN::GUI
enum  WidgetType {
  kWidgetTypeInvalid = - 1, kWidgetTypeFrame = 0, kWidgetTypeCloseButton = 1, kWidgetTypeCheckBox = 2,
  kWidgetTypePanel = 3, kWidgetTypeLabel = 5, kWidgetTypeSlider = 6, kWidgetTypeEditBox = 8,
  kWidgetTypeButton = 9, kWidgetTypeListBox = 100, kWidgetTypeScrollbar = 101
}
 
- Protected Attributes inherited from Engines::GUI
Console_console
 
Widget_currentWidget
 The widget the mouse is currently on. More...
 
uint32 _startCode
 The GUI's start code. More...
 
uint32 _returnCode
 The GUI's return code. More...
 
GUI_sub
 The currently running sub GUI. More...
 

Detailed Description

The NWN ingame party leader bar.

Definition at line 42 of file partyleader.h.

Constructor & Destructor Documentation

◆ PartyLeader()

Engines::NWN::PartyLeader::PartyLeader ( Module module)

◆ ~PartyLeader()

Engines::NWN::PartyLeader::~PartyLeader ( )

Definition at line 118 of file partyleader.cpp.

Member Function Documentation

◆ callbackActive()

void Engines::NWN::PartyLeader::callbackActive ( Widget widget)
protectedvirtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 155 of file partyleader.cpp.

References _module, Engines::Widget::getTag(), Engines::GUI::removeFocus(), and Engines::NWN::Module::showMenu().

Here is the call graph for this function:

◆ notifyResized()

void Engines::NWN::PartyLeader::notifyResized ( int  oldWidth,
int  oldHeight,
int  newWidth,
int  newHeight 
)
privatevirtual

Reimplemented from Events::Notifyable.

Definition at line 172 of file partyleader.cpp.

References Engines::GUI::setPosition().

Referenced by PartyLeader().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setArea()

void Engines::NWN::PartyLeader::setArea ( const Common::UString area)
virtual

Set the area the character is in.

Reimplemented from Engines::NWN::CharacterInfo.

Definition at line 132 of file partyleader.cpp.

References _area, and updatePortraitTooltip().

Here is the call graph for this function:

◆ setHealth()

void Engines::NWN::PartyLeader::setHealth ( int32  current,
int32  max 
)
virtual

Set the character health.

Implements Engines::NWN::CharacterInfo.

Definition at line 142 of file partyleader.cpp.

References _currentHP, _health, _maxHP, CLIP(), Engines::NWN::QuadWidget::setHeight(), and updatePortraitTooltip().

Here is the call graph for this function:

◆ setHealthColor()

void Engines::NWN::PartyLeader::setHealthColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Set the health bar color.

Implements Engines::NWN::CharacterInfo.

Definition at line 138 of file partyleader.cpp.

References _health, and Engines::NWN::QuadWidget::setColor().

Here is the call graph for this function:

◆ setName()

void Engines::NWN::PartyLeader::setName ( const Common::UString name)
virtual

Set the character name.

Reimplemented from Engines::NWN::CharacterInfo.

Definition at line 126 of file partyleader.cpp.

References _name, and updatePortraitTooltip().

Here is the call graph for this function:

◆ setPortrait()

void Engines::NWN::PartyLeader::setPortrait ( const Common::UString portrait)
virtual

Set the portrait image.

Implements Engines::NWN::CharacterInfo.

Definition at line 121 of file partyleader.cpp.

References _currentPortrait, _portrait, and Engines::NWN::PortraitWidget::setPortrait().

Here is the call graph for this function:

◆ updatePortraitTooltip()

void Engines::NWN::PartyLeader::updatePortraitTooltip ( )
private

Definition at line 164 of file partyleader.cpp.

References _area, _currentHP, _maxHP, _name, _portrait, Common::UString::c_str(), Common::UString::format(), and Engines::NWN::NWNWidget::setTooltip().

Referenced by PartyLeader(), setArea(), setHealth(), and setName().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ _area

Common::UString Engines::NWN::PartyLeader::_area
private

Definition at line 72 of file partyleader.h.

Referenced by setArea(), and updatePortraitTooltip().

◆ _currentHP

int32 Engines::NWN::PartyLeader::_currentHP
private

Definition at line 74 of file partyleader.h.

Referenced by setHealth(), and updatePortraitTooltip().

◆ _currentPortrait

Common::UString Engines::NWN::PartyLeader::_currentPortrait
private

Definition at line 69 of file partyleader.h.

Referenced by setPortrait().

◆ _health

QuadWidget* Engines::NWN::PartyLeader::_health
private

Definition at line 67 of file partyleader.h.

Referenced by PartyLeader(), setHealth(), and setHealthColor().

◆ _maxHP

int32 Engines::NWN::PartyLeader::_maxHP
private

Definition at line 75 of file partyleader.h.

Referenced by setHealth(), and updatePortraitTooltip().

◆ _module

Module* Engines::NWN::PartyLeader::_module
private

Definition at line 64 of file partyleader.h.

Referenced by callbackActive().

◆ _name

Common::UString Engines::NWN::PartyLeader::_name
private

Definition at line 71 of file partyleader.h.

Referenced by setName(), and updatePortraitTooltip().

◆ _portrait

PortraitWidget* Engines::NWN::PartyLeader::_portrait
private

Definition at line 66 of file partyleader.h.

Referenced by PartyLeader(), setPortrait(), and updatePortraitTooltip().


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