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

Head-up display of a game, drawn over the tunnel. More...

#include <overlay.h>

Inheritance diagram for Overlay:
Collaboration diagram for Overlay:

Public Member Functions

 Overlay (DataArray *pConfig, DataArray *pDefaults)
 Build the display of the game about to start.
 ~Overlay () override
 Destroy the display and turn the screen blur off.
bool DispatchPriv (Message *pMsg) override
 Ignore a message.
void CreateTutorialParts ()
 Build the picture of the controller and the panel of text a tutorial uses.
OvyLocalPlayer * FindLocal (int nPlayer)
 Find the local parts of a player.
OvyAllPlayer * FindAll (int nPlayer)
 Find the parts every player has.
void AddCheckpoint (float fPos, const char *pszLabel)
 Add a checkpoint to the song position bar.
void ClearCheckpoints ()
 Remove the checkpoints of the song position bar.
void SetEnergy (float fLevel, int nColor)
 Set the level of the energy bar.
void SetEnergyWarning (bool bWarn)
 Start or stop the warning of the energy bar.
void SetScore (int nPlayer, int nScore)
 Show the score of a player, or the letters of a duel player.
void SetMultiplier (int nPlayer, int nMultiplier, int bHot, const char *pszText)
 Show the multiplier of a player's pending points.
void ShowPoints (int nPlayer, int nPoints, const char *pszText)
 Show a player's pending points, or reveal letters in a duel.
void HideMultiplier (int nPlayer)
 Hide the multiplier of a player's pending points.
void EndPoints (int nPlayer, int nResult)
 End a player's pending points, or fly the letters of a duel.
void ShowCapture (int nPlayer)
 Show a player catching a phrase.
void SetPlaying (int nPlayer, bool bPlaying)
 Mark a player as playing or not.
void ShowPowerup (int nPlayer, int nPowerup)
 Show the power-up a player holds.
void SetPowerupEnabled (int nPlayer, int nEnabled)
 Let a player's power-up icon slide into view or not.
void ShowTextMessage (const char *pszText, const char *pszSmallText, float fDuration, float fScale, int nPlayer, float fX, float fZ)
 Fly a message of two lines across the display.
void SetMessage (const char *pszText, bool bFirstLine)
 Show a line of text, or hide it for a null or empty text.
void SetLetterbox (bool bClosed)
 Close or open the letterbox bars.
float GetLetterbox ()
 Report how far the letterbox bars are closed.
void SetPartsShown (bool bShow, int nUnused)
 Show or hide the parts of the display the game shows during play.
void ShowEnergy (bool bShow)
 Slide the energy bar in or out.
void ShowScore (int nPlayer, bool bShow)
 Show or hide a player's score and pending points.
void ShowBox (bool bShow)
 Fade the tutorial highlight in or out.
void ShowArrow (bool bShow)
 Fade the tutorial arrow in or out.
void ShowAvatar (int nPlayer, bool bShow)
 Show or hide a player's avatar, or the leader avatar for player 0 when the player has none.
void ShowSongPos (bool bShow)
 Slide the song position bar in or out.
void ShowTrackLabel (bool bShow)
 Show or hide the track label.
void SetFreqSize (int nPlayer, int nFreqSize)
 Choose the size of a player's avatar display.
void SetTrack (int nPlayer, int nInstrument, int nTrackKind)
 Label the track a player moved to.
void FlashPoints (int nPlayer, float fValue)
 Flash a player's pending points, or time the letter banner of a duel.
void SetBoxRect (float fX0, float fY0, float fX1, float fY1, float fDuration)
 Move the tutorial highlight to a rectangle of the screen.
void SetArrowTarget (float fX, float fY, float fAngle, float fDuration)
 Move the tutorial arrow to point at a place of the screen.
void FlyButton (int nLane, const Vector2 *pFrom, const Vector2 *pTo)
 Fly the button icon of a lane.
void SetButtonPulse (int nLane, bool bPulse)
 Start or stop the pulse of the button icon of a lane.
void HideButton (int nLane)
 Hide the button icon of a lane.
void SetButtonGlyph (int nLane, const char *pszGlyph)
 Change the glyph of the button icon of a lane.
