wavelength 1.0.0
Loading...
Searching...
No Matches
HudCommon Class Reference

Parts of the head-up display that belong to the whole game rather than to one player. More...

#include <hudcommon.h>

Public Member Functions

 HudCommon (RndView *pHudView, DataArray *pConfig, DataArray *pDefaults)
 Construct the parts the rule set and the community of the game call for.
 ~HudCommon ()
 Destroy the parts.
void Poll (float fSongDelta, float fRealDelta, float fTickDelta)
 Advance the parts.
void Draw ()
 Draw the song position, the button icons, the sections, and the stick marker.
void DrawText ()
 Draw the chat, the text message, the letterbox, and the two lines of text.
void DrawAvatar ()
 Draw the avatar of the leader.
void SetPlaying (int nPlayer, bool bPlaying)
 Mark a player as playing or not, and show the leader avatar of the one player who plays.
void Reset ()
 Return every part to its state at the start of a song.
OvyJuice & GetJuice ()
HudTextNode & GetMessage ()
HudTextNode & GetMessage2 ()
HudTextMessage & GetTextMessage ()
HudHiliteBox & GetHilite ()
HudLetterbox & GetLetterbox ()
OvySongPos * GetSongPos () const
HudFlyingButton & GetButton (int nLane) const
OvyController * GetController () const
void SetController (std::unique_ptr< OvyController > pController)
 Replace the picture of the controller.
OvyDialog * GetDialog () const
void SetDialog (std::unique_ptr< OvyDialog > pDialog)
 Replace the panel of text.
OvyAvatar * GetLeaderAvatar () const
OvySectionPanel * GetSections () const
HudStick * GetStick () const
HudLetterExit * GetLetterExit () const
OvyTrackLabel * GetTrackLabel () const

Static Public Attributes

static constexpr int kNumLanes = 6
 The number of lanes, one flying button icon each.

Detailed Description

Parts of the head-up display that belong to the whole game rather than to one player.

The class is not polymorphic and emits no RTTI. The object is 0x250 bytes. The title is inferred. The overlay builds one and owns it.

Constructor & Destructor Documentation

◆ HudCommon()

HudCommon::HudCommon ( RndView * pHudView,
DataArray * pConfig,
DataArray * pDefaults )

Construct the parts the rule set and the community of the game call for.

Parameters
pHudViewThe view of the head-up display layout.
pConfigThe configuration section of the game mode.
pDefaultsThe section of defaults.
Ghidra address:
NTSC-U/C: 0x001c2ba8
Ghidra address:
PAL: 0x001cb948

◆ ~HudCommon()

HudCommon::~HudCommon ( )

Destroy the parts.

Ghidra address:
NTSC-U/C: 0x001c2fa8
Ghidra address:
PAL: 0x001cbd48

Member Function Documentation

◆ Poll()

void HudCommon::Poll ( float fSongDelta,
float fRealDelta,
float fTickDelta )

Advance the parts.

Parameters
fSongDeltaThe song time since the last poll.
fRealDeltaThe time since the last poll.
fTickDeltaThe ticks since the last poll.
Ghidra address:
NTSC-U/C: 0x001c31e8
Ghidra address:
PAL: 0x001cbf88

◆ Draw()

void HudCommon::Draw ( )

Draw the song position, the button icons, the sections, and the stick marker.

Ghidra address:
NTSC-U/C: 0x001c3360
Ghidra address:
PAL: 0x001cc100

◆ DrawText()

void HudCommon::DrawText ( )

Draw the chat, the text message, the letterbox, and the two lines of text.

Ghidra address:
NTSC-U/C: 0x001c33f8
Ghidra address:
PAL: 0x001cc198

◆ DrawAvatar()

void HudCommon::DrawAvatar ( )

Draw the avatar of the leader.

Ghidra address:
NTSC-U/C: 0x001c3450
Ghidra address:
PAL: 0x001cc1f0

◆ SetPlaying()

void HudCommon::SetPlaying ( int nPlayer,
bool bPlaying )

Mark a player as playing or not, and show the leader avatar of the one player who plays.

Parameters
nPlayerThe player, or a negative value for none.
bPlayingWhether the player plays.
Ghidra address:
NTSC-U/C: 0x001c3478
Ghidra address:
PAL: 0x001cc218

◆ Reset()

void HudCommon::Reset ( )

Return every part to its state at the start of a song.

Ghidra address:
NTSC-U/C: 0x001c3558
Ghidra address:
PAL: 0x001cc2f8

◆ GetJuice()

OvyJuice & HudCommon::GetJuice ( )
inline
Returns
The energy bar.

◆ GetMessage()

HudTextNode & HudCommon::GetMessage ( )
inline
Returns
HUD genmsg.txt.

◆ GetMessage2()

HudTextNode & HudCommon::GetMessage2 ( )
inline
Returns
HUD genmsg2.txt.

◆ GetTextMessage()

HudTextMessage & HudCommon::GetTextMessage ( )
inline
Returns
The message that flies across.

◆ GetHilite()

HudHiliteBox & HudCommon::GetHilite ( )
inline
Returns
The highlight and the arrow of the tutorial.

◆ GetLetterbox()

HudLetterbox & HudCommon::GetLetterbox ( )
inline
Returns
The letterbox bars.

◆ GetSongPos()

OvySongPos * HudCommon::GetSongPos ( ) const
inline
Returns
The song position bar, or null.

◆ GetButton()

HudFlyingButton & HudCommon::GetButton ( int nLane) const
inline
Parameters
nLaneThe lane, below kNumLanes.
Returns
The button icon of the lane.

◆ GetController()

OvyController * HudCommon::GetController ( ) const
inline
Returns
The picture of the controller, or null.

◆ SetController()

void HudCommon::SetController ( std::unique_ptr< OvyController > pController)
inline

Replace the picture of the controller.

Parameters
pControllerThe new picture, which the head-up display then owns.

◆ GetDialog()

OvyDialog * HudCommon::GetDialog ( ) const
inline
Returns
The panel of text, or null.

◆ SetDialog()

void HudCommon::SetDialog ( std::unique_ptr< OvyDialog > pDialog)
inline

Replace the panel of text.

Parameters
pDialogThe new panel, which the head-up display then owns.

◆ GetLeaderAvatar()

OvyAvatar * HudCommon::GetLeaderAvatar ( ) const
inline
Returns
The avatar of the leader, or null.

◆ GetSections()

OvySectionPanel * HudCommon::GetSections ( ) const
inline
Returns
The sections of a remix, or null.

◆ GetStick()

HudStick * HudCommon::GetStick ( ) const
inline
Returns
The stick marker of a remix, or null.

◆ GetLetterExit()

HudLetterExit * HudCommon::GetLetterExit ( ) const
inline
Returns
The letter banner of a duel, or null.

◆ GetTrackLabel()

OvyTrackLabel * HudCommon::GetTrackLabel ( ) const
inline
Returns
The track label, or null.

Member Data Documentation

◆ kNumLanes

int HudCommon::kNumLanes = 6
staticconstexpr

The number of lanes, one flying button icon each.


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