hoa_battle::private_battle::FinishWindow Class Reference

The window displayed once a battle has either been won or lost. More...

#include <battle_windows.h>

Inheritance diagram for hoa_battle::private_battle::FinishWindow:

[legend]Collaboration diagram for hoa_battle::private_battle::FinishWindow:

[legend]List of all members.

Public Member Functions
void	Draw ()
	Draws the window and its contents.
	FinishWindow ()
FINISH_WINDOW_VIEWS	GetState () const
void	Initialize (bool victory)
	Un-hides the window display and creates the window contents.
void	Update ()
	Updates the state of the window.
	~FinishWindow ()
Private Attributes
hoa_video::OptionBox	_lose_options
	The list of options that the player may choose from when they lose the battle.
FINISH_WINDOW_VIEWS	_state
	The state that the window is in, which determines its contents.
Friends
class	BattleMode

---

Detailed Description

The window displayed once a battle has either been won or lost.

****************************************************************************

This window is located in the center right portion of the screen and only appears when a victor has been decided in the battle. The contents of this window differ depending on whether the battle was victorious or a loss. If the player won the battle, they will have their victory spoils written to the screen along with any character growth information (e.g. experience level up). If the player lost the battle, they will be presented with a number of options. The player may choose to:

• Retry the battle from the beginning
• Load the game from the last save point
• Return to the game's main menu
• Exit the game

Todo:

Add feature where spoils (XP, drunes, etc) are quickly counted down as they go into the party's posession.

Todo:

If the battle is victorious, allow the player to go to menu mode before returning from the finished battle.

Definition at line 258 of file battle_windows.h.

---

Constructor & Destructor Documentation

hoa_battle::private_battle::FinishWindow::FinishWindow

(

)

Definition at line 524 of file battle_windows.cpp.

References _lose_options, _state, hoa_battle::private_battle::FINISH_INVALID, hoa_utils::MakeUnicodeString(), hoa_video::private_video::GUIElement::SetAlignment(), hoa_video::OptionBox::SetCellSize(), hoa_video::OptionBox::SetCursorOffset(), hoa_video::OptionBox::SetFont(), hoa_video::OptionBox::SetHorizontalWrapMode(), hoa_video::OptionBox::SetOptionAlignment(), hoa_video::OptionBox::SetOptions(), hoa_video::private_video::GUIControl::SetOwner(), hoa_video::private_video::GUIElement::SetPosition(), hoa_video::OptionBox::SetSelection(), hoa_video::OptionBox::SetSelectMode(), hoa_video::OptionBox::SetSize(), hoa_video::VIDEO_SELECT_SINGLE, hoa_video::VIDEO_WRAP_MODE_STRAIGHT, hoa_video::VIDEO_X_CENTER, and hoa_video::VIDEO_Y_CENTER.

Here is the call graph for this function:

hoa_battle::private_battle::FinishWindow::~FinishWindow

(

)

Definition at line 556 of file battle_windows.cpp.

---

Member Function Documentation

void hoa_battle::private_battle::FinishWindow::Draw

(

)

[virtual]

Draws the window and its contents.

Reimplemented from hoa_video::MenuWindow.

Definition at line 598 of file battle_windows.cpp.

References _state, hoa_battle::BattleMode::_victory_items, hoa_battle::BattleMode::_victory_level, hoa_battle::BattleMode::_victory_money, hoa_battle::BattleMode::_victory_skill, hoa_battle::BattleMode::_victory_sp, hoa_battle::BattleMode::_victory_xp, hoa_battle::private_battle::current_battle, hoa_video::GameVideo::DisableSceneLighting(), hoa_video::GameVideo::DrawText(), hoa_battle::private_battle::FINISH_ANNOUNCE_LOSE, hoa_battle::private_battle::FINISH_ANNOUNCE_WIN, hoa_utils::MakeUnicodeString(), hoa_video::GameVideo::Move(), hoa_utils::NumberToString(), hoa_video::GameVideo::SetDrawFlags(), hoa_video::GameVideo::SetTextColor(), hoa_video::VIDEO_X_CENTER, hoa_video::VIDEO_Y_CENTER, and hoa_video::VideoManager.

Referenced by hoa_battle::BattleMode::Draw().

Here is the call graph for this function:

FINISH_WINDOW_VIEWS hoa_battle::private_battle::FinishWindow::GetState

(

)

const [inline]

Reimplemented from hoa_video::MenuWindow.

Definition at line 276 of file battle_windows.h.

References _state.

Referenced by hoa_battle::BattleMode::Update().

void hoa_battle::private_battle::FinishWindow::Initialize

(

bool

victory

)

Un-hides the window display and creates the window contents.

Parameters:

victory

Set to true if the player's party was victorious in battle; false if he/she was defeated

Definition at line 562 of file battle_windows.cpp.

References hoa_battle::BattleMode::_battle_music, _state, hoa_battle::BattleMode::AddMusic(), hoa_battle::private_battle::current_battle, hoa_battle::private_battle::FINISH_ANNOUNCE_LOSE, and hoa_battle::private_battle::FINISH_ANNOUNCE_WIN.

Referenced by hoa_battle::BattleMode::Update().

Here is the call graph for this function:

void hoa_battle::private_battle::FinishWindow::Update

(

)

Updates the state of the window.

Definition at line 579 of file battle_windows.cpp.

References hoa_battle::BattleMode::_ShutDown(), _state, hoa_audio::AudioManager, hoa_input::GameInput::ConfirmPress(), hoa_battle::private_battle::current_battle, hoa_battle::private_battle::FINISH_ANNOUNCE_LOSE, hoa_battle::private_battle::FINISH_ANNOUNCE_WIN, hoa_input::InputManager, hoa_battle::BattleMode::PlayerDefeat(), and hoa_audio::GameAudio::PlaySound().

Referenced by hoa_battle::BattleMode::Update().

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class BattleMode [friend]

Definition at line 259 of file battle_windows.h.

---

Member Data Documentation

hoa_video::OptionBox hoa_battle::private_battle::FinishWindow::_lose_options [private]

The list of options that the player may choose from when they lose the battle.

Definition at line 287 of file battle_windows.h.

Referenced by FinishWindow().

FINISH_WINDOW_VIEWS hoa_battle::private_battle::FinishWindow::_state [private]

The state that the window is in, which determines its contents.

Definition at line 281 of file battle_windows.h.

Referenced by Draw(), FinishWindow(), GetState(), Initialize(), and Update().

---

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

• battle_windows.h
• battle_windows.cpp

---