void ShowController (bool bShow, float fPosition)
 Slide the picture of the controller in or out and place it.
void SetControllerHighlight (bool bHighlight)
 Light or darken the picture of the controller.
void ShowControllerButton (int nButton, bool bShow)
 Show or hide a button of the picture of the controller.
void OpenDialog (const char *pszText, float fSize, float fPosition)
 Fill the panel of text and slide it in.
void CloseDialog ()
 Slide the panel of text out.
void ShowPlayerOnTrack (int nPlayer, int nIndex)
 Show a player on a track.
void SetSectionCount (int nCount)
 Show one blank entry per section of a remix.
void SetSectionLabel (int nIndex, const char *pszLabel)
 Set the label of a section of a remix.
void ShowSections (bool bShow)
 Slide the sections of a remix in or out.
void HighlightSection (int nIndex)
 Light the entry of a section of a remix.
void SetRemixPanelText (int nPlayer, int nIndex, const char *pszText, int nPanel)
 Set the text of an entry of a player's remix panel.
void SelectRemixPanelEntry (int nPlayer, int nIndex, int nPanel)
 Move the cursor of a player's remix panel to an entry.
void FlashRemixPanel (int nPlayer, int nPanel)
 Blink the cursor of a player's remix panel.
void SetRemixPanelLit (int nPlayer, int nIndex, int bLit, int nPanel)
 Light or darken an entry of a player's remix panel.
void ShowRemixPanel (int nPlayer, int nPanel)
 Slide out a panel of a player's remix menu.
void ShowRemix (int nPlayer, bool bShow)
 Slide a player's remix menu in or out.
void ShowStick (int nDirection, const Vector2 *pPosition)
 Show the stick marker of a remix.
void HideStick ()
 Hide the stick marker of a remix.
void SetCameraOffset (const Vector3 *pOffset)
 Move the display camera by an offset from its place in the layout.
void Reset ()
 Return every part to its state at the start of a song, hidden.
void ClearStarted ()
 Let the parts show again once the song starts.
void ShowCheckpoint ()
 Show every score of a shared-screen game at its place in the ranking, with the bar of its share of the points.
void ShowResult (bool bWon, int nMode)
 Show the result of a song: hide the energy bar of a lost song, or clear the pending points of a won one.
void Poll (float fFrame, float fSongDelta, float fUnused, float fRealDelta, float fFuture)
 Advance the display, and show its parts once the song is about to start.
void Draw ()
 Draw the display: the layout, the common parts, the parts of every player, and the avatars, the winner's last.
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the pool heaps under the tag "MsgSink".
void operator delete (void *pBlock)
 Return a sink to the pool heaps.
virtual ~MsgSink ()
virtual bool Dispatch (Message *pMsg)
 Accept a message.
void * operator new (size_t size)
 Allocate from the main heap under the name MsgSink.
void operator delete (void *mem)
 Return memory to its heap.
virtual ~MsgSink ()
 Destroy the sink.
virtual bool Dispatch (Message *msg)
 Handle a message.

Static Public Member Functions

static void LoadConfig (DataArray *pConfig, DataArray *pDefaults, bool bUnused)
 Read the settings of the display from a configuration section and its defaults.
static void SetHudPrefix ()
 Choose the head-up display layout from the community and the rule set of the game.

Static Public Attributes

static char sHudLetter
 The letter of the head-up display layout, 1, d, or m.
static const char * sHudPrefix
 The prefix of the head-up display layout's scene objects, HUD1, HUDd, or HUDm.
static float sAssemblyTime
 The time the head-up display takes to assemble, assembly_time.
static Vector2 sHudZ
 The depth range the display camera draws into, hud_z.
static float sPointsScale
 The scale of the points that fly off a score, hud_points_scale.
static float sDuelPointsMoveTicks
 The ticks the points of a duel take to move, duel_points_move_ticks.
static float sDuelPointsMoveRate
 One over sDuelPointsMoveTicks.

Detailed Description

Head-up display of a game, drawn over the tunnel.

The RTTI records the class as deriving from MsgSink. The vtable is at 0x003d19d8, and the object is 0x50 bytes. The display keeps the parts of the whole game in one HudCommon, the parts of each player on this console in an OvyLocalPlayer, and the score and the avatar of every player in an OvyAllPlayer. A duel orders its players by slot, and any other game puts the local players first.

