hoa_boot::CreditsScreen Class Reference

Provides for everything that is needed for displaying the game credits. More...

#include <boot_credits.h>

Collaboration diagram for hoa_boot::CreditsScreen:

[legend]List of all members.

Public Member Functions
	CreditsScreen ()
void	Draw ()
	Draws the credits window on the screen if it is set visible.
void	Hide ()
	Hides the credits window.
bool	IsVisible ()
	Returns true if the credits window is set visible at the moment.
void	Show ()
	Shows the credits window.
void	UpdateWindow (int32 frame_time)
	Updates the credits window.
	~CreditsScreen ()
Private Attributes
hoa_video::RenderedString *	_credits_rendered
	Rendered text string.
std::string	_credits_text
	Text to be displayed.
float	_text_offset_y
	Text Y offset.
bool	_visible
	Is the window visible or not.
hoa_video::MenuWindow	_window
	Window for the screen.

---

Detailed Description

Provides for everything that is needed for displaying the game credits.

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

This class is used only in boot mode.

Definition at line 34 of file boot_credits.h.

---

Constructor & Destructor Documentation

hoa_boot::CreditsScreen::CreditsScreen

(

)

Definition at line 29 of file boot_credits.cpp.

References _credits_text, _window, hoa_script::ReadScriptDescriptor::CloseFile(), hoa_video::MenuWindow::Create(), hoa_video::MenuWindow::Hide(), hoa_script::ReadScriptDescriptor::OpenFile(), hoa_script::ReadScriptDescriptor::ReadString(), hoa_video::MenuWindow::SetDisplayMode(), hoa_video::private_video::GUIElement::SetPosition(), and hoa_video::VIDEO_MENU_EXPAND_FROM_CENTER.

Here is the call graph for this function:

hoa_boot::CreditsScreen::~CreditsScreen

(

)

Definition at line 51 of file boot_credits.cpp.

References _credits_rendered, _window, and hoa_video::MenuWindow::Destroy().

Here is the call graph for this function:

---

Member Function Documentation

void hoa_boot::CreditsScreen::Draw

(

)

Draws the credits window on the screen if it is set visible.

Definition at line 62 of file boot_credits.cpp.

References _credits_rendered, _text_offset_y, _window, hoa_video::RenderedString::Draw(), hoa_video::MenuWindow::Draw(), hoa_video::GameVideo::EnableScissoring(), hoa_video::MenuWindow::GetScissorRect(), hoa_video::MenuWindow::GetState(), hoa_video::GameVideo::Move(), hoa_video::GameVideo::SetScissorRect(), hoa_video::VIDEO_MENU_STATE_SHOWN, and hoa_video::VideoManager.

Referenced by hoa_boot::BootMode::Draw().

Here is the call graph for this function:

void hoa_boot::CreditsScreen::Hide

(

)

Hides the credits window.

Definition at line 116 of file boot_credits.cpp.

References _credits_rendered, _visible, _window, and hoa_video::MenuWindow::Hide().

Referenced by hoa_boot::BootMode::Update().

Here is the call graph for this function:

bool hoa_boot::CreditsScreen::IsVisible

(

)

Returns true if the credits window is set visible at the moment.

Definition at line 129 of file boot_credits.cpp.

References _visible.

Referenced by hoa_boot::BootMode::Draw(), and hoa_boot::BootMode::Update().

void hoa_boot::CreditsScreen::Show

(

)

Shows the credits window.

Definition at line 97 of file boot_credits.cpp.

References _credits_rendered, _credits_text, _text_offset_y, _visible, _window, hoa_utils::MakeUnicodeString(), hoa_video::GameVideo::RenderText(), hoa_video::GameVideo::SetFont(), hoa_video::GameVideo::SetTextColor(), hoa_video::MenuWindow::Show(), and hoa_video::VideoManager.

Referenced by hoa_boot::BootMode::_OnCredits().

Here is the call graph for this function:

void hoa_boot::CreditsScreen::UpdateWindow

(

int32

frame_time

)

Updates the credits window.

Definition at line 88 of file boot_credits.cpp.

References _text_offset_y, _window, and hoa_video::MenuWindow::Update().

Referenced by hoa_boot::BootMode::Update().

Here is the call graph for this function:

---

Member Data Documentation

hoa_video::RenderedString* hoa_boot::CreditsScreen::_credits_rendered [private]

Rendered text string.

Definition at line 70 of file boot_credits.h.

Referenced by Draw(), Hide(), Show(), and ~CreditsScreen().

std::string hoa_boot::CreditsScreen::_credits_text [private]

Text to be displayed.

Definition at line 67 of file boot_credits.h.

Referenced by CreditsScreen(), and Show().

float hoa_boot::CreditsScreen::_text_offset_y [private]

Text Y offset.

Definition at line 64 of file boot_credits.h.

Referenced by Draw(), Show(), and UpdateWindow().

bool hoa_boot::CreditsScreen::_visible [private]

Is the window visible or not.

Definition at line 61 of file boot_credits.h.

Referenced by Hide(), IsVisible(), and Show().

hoa_video::MenuWindow hoa_boot::CreditsScreen::_window [private]

Window for the screen.

Definition at line 58 of file boot_credits.h.

Referenced by CreditsScreen(), Draw(), Hide(), Show(), UpdateWindow(), and ~CreditsScreen().

---

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

• boot_credits.h
• boot_credits.cpp

---