Constructor & Destructor Documentation

◆ Overlay()

Overlay::Overlay ( DataArray * pConfig,
DataArray * pDefaults )

Build the display of the game about to start.

The layout is _hud<letter>.view, which joins hud.view. Every child of the layout but hud.cam and hud.env starts hidden, and the camera draws into the depth range sHudZ.

Parameters
pConfigThe configuration section of the game mode.
pDefaultsThe section of defaults.
Ghidra address:
NTSC-U/C: 0x001c39c8
Ghidra address:
PAL: 0x001cc768

◆ ~Overlay()

Overlay::~Overlay ( )
override

Destroy the display and turn the screen blur off.

Ghidra address:
NTSC-U/C: 0x001c4458
Ghidra address:
PAL: 0x001cd1f8

Member Function Documentation

◆ DispatchPriv()

bool Overlay::DispatchPriv ( Message * pMsg)
overridevirtual

Ignore a message.

Parameters
pMsgThe message.
Returns
False.
Ghidra address:
NTSC-U/C: 0x001c60a0
Ghidra address:
PAL: 0x001cee40

Implements MsgSink.

◆ CreateTutorialParts()

void Overlay::CreateTutorialParts ( )

Build the picture of the controller and the panel of text a tutorial uses.

Ghidra address:
NTSC-U/C: 0x001c45a0
Ghidra address:
PAL: 0x001cd340

◆ FindLocal()

OvyLocalPlayer * Overlay::FindLocal ( int nPlayer)

Find the local parts of a player.

Parameters
nPlayerThe player.
Returns
The parts, or null for a player not on this console.
Ghidra address:
NTSC-U/C: 0x001c4698
Ghidra address:
PAL: 0x001cd438

◆ FindAll()

OvyAllPlayer * Overlay::FindAll ( int nPlayer)

Find the parts every player has.

Parameters
nPlayerThe player.
Returns
The parts, or null.
Ghidra address:
NTSC-U/C: 0x001c46d8
Ghidra address:
PAL: 0x001cd478

◆ AddCheckpoint()

void Overlay::AddCheckpoint ( float fPos,
const char * pszLabel )

Add a checkpoint to the song position bar.

Parameters
fPosThe place on the bar, from 0 to 1.
pszLabelThe label, or null.
Ghidra address:
NTSC-U/C: 0x001c4718
Ghidra address:
PAL: 0x001cd4b8

◆ ClearCheckpoints()

void Overlay::ClearCheckpoints ( )

Remove the checkpoints of the song position bar.

Ghidra address:
NTSC-U/C: 0x001c4748
Ghidra address:
PAL: 0x001cd4e8

◆ SetEnergy()

void Overlay::SetEnergy ( float fLevel,
int nColor )

Set the level of the energy bar.

Parameters
fLevelThe level, from 0 to 1.
nColorThe colour of the bar.
Ghidra address:
NTSC-U/C: 0x001c4778
Ghidra address:
PAL: 0x001cd518

◆ SetEnergyWarning()

void Overlay::SetEnergyWarning ( bool bWarn)

Start or stop the warning of the energy bar.

Parameters
bWarnWhether the warning shows.
Ghidra address:
NTSC-U/C: 0x001c4798
Ghidra address:
PAL: 0x001cd538

◆ SetScore()

void Overlay::SetScore ( int nPlayer,
int nScore )

Show the score of a player, or the letters of a duel player.

Parameters
nPlayerThe player.
nScoreThe score, or the number of letters.
Ghidra address:
NTSC-U/C: 0x001c47b8
Ghidra address:
PAL: 0x001cd558

◆ SetMultiplier()

void Overlay::SetMultiplier ( int nPlayer,
int nMultiplier,
int bHot,
const char * pszText )

Show the multiplier of a player's pending points.

Parameters
nPlayerThe player.
nMultiplierThe multiplier.
bHotWhether the points take the hot colour.
pszTextThe text of the multiplier.
Ghidra address:
NTSC-U/C: 0x001c4810
Ghidra address:
PAL: 0x001cd5b0

◆ ShowPoints()

void Overlay::ShowPoints ( int nPlayer,
int nPoints,
const char * pszText )

Show a player's pending points, or reveal letters in a duel.

Parameters
nPlayerThe player.
nPointsThe points.
pszTextThe text of the points.
Ghidra address:
NTSC-U/C: 0x001c4870
Ghidra address:
PAL: 0x001cd610

◆ HideMultiplier()

void Overlay::HideMultiplier ( int nPlayer)

Hide the multiplier of a player's pending points.

Parameters
nPlayerThe player.
Ghidra address:
NTSC-U/C: 0x001c48e0
Ghidra address:
PAL: 0x001cd680

◆ EndPoints()

void Overlay::EndPoints ( int nPlayer,
int nResult )

End a player's pending points, or fly the letters of a duel.

Parameters
nPlayerThe player.
nResultOne of GfxManager::PendingPointsResult.
Ghidra address:
NTSC-U/C: 0x001c4918
Ghidra address:
PAL: 0x001cd6b8

◆ ShowCapture()

void Overlay::ShowCapture ( int nPlayer)
inline

Show a player catching a phrase.

The body is empty.

Parameters
nPlayerThe player.
Ghidra address:
NTSC-U/C: 0x001c4980
Ghidra address:
PAL: 0x001cd720

◆ SetPlaying()

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

Mark a player as playing or not.

Parameters
nPlayerThe player.
bPlayingWhether the player plays.
Ghidra address:
NTSC-U/C: 0x001c4988
Ghidra address:
PAL: 0x001cd728

◆ ShowPowerup()

void Overlay::ShowPowerup ( int nPlayer,
int nPowerup )

Show the power-up a player holds.

Parameters
nPlayerThe player.
nPowerupThe power-up, one of GameLogic::Powerup.
Ghidra address:
NTSC-U/C: 0x001c49a8
Ghidra address:
PAL: 0x001cd748

◆ SetPowerupEnabled()

void Overlay::SetPowerupEnabled ( int nPlayer,
int nEnabled )

Let a player's power-up icon slide into view or not.

Parameters
nPlayerThe player.
nEnabledNon-zero to let the icon show.
Ghidra address:
NTSC-U/C: 0x001c49f8
Ghidra address:
PAL: 0x001cd798

◆ ShowTextMessage()

void Overlay::ShowTextMessage ( const char * pszText,
const char * pszSmallText,
float fDuration,
float fScale,
int nPlayer,
float fX,
float fZ )

Fly a message of two lines across the display.

Parameters
pszTextThe large line.
pszSmallTextThe small line.
fDurationThe time the message rests in view, in milliseconds.
fScaleThe scale of the lines.
nPlayerThe player whose colour the lines take, or a negative value for the default.
fXThe horizontal place of the message.
fZThe vertical place of the message.
Ghidra address:
NTSC-U/C: 0x001c4a48
Ghidra address:
PAL: 0x001cd7e8

◆ SetMessage()

void Overlay::SetMessage ( const char * pszText,
bool bFirstLine )

Show a line of text, or hide it for a null or empty text.

Parameters
pszTextThe line, or null.
bFirstLineWhether the line is HUD genmsg.txt rather than HUD genmsg2.txt.
Ghidra address:
NTSC-U/C: 0x001c4a68
Ghidra address:
PAL: 0x001cd808

◆ SetLetterbox()

void Overlay::SetLetterbox ( bool bClosed)

Close or open the letterbox bars.

Parameters
bClosedWhether to close the bars.
Ghidra address:
NTSC-U/C: 0x001c4aa0
Ghidra address:
PAL: 0x001cd840

◆ GetLetterbox()

float Overlay::GetLetterbox ( )

Report how far the letterbox bars are closed.

Returns
The part, from 0 (open) to 1 (closed).
Ghidra address:
NTSC-U/C: 0x001c4ad8
Ghidra address:
PAL: 0x001cd878

◆ SetPartsShown()

void Overlay::SetPartsShown ( bool bShow,
int nUnused )

Show or hide the parts of the display the game shows during play.

A remix that plays back without editing shows the song position and the avatars only. The tutorial does not show the song position, the avatars, or the scores, and practice does not show the energy bar.

Parameters
bShowWhether to show the parts.
nUnusedNot read.
Ghidra address:
NTSC-U/C: 0x001c4af8
Ghidra address:
PAL: 0x001cd898

◆ ShowEnergy()

void Overlay::ShowEnergy ( bool bShow)

Slide the energy bar in or out.

Parameters
bShowWhether to show the bar.
Ghidra address:
NTSC-U/C: 0x001c4ef0
Ghidra address:
PAL: 0x001cdc90

◆ ShowScore()

void Overlay::ShowScore ( int nPlayer,
bool bShow )

Show or hide a player's score and pending points.

Parameters
nPlayerThe player.
bShowWhether to show them.
Ghidra address:
NTSC-U/C: 0x001c4f10
Ghidra address:
PAL: 0x001cdcb0

◆ ShowBox()

void Overlay::ShowBox ( bool bShow)

Fade the tutorial highlight in or out.

Parameters
bShowWhether to show the highlight.
Ghidra address:
NTSC-U/C: 0x001c4fc8
Ghidra address:
PAL: 0x001cdd68

◆ ShowArrow()

void Overlay::ShowArrow ( bool bShow)

Fade the tutorial arrow in or out.

Parameters
bShowWhether to show the arrow.
Ghidra address:
NTSC-U/C: 0x001c4fe8
Ghidra address:
PAL: 0x001cdd88

◆ ShowAvatar()

void Overlay::ShowAvatar ( int nPlayer,
bool bShow )

Show or hide a player's avatar, or the leader avatar for player 0 when the player has none.

Parameters
nPlayerThe player.
bShowWhether to show the avatar.
Ghidra address:
NTSC-U/C: 0x001c5008
Ghidra address:
PAL: 0x001cdda8

◆ ShowSongPos()

void Overlay::ShowSongPos ( bool bShow)

Slide the song position bar in or out.

Parameters
bShowWhether to show the bar.
Ghidra address:
NTSC-U/C: 0x001c50a0
Ghidra address:
PAL: 0x001cde40

◆ ShowTrackLabel()

void Overlay::ShowTrackLabel ( bool bShow)

Show or hide the track label.

Parameters
bShowWhether to show the label.
Ghidra address:
NTSC-U/C: 0x001c50d8
Ghidra address:
PAL: 0x001cde78

◆ SetFreqSize()

void Overlay::SetFreqSize ( int nPlayer,
int nFreqSize )

Choose the size of a player's avatar display.

Parameters
nPlayerThe player.
nFreqSizeOne of GameOptions::FreqSize.
Ghidra address:
NTSC-U/C: 0x001c5110
Ghidra address:
PAL: 0x001cdeb0

◆ SetTrack()

void Overlay::SetTrack ( int nPlayer,
int nInstrument,
int nTrackKind )

Label the track a player moved to.

Parameters
nPlayerThe player.
nInstrumentThe instrument of the track, one of GfxManager::Instrument.
nTrackKindThe kind of the track.
Ghidra address:
NTSC-U/C: 0x001c5150
Ghidra address:
PAL: 0x001cdef0

◆ FlashPoints()

void Overlay::FlashPoints ( int nPlayer,
float fValue )

Flash a player's pending points, or time the letter banner of a duel.

Parameters
nPlayerThe player.
fValueThe minimum swell of the flash, or the time of the banner. Nothing happens unless it is positive.
Ghidra address:
NTSC-U/C: 0x001c51d8
Ghidra address:
PAL: 0x001cdf78

◆ SetBoxRect()

void Overlay::SetBoxRect ( float fX0,
float fY0,
float fX1,
float fY1,
float fDuration )

Move the tutorial highlight to a rectangle of the screen.

Parameters
fX0The left edge, in the unit square of the screen.
fY0The top edge.
fX1The right edge.
fY1The bottom edge.
fDurationThe ticks the move takes.
Ghidra address:
NTSC-U/C: 0x001c5250
Ghidra address:
PAL: 0x001cdff0

◆ SetArrowTarget()

void Overlay::SetArrowTarget ( float fX,
float fY,
float fAngle,
float fDuration )

Move the tutorial arrow to point at a place of the screen.

Parameters
fXThe horizontal place, in the unit square of the screen.
fYThe vertical place.
fAngleThe direction of the arrow, in degrees.
fDurationThe ticks the move takes.
Ghidra address:
NTSC-U/C: 0x001c5270
Ghidra address:
PAL: 0x001ce010

◆ FlyButton()

void Overlay::FlyButton ( int nLane,
const Vector2 * pFrom,
const Vector2 * pTo )

Fly the button icon of a lane.

Parameters
nLaneThe lane.
pFromThe place the flight starts at.
pToThe place the flight ends at.
Ghidra address:
NTSC-U/C: 0x001c5290
Ghidra address:
PAL: 0x001ce030

◆ SetButtonPulse()

void Overlay::SetButtonPulse ( int nLane,
bool bPulse )

Start or stop the pulse of the button icon of a lane.

Parameters
nLaneThe lane.
bPulseWhether the icon pulses.
Ghidra address:
NTSC-U/C: 0x001c52c0
Ghidra address:
PAL: 0x001ce060

◆ HideButton()

void Overlay::HideButton ( int nLane)

Hide the button icon of a lane.

Parameters
nLaneThe lane.
Ghidra address:
NTSC-U/C: 0x001c52f0
Ghidra address:
PAL: 0x001ce090

◆ SetButtonGlyph()

void Overlay::SetButtonGlyph ( int nLane,
const char * pszGlyph )

Change the glyph of the button icon of a lane.

Parameters
nLaneThe lane.
pszGlyphThe glyph.
Ghidra address:
NTSC-U/C: 0x001c5318
Ghidra address:
PAL: 0x001ce0b8

◆ ShowController()

void Overlay::ShowController ( bool bShow,
float fPosition )

Slide the picture of the controller in or out and place it.

Parameters
bShowWhether to show the picture.
fPositionThe frame of HUD controller map pos.tnm, or a negative value to retain it.
Ghidra address:
NTSC-U/C: 0x001c5358
Ghidra address:
PAL: 0x001ce0f8

◆ SetControllerHighlight()

void Overlay::SetControllerHighlight ( bool bHighlight)

Light or darken the picture of the controller.

Parameters
bHighlightWhether to light the picture.
Ghidra address:
NTSC-U/C: 0x001c53c8
Ghidra address:
PAL: 0x001ce168

◆ ShowControllerButton()

void Overlay::ShowControllerButton ( int nButton,
bool bShow )

Show or hide a button of the picture of the controller.

Parameters
nButtonThe button, one of JoypadButton.
bShowWhether to show the button.
Ghidra address:
NTSC-U/C: 0x001c53f8
Ghidra address:
PAL: 0x001ce198

◆ OpenDialog()

void Overlay::OpenDialog ( const char * pszText,
float fSize,
float fPosition )

Fill the panel of text and slide it in.

Parameters
pszTextThe text.
fSizeThe frame of the size of the panel.
fPositionThe frame of the place of the panel, or a negative value to retain it.
Ghidra address:
NTSC-U/C: 0x001c5428
Ghidra address:
PAL: 0x001ce1c8

◆ CloseDialog()

void Overlay::CloseDialog ( )

Slide the panel of text out.

Ghidra address:
NTSC-U/C: 0x001c5458
Ghidra address:
PAL: 0x001ce1f8

◆ ShowPlayerOnTrack()

void Overlay::ShowPlayerOnTrack ( int nPlayer,
int nIndex )
inline

Show a player on a track.

The body is empty.

Parameters
nPlayerThe player.
nIndexThe place of the player among those on the track.
Ghidra address:
NTSC-U/C: 0x001c5488
Ghidra address:
PAL: 0x001ce228

◆ SetSectionCount()

void Overlay::SetSectionCount ( int nCount)

Show one blank entry per section of a remix.

Parameters
nCountThe number of sections.
Ghidra address:
NTSC-U/C: 0x001c5490
Ghidra address:
PAL: 0x001ce230

◆ SetSectionLabel()

void Overlay::SetSectionLabel ( int nIndex,
const char * pszLabel )

Set the label of a section of a remix.

Parameters
nIndexThe section.
pszLabelThe label.
Ghidra address:
NTSC-U/C: 0x001c54c0
Ghidra address:
PAL: 0x001ce260

◆ ShowSections()

void Overlay::ShowSections ( bool bShow)

Slide the sections of a remix in or out.

Parameters
bShowWhether to show the sections.
Ghidra address:
NTSC-U/C: 0x001c54f0
Ghidra address:
PAL: 0x001ce290

◆ HighlightSection()

void Overlay::HighlightSection ( int nIndex)

Light the entry of a section of a remix.

Parameters
nIndexThe section.
Ghidra address:
NTSC-U/C: 0x001c5528
Ghidra address:
PAL: 0x001ce2c8

◆ SetRemixPanelText()

void Overlay::SetRemixPanelText ( int nPlayer,
int nIndex,
const char * pszText,
int nPanel )

Set the text of an entry of a player's remix panel.

Parameters
nPlayerThe player.
nIndexThe entry.
pszTextThe text.
nPanelThe panel, one of GfxManager::RemixSubPanel.
Ghidra address:
NTSC-U/C: 0x001c5558
Ghidra address:
PAL: 0x001ce2f8

◆ SelectRemixPanelEntry()

void Overlay::SelectRemixPanelEntry ( int nPlayer,
int nIndex,
int nPanel )

Move the cursor of a player's remix panel to an entry.

Parameters
nPlayerThe player.
nIndexThe entry, or a negative value for none.
nPanelThe panel, one of GfxManager::RemixSubPanel.
Ghidra address:
NTSC-U/C: 0x001c55c0
Ghidra address:
PAL: 0x001ce360

◆ FlashRemixPanel()

void Overlay::FlashRemixPanel ( int nPlayer,
int nPanel )

Blink the cursor of a player's remix panel.

Parameters
nPlayerThe player.
nPanelThe panel, one of GfxManager::RemixSubPanel.
Ghidra address:
NTSC-U/C: 0x001c5620
Ghidra address:
PAL: 0x001ce3c0

◆ SetRemixPanelLit()

void Overlay::SetRemixPanelLit ( int nPlayer,
int nIndex,
int bLit,
int nPanel )

Light or darken an entry of a player's remix panel.

Parameters
nPlayerThe player.
nIndexThe entry.
bLitWhether to light the entry.
nPanelThe panel, one of GfxManager::RemixSubPanel.
Ghidra address:
NTSC-U/C: 0x001c5668
Ghidra address:
PAL: 0x001ce408

◆ ShowRemixPanel()

void Overlay::ShowRemixPanel ( int nPlayer,
int nPanel )

Slide out a panel of a player's remix menu.

Parameters
nPlayerThe player.
nPanelThe panel, one of GfxManager::RemixSubPanel.
Ghidra address:
NTSC-U/C: 0x001c56d0
Ghidra address:
PAL: 0x001ce470

◆ ShowRemix()

void Overlay::ShowRemix ( int nPlayer,
bool bShow )

Slide a player's remix menu in or out.

Parameters
nPlayerThe player.
bShowWhether to show the menu.
Ghidra address:
NTSC-U/C: 0x001c5710
Ghidra address:
PAL: 0x001ce4b0

◆ ShowStick()

void Overlay::ShowStick ( int nDirection,
const Vector2 * pPosition )

Show the stick marker of a remix.

Parameters
nDirectionThe material, one of HudStick::Direction.
pPositionThe place on the diagram.
Ghidra address:
NTSC-U/C: 0x001c5760
Ghidra address:
PAL: 0x001ce500

◆ HideStick()

void Overlay::HideStick ( )

Hide the stick marker of a remix.

Ghidra address:
NTSC-U/C: 0x001c5790
Ghidra address:
PAL: 0x001ce530

◆ SetCameraOffset()

void Overlay::SetCameraOffset ( const Vector3 * pOffset)

Move the display camera by an offset from its place in the layout.

Parameters
pOffsetThe offset.
Ghidra address:
NTSC-U/C: 0x001c57c0
Ghidra address:
PAL: 0x001ce560

◆ Reset()

void Overlay::Reset ( )

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

Ghidra address:
NTSC-U/C: 0x001c5860
Ghidra address:
PAL: 0x001ce600

◆ ClearStarted()

void Overlay::ClearStarted ( )

Let the parts show again once the song starts.

Ghidra address:
NTSC-U/C: 0x001c5918
Ghidra address:
PAL: 0x001ce6b8

◆ ShowCheckpoint()

void Overlay::ShowCheckpoint ( )

Show every score of a shared-screen game at its place in the ranking, with the bar of its share of the points.

Ghidra address:
NTSC-U/C: 0x001c5920
Ghidra address:
PAL: 0x001ce6c0

◆ ShowResult()

void Overlay::ShowResult ( bool bWon,
int nMode )

Show the result of a song: hide the energy bar of a lost song, or clear the pending points of a won one.

Parameters
bWonWhether the song was won.
nModeNot read.
Ghidra address:
NTSC-U/C: 0x001c5c80
Ghidra address:
PAL: 0x001cea20

◆ Poll()

void Overlay::Poll ( float fFrame,
float fSongDelta,
float fUnused,
float fRealDelta,
float fFuture )

Advance the display, and show its parts once the song is about to start.

Parameters
fFrameThe frame of hud.view, the song position in ticks.
fSongDeltaThe song time since the last poll.
fUnusedPassed to OvyLocalPlayer::Poll(), which does not read it.
fRealDeltaThe time since the last poll.
fFutureThe length of the future part of the song position bar.
Ghidra address:
NTSC-U/C: 0x001c5d18
Ghidra address:
PAL: 0x001ceab8

◆ Draw()

void Overlay::Draw ( )

Draw the display: the layout, the common parts, the parts of every player, and the avatars, the winner's last.

Ghidra address:
NTSC-U/C: 0x001c5f00
Ghidra address:
PAL: 0x001ceca0

◆ LoadConfig()

void Overlay::LoadConfig ( DataArray * pConfig,
DataArray * pDefaults,
bool bUnused )
static

Read the settings of the display from a configuration section and its defaults.

Parameters
pConfigThe configuration section, or null.
pDefaultsThe section of defaults, or null.
bUnusedPassed to OvyRemixPanel::LoadPositions(), which does not read it.
Ghidra address:
NTSC-U/C: 0x001c3690
Ghidra address:
PAL: 0x001cc430

◆ SetHudPrefix()

void Overlay::SetHudPrefix ( )
static

Choose the head-up display layout from the community and the rule set of the game.

A solo game and an online remix use HUD1, any other duel HUDd, and any other game HUDm.

Ghidra address:
NTSC-U/C: 0x001b6540
Ghidra address:
PAL: 0x001bf2e0

Member Data Documentation

◆ sHudLetter

char Overlay::sHudLetter
static

The letter of the head-up display layout, 1, d, or m.

Ghidra address:
NTSC-U/C: 0x0043b1e0

◆ sHudPrefix

const char* Overlay::sHudPrefix
static

The prefix of the head-up display layout's scene objects, HUD1, HUDd, or HUDm.

Ghidra address:
NTSC-U/C: 0x0043b1e4

◆ sAssemblyTime

float Overlay::sAssemblyTime
static

The time the head-up display takes to assemble, assembly_time.

Ghidra address:
NTSC-U/C: 0x003af918
Ghidra address:
PAL: 0x0042e7ac

◆ sHudZ

Vector2 Overlay::sHudZ
static

The depth range the display camera draws into, hud_z.

Ghidra address:
NTSC-U/C: 0x0043b158

◆ sPointsScale

float Overlay::sPointsScale
static

The scale of the points that fly off a score, hud_points_scale.

Ghidra address:
NTSC-U/C: 0x003af93c
Ghidra address:
PAL: 0x0042e7d0

◆ sDuelPointsMoveTicks

float Overlay::sDuelPointsMoveTicks
static

The ticks the points of a duel take to move, duel_points_move_ticks.

Ghidra address:
NTSC-U/C: 0x003af940
Ghidra address:
PAL: 0x0042e7d4

◆ sDuelPointsMoveRate

float Overlay::sDuelPointsMoveRate
static

One over sDuelPointsMoveTicks.

Ghidra address:
NTSC-U/C: 0x003af944
Ghidra address:
PAL: 0x0042e7d8

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