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

Display of the play field and the heads-up display of every player. More...

#include <gfxmanager.h>

Inheritance diagram for GfxManager:
Collaboration diagram for GfxManager:

Classes

class  GfxLoader
 Loader of one file of the load list of the gfx configuration. More...
struct  LocalViews
 Views of the camera of one player, in the order they draw. More...
struct  DebugMsg
 Message the display lists for debugging. More...

Public Types

enum  PollResult { kPollWorldReady = 1 , kPollUnloaded = 2 }
 The values of Poll() that WorldMgr tests. More...
enum  State { kStateIdle = 0 , kStateLoading = 1 , kStatePlaying = 2 , kStateUnloading = 3 }
 The values of mState. More...
enum  LoadStage { kLoadStageConfig = 0 , kLoadStageHud = 1 , kLoadStageObjects = 2 }
 The values of mLoadStage. More...
enum  Instrument {
  kInstrumentDrum = 0 , kInstrumentBass = 1 , kInstrumentSynth = 2 , kInstrumentGuitar = 3 ,
  kInstrumentVocal = 4 , kInstrumentFx = 5 , kNumInstruments = 6
}
 The instruments of the tracks, known to scripts as kDrum through kFX. More...
enum  PlayerColor {
  kPlayerColorGreen = 0 , kPlayerColorPurple = 1 , kPlayerColorRed = 2 , kPlayerColorYellow = 3 ,
  kPlayerColorNull = 4 , kPlayerColorUnknown = 5 , kNumPlayerColors = 6
}
 The colours of the player slots. More...
enum  PendingPointsResult { kPendingPointsCleared = 0 , kPendingPointsCaptured = 1 , kPendingPointsLost = 2 }
 What SetPendingPointsResult() shows happened to a player's pending points. More...
enum  RemixSubPanel {
  kRemixSubPanelMain = 0 , kRemixSubPanelPattern = 1 , kRemixSubPanelChorus = 2 , kRemixSubPanelStutter = 3 ,
  kRemixSubPanelEcho = 4 , kRemixSubPanelBoot = 5 , kRemixSubPanelTempo = 6
}
 Sub-panel of a player's remix menu. More...

Public Member Functions

 GfxManager ()
 Construct an idle display.
 ~GfxManager () override
 Release the display.
void Print (const char *pszText) override
 Discard text written to the display as a stream.
void Init ()
 Load the cache of textures, register the display script commands, and read the configuration.
void Terminate ()
 Tear down a loaded world, destroy the vortex, and unregister what Init() registered.
void Reset ()
 Return the display to its state with no world.
void Load (float fTime)
 Start to load the files of the display for a world.
void BuildTracks (float fStartTick, float fEndTick, const float *pMsPerTick, const std::vector< int > &instruments, const std::vector< int > &trackTypes, int nOption, const std::vector< bool > &unlocked)
 Build the display of the tracks of a song.
void Unload ()
 Start changing the display back after the world was destroyed.
int Poll (float fTime)
 Advance the display.
void Draw (float fTick)
 Draw the display.
float StartIntro (float fLength)
 Start the run of the vortex into the play field.
bool IsIntroFinished () const
 Report whether the run StartIntro() began has ended.
float RestartIntro ()
 Start the run of the vortex out of the play field.
float StartOutro (float fLength)
 Start the run of the vortex at the end of a song.
bool IsOutroDone ()
 Report whether the run StartOutro() started is done.
void AddPreload (const char *pszFile)
 Queue a file to stream before the world loads.
AsyncStream * FindPreload (const char *pszFile)
 Find the stream of a queued file and wait for it to finish.
int GetTrackInstrument (int nTrack)
 Report the instrument of a track.
int GetTrackType (int nTrack)
 Report the type of a track.
void HandleBeat (signed char nEvent)
 Run the arena effect of a beat event of the song.
void StartBossJourney ()
 Start the journey to the boss arena that follows the boss unlock.
int IsBossJourneyDone ()
 Report whether the journey StartBossJourney() started is done.
bool IsIdle ()
 Report whether the tunnel finished its effects.
void SetEnergy (int nPlayer, float fEnergy)
 Show the energy of the play field of a solo game.
void SetDying (int nPlayer, bool bDying)
 Show whether a player runs out of energy.
void SetScore (int nPlayer, int nScore, int nMultiplier, int nPoints)
 Show a player's score.
void SetStreakMultiplier (int nPlayer, int nMultiplier, int nNextMultiplier, bool bBoosted)
 Show a player's streak multiplier and the one the next capture earns.
void ShowPendingPoints (int nPlayer, int nPoints)
 Show the points a player's current phrase is worth.
void HidePendingPoints (int nPlayer)
 Hide a player's pending points.
void SetPendingPointsResult (int nPlayer, PendingPointsResult result)
 Show what happened to a player's pending points.
void SetLeader (int nPlayer, bool bLeader)
 Mark whether a player leads the score.
void ShowSongPos (bool bShow)
 Show or hide the position in the song.
void ShowTrackLabels (bool bShow)
 Show or hide the labels of the tracks.
void ShowPowerup (int nPlayer, int nPowerup)
 Show the power-up icon of a player.
void SetMultiplierEndTick (int nPlayer, float fTick)
 Show the song tick a player's multiplier power-up ends at.
void ShowSlowdown (int nPlayer, float fStartTick, float fEndTick, float fStopTick)
 Show the slowdown a player deployed.
void ShowCripple (int nAttacker, int nVictim)
 Show a player crippling another.
void ShowBump (int nAttacker, int nVictim, int nTrack)
 Show a player knocking another off a track with a bumper.
void ShowMessage (const char *pszLine, const char *pszSecondLine, int nPlayer, float fDurationMs, float fScale, float fOffsetY, float fOffsetX)
 Show a message of one or two lines.
void SetLyricText (const char *pszText, bool bFirstLine)
 Show the lyric text.
void ShowButtonIcon (int nLane, const Vector2 *pPosition, const Vector2 *pTarget)
 Fly the controller button icon of a lane across the screen.
void SetButtonIconHighlight (int nLane, int nHighlight)
 Highlight the controller button icon of a lane, or clear the highlight.
void HideButtonIcon (int nLane)
 Hide the controller button icon of a lane.
void SetButtonIconGlyph (int nLane, const char *pszGlyph)
 Set the glyph the controller button icon of a lane shows.
void ShowController (bool bShow, float fPosition)
 Show or hide the diagram of the controller.
void SetControllerHighlight (bool bHighlight)
 Highlight the diagram of the controller, or clear the highlight.
void ShowControllerButton (int nButton, bool bShow)
 Show or hide one button of the diagram of the controller.
void OpenDialog (const char *pszText, float fSize, int nPosition)
 Open the dialog box with a text.
void CloseDialog ()
 Close the dialog box.
void SetLetterbox (bool bClosed)
 Close or open the letterbox.
void ShowBox (bool bShow)
 Show or hide the highlight box.
void ShowArrow (bool bShow)
 Show or hide the highlight arrow.
void SetBoxRect (float fX0, float fY0, float fX1, float fY1, float fDuration)
 Move the highlight box.
void SetArrowTarget (float fX, float fY, float fAngle, float fDuration)
 Move the highlight arrow.
void ShowStick (int nDirection, const Vector2 *pPosition)
 Show the diagram of a stick.
void HideStick ()
 Hide the diagram of a stick.
void SetSectionCount (int nCount)
 Set the number of sections of the song the remix display lists.
void SetSectionLabel (int nIndex, const char *pszLabel)
 Set the label of a section of the song.
void ShowSections (bool bShow)
 Show or hide the sections of the song.
void HighlightSection (int nIndex)
 Highlight a section of the song.
void SetRemixPanelText (int nPlayer, int nIndex, const char *pszText, RemixSubPanel ePanel)
 Set the text of an entry of a remix sub-panel.
void SelectRemixPanelEntry (int nPlayer, int nIndex, RemixSubPanel ePanel)
 Move the cursor of a remix sub-panel to an entry.
void FlashRemixPanel (int nPlayer, RemixSubPanel ePanel)
 Flash the cursor of a remix sub-panel to confirm a choice.
void SetRemixPanelLit (int nPlayer, int nIndex, int nLit, RemixSubPanel ePanel)
 Light or darken an entry of a remix sub-panel.
void ShowRemixPanel (int nPlayer, RemixSubPanel ePanel)
 Show one sub-panel of a player's remix menu.
void ShowRemix (int nPlayer, bool bShow)
 Show or hide a player's remix menu.
void SetFreqSize (int nPlayer, int nSize)
 Set the size of the display of the tracks of a player.
void SetWinner (int nPlayer)
 Mark the winner of a song.
void SetTrackPlayers (int nTrack, int nPlayers, const int *pPlayers)
 Show which players are on a track.
void ShowPlayerOnTrack (int nPlayer, int nTrack)
 Move a player to a track.
void SetTrackInstrument (int nTrack, int nInstrument)
 Show the instrument a track changed to, on the track and on every player on it.
void ShowPlayerOnFreestyleTrack (int nPlayer, int nType, int nInstrument, bool bVictory, int nReserved)
 Show a player on the freestyle track.
int GetViewedTrack (int nPlayer)
 Report the track the camera of a player shows.
void SetFreestylePosition (int nPlayer, const Vector3 &position)
 Move a player's freestyle effect to a position of the first stick.
void SetFreestyleSecondPosition (int nPlayer, const Vector3 &position)
 Ignore a position of the second stick for a player's freestyle effect.
void ShowScratchNote (int nPlayer, float fTick, float fDuration)
 Show a note a scratch plays on a player's track.
void PlaceGem (int nTrack, int nSlot, int nPlayer, float fTick, int nStyle, int nFlags)
 Place a gem on the play field.
void RemoveGem (int nTrack, int nSlot, float fTick)
 Take a gem off the play field.
void ClearGems (int nTrack, bool bAll, float fStartTick, float fEndTick)
 Remove the gems of a track in a range of ticks.
void HideNextPhrase (int nPlayer)
 Hide the pointers to the next phrase.
void ShowNextPhrase (int nTrack, float fTick, int nGemType)
 Point at the next phrase on a track.
void SetCatchMeter (int nPlayer, float fLevel)
 Set the meter that shows how much of a phrase a player has caught.
void ShowGemResult (int nTrack, int nSlot, bool bHit, int nPlayer, int nFlags, float fTick)
 Show the result of a gem a player played or removed.
void HitGem (int nPlayer, int nTrack, int nSlot, float fTick)
 Show a player hitting a gem.
void SetFreestyle (int nPlayer, bool bActive, int nColumn)
 Show or hide a player's freestyle effect.
void ResetFreestyle (int nPlayer)
 Return a player's freestyle effect to its idle state.
void ShowCapture (int nPlayer, int nTrack, int nStyle, bool bQuiet, float fStartTick, float fEndTick)
 Show a player catching a phrase.
void CompleteStage (int nPlayer, int nSection)
 Rank the score bars at the end of a section and, in a solo game, fire the triggers that wait on it.
void ShowResult (bool bWon, int nPlayer, bool bUnlocked)
 Show the result of a song.
void ShowPhrase (int nPlayer, int nTrack, bool bPlayable, float fStartTick, float fEndTick, int nStyle, bool bSlide)
 Show the bars of a phrase on a track, from the camera of a player.
void SetBar (int nTrack, int nPlayer, int nOwner, bool bInSong, bool bVisible, int nFlags, signed char nRiff, float fTick, float fTicks)
 Set the look of one bar of a track.
void DimBar (int nTrack, float fTick)
 Dim one bar of a track.
void SetTrackEnabled (int nTrack, bool bEnabled)
 Show a track as enabled or disabled.
void AddCheckpoint (const char *pszLabel, float fTick, float fOffset, float fScale)
 Place a checkpoint on the tracks and on the position in the song.
void ClearCheckpoints ()
 Remove every checkpoint.
void SetOption (bool bOption)
 Set the display option a solo player toggles.
bool GetOption ()
 Report the display option a solo player toggles.
void SetScrollSpeed (float fSpeed)
 Set the scroll speed of the lanes.
void BlendToArenaPath (bool bArena)
 Blend the camera of the tunnel towards the arena path or back.
void SetPlayerShown (int nPlayer, bool bShown)
 Show or hide the ship of a player.
void SetCatcherShown (int nPlayer, bool bShown)
 Show or hide the catcher of a player.
void SetEnergyShown (int nPlayer, bool bShown)
 Show or hide the energy meter.
void SetScoreShown (int nPlayer, bool bShown)
 Show or hide the score of a player.
void SetLaneShown (int nPlayer, bool bShown)
 Show or hide the avatar display of a player.
void ShowHud (bool bShow)
 Show or hide the display of the players' scores and meters over the tracks.
void ClearLanes ()
 Clear the highlights of the cameras and reset the head-up display.
void ClearAll ()
 Clear every effect of the tunnel, reset the ships and the panels of the arena, and clear the start of the head-up display.
void SetActive (bool bActive)
 Start or stop the victory lap.
const Color * GetInstrumentColor (int nInstrument) const
 Report the colour of an instrument, inst_color_<instrument>.
const Color * GetInstrumentBgColor (int nInstrument) const
 Report the background colour of an instrument, inst_bg_color_<instrument>.
const Color * GetPlayerColor (int nPlayer) const
 Report the colour of a player, player_color_<colour>.
const Color * GetPlayerBgColor (int nPlayer) const
 Report the background colour of a player, player_bg_color_<colour>.
Vortex * GetVortex () const
int GetVortexAfterViews () const
void SetVortexAfterViews (int nValue)
 Set whether the vortex draws after the head-up display.
const std::list< GfxLoader > & GetLoaders () const
const std::list< std::unique_ptr< AsyncStream > > & GetPreloads () const
int GetLoadStage () const
RndLoader * GetHudLoader () const
int GetLoaded () const
float GetLoadStartMs () const
int GetState () const
float GetLastTick () const
float GetLastTime () const
float GetScrollSpeed () const
float GetInvScrollSpeed () const
float GetSongTicks () const
void SetSongTicks (float fValue)
 Set the length of the song in ticks.
float GetCamPathScale () const
int GetVictoryLap () const
void SetVictoryLap (int nValue)
 Set whether the victory lap runs.
int GetArenaUnlocked () const
int GetNoArena () const
int GetMonkeyGems () const
int GetDrugs () const
int GetBlackPanels () const
int GetNoPanels () const
signed char GetTunnelShape () const
int GetHudFlags () const
GfxTunnel * GetTunnel () const
Overlay * GetOverlay () const
GfxArena * GetArena () const
RndView * GetTunnelView () const
RndView * GetMainView () const
const std::vector< LocalViews > & GetLocalViews () const
RndView * GetPanelView () const
const std::unique_ptr< Ship > * GetShips () const
Ship * GetShip (int nPlayer) const
 Report the ship of a player.
int GetLeader () const
void SetLeader (int nValue)
 Set the player in the lead.
int GetWinnerDrawn () const
void SetWinnerDrawn (int nValue)
 Set whether the winner's avatar was drawn this frame.
int GetWinner () const
const float * GetMsPerTick () const
const char * GetMultiplierFormat () const
const std::list< DebugMsg > & GetDebugMsgs () const
const std::list< DebugMsg > & GetDebugMsgs2 () const
Public Member Functions inherited from PrnStream
 PrnStream ()
 Construct a stream with a dump level of 0.
virtual ~PrnStream ()
 Release the stream.
void Printf (const char *pszFormat,...)
 Format text into the shared format buffer and write the result through Print().
PrnStream & operator<< (const char *pszText)
 Write text.
PrnStream & operator<< (char ch)
 Write a character.
PrnStream & operator<< (short nValue)
 Write a short integer in decimal.
PrnStream & operator<< (int nValue)
 Write an integer in decimal.
PrnStream & operator<< (unsigned char nValue)
 Write a byte as an unsigned integer in decimal.
PrnStream & operator<< (unsigned short nValue)
 Write an unsigned short integer in decimal.
PrnStream & operator<< (unsigned int nValue)
 Write an unsigned integer in decimal.
PrnStream & operator<< (unsigned long long nValue)
 Write an unsigned 64-bit number in decimal.
PrnStream & operator<< (float fValue)
 Write a number with two decimals.
PrnStream & operator<< (bool bValue)
 Write true or false.
void Space (int nCount)
 Write a number of spaces, one Print() call each.
int GetDumpLevel () const
 PrnStream ()
virtual ~PrnStream ()
 Destroy the stream.
void Printf (const char *format,...)
 Format text with printf() conventions and write it.
PrnStream & operator<< (char c)
 Write a character.
PrnStream & operator<< (int i)
 Write an integer in decimal.
PrnStream & operator<< (float f)
 Write a number with two decimal places.
PrnStream & operator<< (const char *str)
 Write text.
void Space (int count)
 Write spaces.

Static Public Attributes

static constexpr int kMaxPlayers = 4
 The number of ships the display has, one for each player.
static Color sInstrumentColors [kNumInstruments]
 The colours of the instruments, indexed by Instrument.
static Color sInstrumentBgColors [kNumInstruments]
 The background colours of the instruments, indexed by Instrument.
static Color sPlayerColors [kNumPlayerColors]
 The colours of the player slots, indexed by PlayerColor.
static Color sPlayerBgColors [kNumPlayerColors]
 The background colours of the player slots, indexed by PlayerColor.
static DataArray * sMergesAlwaysAllowed
 The textures that may be skipped by a load without a report, merges_always_allowed.
static float sEnergyHighZone
 The energy at which the top zone of the meter starts.
static float sEnergyLowZone
 The energy at which the middle zone of the meter starts.
static int sInitialized
 Whether Init() ran.
static int sTerminated
 Whether Terminate() ran.

Detailed Description

Display of the play field and the heads-up display of every player.

The RTTI records the class as deriving from PrnStream. The object is 0xd4 bytes, and the one instance is TheGfxManager. The display manages the arena, the tunnel of tracks, the ship of each player, and the head-up display, and most of its routines forward to them.

Member Enumeration Documentation

◆ PollResult

The values of Poll() that WorldMgr tests.

Enumerator
kPollWorldReady 

The display is ready for a loading world to load its assets.

kPollUnloaded 

The display finished changing back after an unload.

◆ State

The values of mState.

Enumerator
kStateIdle 

No world is loaded.

kStateLoading 

Load() started to load a world.

kStatePlaying 

BuildTracks() built the tracks of the song.

kStateUnloading 

Unload() started to change the display back.

◆ LoadStage

The values of mLoadStage.

Enumerator
kLoadStageConfig 

The head-up display has not read its configuration.

kLoadStageHud 

The file of the head-up display loads.

kLoadStageObjects 

The head-up display and the ships are built.

◆ Instrument

The instruments of the tracks, known to scripts as kDrum through kFX.

Enumerator
kInstrumentDrum 

drum.

kInstrumentBass 

bass.

kInstrumentSynth 

synth.

kInstrumentGuitar 

guitar.

kInstrumentVocal 

vocal.

kInstrumentFx 

fx.

kNumInstruments 

The number of instruments.

◆ PlayerColor

The colours of the player slots.

Enumerator
kPlayerColorGreen 

green.

kPlayerColorPurple 

purple.

kPlayerColorRed 

red.

kPlayerColorYellow 

yellow.

kPlayerColorNull 

null.

kPlayerColorUnknown 

unknown.

kNumPlayerColors 

The number of colours.

◆ PendingPointsResult

What SetPendingPointsResult() shows happened to a player's pending points.

Enumerator
kPendingPointsCleared 

The pending points were reset.

kPendingPointsCaptured 

The pending points were added to the score.

kPendingPointsLost 

The pending points were forfeited.

◆ RemixSubPanel

Sub-panel of a player's remix menu.

The RTTI includes the name as an argument of a command template. The names of the effect panels follow their scene objects pat, chs, stt, eco, bot, and bpm.

Enumerator
kRemixSubPanelMain 

The list of remix panels.

kRemixSubPanelPattern 

The pat panel. OvyRemixPanel never builds it.

kRemixSubPanelChorus 

The chorus effect.

kRemixSubPanelStutter 

The stutter effect.

kRemixSubPanelEcho 

The echo effect.

kRemixSubPanelBoot 

The list of the players the host can remove.

kRemixSubPanelTempo 

The tempo control.

Constructor & Destructor Documentation

◆ GfxManager()

GfxManager::GfxManager ( )

Construct an idle display.

Ghidra address:
NTSC-U/C: 0x001b1550
Ghidra address:
PAL: 0x001ba2f0

◆ ~GfxManager()

GfxManager::~GfxManager ( )
override

Release the display.

Ghidra address:
NTSC-U/C: 0x001b1790
Ghidra address:
PAL: 0x001ba530

Member Function Documentation

◆ Print()

void GfxManager::Print ( const char * pszText)
inlineoverridevirtual

Discard text written to the display as a stream.

The body is empty.

Parameters
pszTextThe text.
Ghidra address:
NTSC-U/C: 0x001b4450
Ghidra address:
PAL: 0x001bd1f0

Implements PrnStream.

◆ Init()

void GfxManager::Init ( )

Load the cache of textures, register the display script commands, and read the configuration.

Ghidra address:
NTSC-U/C: 0x001b1cc0
Ghidra address:
PAL: 0x001baa60

◆ Terminate()

void GfxManager::Terminate ( )

Tear down a loaded world, destroy the vortex, and unregister what Init() registered.

Ghidra address:
NTSC-U/C: 0x001b1ed8
Ghidra address:
PAL: 0x001bac78

◆ Reset()

void GfxManager::Reset ( )

Return the display to its state with no world.

Ghidra address:
NTSC-U/C: 0x001b2030
Ghidra address:
PAL: 0x001badd0

◆ Load()

void GfxManager::Load ( float fTime)

Start to load the files of the display for a world.

Parameters
fTimeThe time the display starts at. WorldMgr passes -1.
Ghidra address:
NTSC-U/C: 0x001b2068
Ghidra address:
PAL: 0x001bae08

◆ BuildTracks()

void GfxManager::BuildTracks ( float fStartTick,
float fEndTick,
const float * pMsPerTick,
const std::vector< int > & instruments,
const std::vector< int > & trackTypes,
int nOption,
const std::vector< bool > & unlocked )

Build the display of the tracks of a song.

Parameters
fStartTickThe tick the song starts at.
fEndTickThe tick the song ends at.
pMsPerTickThe milliseconds per tick of the song clock.
instrumentsThe instrument of each track.
trackTypesThe type of each track.
nOptionThe option of the tracks.
unlockedOne flag for each path of the song, set for the unlocked ones.
Ghidra address:
NTSC-U/C: 0x001b2688
Ghidra address:
PAL: 0x001bb428

◆ Unload()

void GfxManager::Unload ( )

Start changing the display back after the world was destroyed.

Ghidra address:
NTSC-U/C: 0x001b3458
Ghidra address:
PAL: 0x001bc1f8

◆ Poll()

int GfxManager::Poll ( float fTime)

Advance the display.

Parameters
fTimeThe time of the display.
Returns
One of PollResult, or 0.
Ghidra address:
NTSC-U/C: 0x001b37f8
Ghidra address:
PAL: 0x001bc598

◆ Draw()

void GfxManager::Draw ( float fTick)

Draw the display.

Parameters
fTickThe running world's position in ticks, or 0 when no world is running. The display does not read it.
Ghidra address:
NTSC-U/C: 0x001b3d10
Ghidra address:
PAL: 0x001bcab0

◆ StartIntro()

float GfxManager::StartIntro ( float fLength)

Start the run of the vortex into the play field.

Parameters
fLengthThe length of the run in milliseconds, or -1 for the configured length.
Returns
The configured length of the run, in milliseconds.
Ghidra address:
NTSC-U/C: 0x001b34c8
Ghidra address:
PAL: 0x001bc268

◆ IsIntroFinished()

bool GfxManager::IsIntroFinished ( ) const

Report whether the run StartIntro() began has ended.

Returns
True once the run has ended.
Ghidra address:
NTSC-U/C: 0x001b3508
Ghidra address:
PAL: 0x001bc2a8

◆ RestartIntro()

float GfxManager::RestartIntro ( )

Start the run of the vortex out of the play field.

Returns
The configured length of the run, in milliseconds.
Ghidra address:
NTSC-U/C: 0x001b3520
Ghidra address:
PAL: 0x001bc2c0

◆ StartOutro()

float GfxManager::StartOutro ( float fLength)

Start the run of the vortex at the end of a song.

Parameters
fLengthThe length of the run in milliseconds, or a negative value for the configured length.
Returns
The configured length of the run, in milliseconds.
Ghidra address:
NTSC-U/C: 0x001b3560
Ghidra address:
PAL: 0x001bc300

◆ IsOutroDone()

bool GfxManager::IsOutroDone ( )

Report whether the run StartOutro() started is done.

Returns
Whether the run is done.
Ghidra address:
NTSC-U/C: 0x001b35a8
Ghidra address:
PAL: 0x001bc348

◆ AddPreload()

void GfxManager::AddPreload ( const char * pszFile)

Queue a file to stream before the world loads.

Parameters
pszFileThe file.
Ghidra address:
NTSC-U/C: 0x001b42f8
Ghidra address:
PAL: 0x001bd098

◆ FindPreload()

AsyncStream * GfxManager::FindPreload ( const char * pszFile)

Find the stream of a queued file and wait for it to finish.

Parameters
pszFileThe file.
Returns
The stream, or null with a warning when the file is not queued.
Ghidra address:
NTSC-U/C: 0x001b43b8
Ghidra address:
PAL: 0x001bd158

◆ GetTrackInstrument()

int GfxManager::GetTrackInstrument ( int nTrack)

Report the instrument of a track.

Parameters
nTrackThe track.
Returns
The instrument.
Ghidra address:
NTSC-U/C: 0x001b42b8
Ghidra address:
PAL: 0x001bd058

◆ GetTrackType()

int GfxManager::GetTrackType ( int nTrack)

Report the type of a track.

Parameters
nTrackThe track.
Returns
The type.
Ghidra address:
NTSC-U/C: 0x001b42d8
Ghidra address:
PAL: 0x001bd078

◆ HandleBeat()

void GfxManager::HandleBeat ( signed char nEvent)

Run the arena effect of a beat event of the song.

Parameters
nEventThe event.
Ghidra address:
NTSC-U/C: 0x001b4290
Ghidra address:
PAL: 0x001bd030

◆ StartBossJourney()

void GfxManager::StartBossJourney ( )

Start the journey to the boss arena that follows the boss unlock.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x001b56b0
Ghidra address:
PAL: 0x001be450

◆ IsBossJourneyDone()

int GfxManager::IsBossJourneyDone ( )

Report whether the journey StartBossJourney() started is done.

The name is inferred.

Returns
Non-zero once the journey is done.
Ghidra address:
NTSC-U/C: 0x001b56f8
Ghidra address:
PAL: 0x001be498

◆ IsIdle()

bool GfxManager::IsIdle ( )

Report whether the tunnel finished its effects.

Returns
True when the tunnel is idle.
Ghidra address:
NTSC-U/C: 0x001b56e8
Ghidra address:
PAL: 0x001be488

◆ SetEnergy()

void GfxManager::SetEnergy ( int nPlayer,
float fEnergy )

Show the energy of the play field of a solo game.

A game that is not solo does not show the energy. Practice shows a full meter.

Parameters
nPlayerThe player's index.
fEnergyThe energy, from 0 to 1.
Ghidra address:
NTSC-U/C: 0x001b4d68
Ghidra address:
PAL: 0x001bdb08

◆ SetDying()

void GfxManager::SetDying ( int nPlayer,
bool bDying )

Show whether a player runs out of energy.

Parameters
nPlayerThe player's index.
bDyingWhether the player runs out of energy.
Ghidra address:
NTSC-U/C: 0x001b4f40
Ghidra address:
PAL: 0x001bdce0

◆ SetScore()

void GfxManager::SetScore ( int nPlayer,
int nScore,
int nMultiplier,
int nPoints )

Show a player's score.

Parameters
nPlayerThe player's index.
nScoreThe new score.
nMultiplierThe streak multiplier the points were scored at. The display does not read it.
nPointsThe points just added, or 0. The display does not read them.
Ghidra address:
NTSC-U/C: 0x001b4f90
Ghidra address:
PAL: 0x001bdd30

◆ SetStreakMultiplier()

void GfxManager::SetStreakMultiplier ( int nPlayer,
int nMultiplier,
int nNextMultiplier,
bool bBoosted )

Show a player's streak multiplier and the one the next capture earns.

The texts of the multipliers are built only for a player on this console, and only for a multiplier above 1.

Parameters
nPlayerThe player's index.
nMultiplierThe current streak multiplier.
nNextMultiplierThe streak multiplier after one more capture.
bBoostedWhether a multiplier power-up is active.
Ghidra address:
NTSC-U/C: 0x001b4fd8
Ghidra address:
PAL: 0x001bdd78

◆ ShowPendingPoints()

void GfxManager::ShowPendingPoints ( int nPlayer,
int nPoints )

Show the points a player's current phrase is worth.

Parameters
nPlayerThe player's index.
nPointsThe points.
Ghidra address:
NTSC-U/C: 0x001b50d0
Ghidra address:
PAL: 0x001bde70

◆ HidePendingPoints()

void GfxManager::HidePendingPoints ( int nPlayer)

Hide a player's pending points.

Parameters
nPlayerThe player's index.
Ghidra address:
NTSC-U/C: 0x001b5150
Ghidra address:
PAL: 0x001bdef0

◆ SetPendingPointsResult()

void GfxManager::SetPendingPointsResult ( int nPlayer,
PendingPointsResult result )

Show what happened to a player's pending points.

Parameters
nPlayerThe player's index.
resultWhat happened to the points.
Ghidra address:
NTSC-U/C: 0x001b5170
Ghidra address:
PAL: 0x001bdf10

◆ SetLeader() [1/2]

void GfxManager::SetLeader ( int nPlayer,
bool bLeader )

Mark whether a player leads the score.

Parameters
nPlayerThe player's index.
bLeaderWhether the player leads.
Ghidra address:
NTSC-U/C: 0x001b5190
Ghidra address:
PAL: 0x001bdf30

◆ ShowSongPos()

void GfxManager::ShowSongPos ( bool bShow)

Show or hide the position in the song.

Parameters
bShowWhether the position is shown.
Ghidra address:
NTSC-U/C: 0x001b51d8
Ghidra address:
PAL: 0x001bdf78

◆ ShowTrackLabels()

void GfxManager::ShowTrackLabels ( bool bShow)

Show or hide the labels of the tracks.

Parameters
bShowWhether the labels are shown.
Ghidra address:
NTSC-U/C: 0x001b51f8
Ghidra address:
PAL: 0x001bdf98

◆ ShowPowerup()

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

Show the power-up icon of a player.

Parameters
nPlayerThe player's index.
nPowerupThe kind of power-up the player has, or GameLogic::kPowerupNone to hide the icon.
Ghidra address:
NTSC-U/C: 0x001b5218
Ghidra address:
PAL: 0x001bdfb8

◆ SetMultiplierEndTick()

void GfxManager::SetMultiplierEndTick ( int nPlayer,
float fTick )

Show the song tick a player's multiplier power-up ends at.

Parameters
nPlayerThe player's index.
fTickThe tick.
Ghidra address:
NTSC-U/C: 0x001b5240
Ghidra address:
PAL: 0x001bdfe0

◆ ShowSlowdown()

void GfxManager::ShowSlowdown ( int nPlayer,
float fStartTick,
float fEndTick,
float fStopTick )

Show the slowdown a player deployed.

Parameters
nPlayerThe player's index.
fStartTickThe tick the song arrives at the slow speed.
fEndTickThe tick the song starts to speed up again.
fStopTickThe tick the song is back at its speed.
Ghidra address:
NTSC-U/C: 0x001b5260
Ghidra address:
PAL: 0x001be000

◆ ShowCripple()

void GfxManager::ShowCripple ( int nAttacker,
int nVictim )

Show a player crippling another.

Parameters
nAttackerThe index of the player who deployed the crippler.
nVictimThe index of the player struck.
Ghidra address:
NTSC-U/C: 0x001b5280
Ghidra address:
PAL: 0x001be020

◆ ShowBump()

void GfxManager::ShowBump ( int nAttacker,
int nVictim,
int nTrack )

Show a player knocking another off a track with a bumper.

Parameters
nAttackerThe index of the player who deployed the bumper.
nVictimThe index of the player struck.
nTrackThe track the victim moves to.
Ghidra address:
NTSC-U/C: 0x001b52a0
Ghidra address:
PAL: 0x001be040

◆ ShowMessage()

void GfxManager::ShowMessage ( const char * pszLine,
const char * pszSecondLine,
int nPlayer,
float fDurationMs,
float fScale,
float fOffsetY,
float fOffsetX )

Show a message of one or two lines.

Parameters
pszLineThe first line.
pszSecondLineThe second line, or null.
nPlayerThe player the message is for, or -1 for every player.
fDurationMsThe time the message stays on the screen, in milliseconds.
fScaleThe scale of the text.
fOffsetYThe vertical offset of the message.
fOffsetXThe horizontal offset of the message.
Ghidra address:
NTSC-U/C: 0x001b5320
Ghidra address:
PAL: 0x001be0c0

◆ SetLyricText()

void GfxManager::SetLyricText ( const char * pszText,
bool bFirstLine )

Show the lyric text.

Parameters
pszTextThe text.
bFirstLineShow the text on the first line.
Ghidra address:
NTSC-U/C: 0x001b5340
Ghidra address:
PAL: 0x001be0e0

◆ ShowButtonIcon()

void GfxManager::ShowButtonIcon ( int nLane,
const Vector2 * pPosition,
const Vector2 * pTarget )

Fly the controller button icon of a lane across the screen.

Parameters
nLaneThe lane.
pPositionThe position of the icon on the screen.
pTargetThe position the icon moves to.
Ghidra address:
NTSC-U/C: 0x001b5360
Ghidra address:
PAL: 0x001be100

◆ SetButtonIconHighlight()

void GfxManager::SetButtonIconHighlight ( int nLane,
int nHighlight )

Highlight the controller button icon of a lane, or clear the highlight.

Parameters
nLaneThe lane.
nHighlightNon-zero to highlight the icon.
Ghidra address:
NTSC-U/C: 0x001b5380
Ghidra address:
PAL: 0x001be120

◆ HideButtonIcon()

void GfxManager::HideButtonIcon ( int nLane)

Hide the controller button icon of a lane.

Parameters
nLaneThe lane.
Ghidra address:
NTSC-U/C: 0x001b53a0
Ghidra address:
PAL: 0x001be140

◆ SetButtonIconGlyph()

void GfxManager::SetButtonIconGlyph ( int nLane,
const char * pszGlyph )

Set the glyph the controller button icon of a lane shows.

Parameters
nLaneThe lane.
pszGlyphThe glyph of the button, or null.
Ghidra address:
NTSC-U/C: 0x001b53c0
Ghidra address:
PAL: 0x001be160

◆ ShowController()

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

Show or hide the diagram of the controller.

Parameters
bShowWhether the diagram is shown.
fPositionThe position of the diagram, or -1 for the configured one.
Ghidra address:
NTSC-U/C: 0x001b53e0
Ghidra address:
PAL: 0x001be180

◆ SetControllerHighlight()

void GfxManager::SetControllerHighlight ( bool bHighlight)

Highlight the diagram of the controller, or clear the highlight.

Parameters
bHighlightWhether the diagram is highlighted.
Ghidra address:
NTSC-U/C: 0x001b5400
Ghidra address:
PAL: 0x001be1a0

◆ ShowControllerButton()

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

Show or hide one button of the diagram of the controller.

Parameters
nButtonThe button.
bShowWhether the button is shown.
Ghidra address:
NTSC-U/C: 0x001b5420
Ghidra address:
PAL: 0x001be1c0

◆ OpenDialog()

void GfxManager::OpenDialog ( const char * pszText,
float fSize,
int nPosition )

Open the dialog box with a text.

Parameters
pszTextThe text.
fSizeThe size of the box.
nPositionThe position of the box, or -1 for the configured one.
Ghidra address:
NTSC-U/C: 0x001b5440
Ghidra address:
PAL: 0x001be1e0

◆ CloseDialog()

void GfxManager::CloseDialog ( )

Close the dialog box.

Ghidra address:
NTSC-U/C: 0x001b5468
Ghidra address:
PAL: 0x001be208

◆ SetLetterbox()

void GfxManager::SetLetterbox ( bool bClosed)

Close or open the letterbox.

Parameters
bClosedWhether the letterbox closes.
Ghidra address:
NTSC-U/C: 0x001b5488
Ghidra address:
PAL: 0x001be228

◆ ShowBox()

void GfxManager::ShowBox ( bool bShow)

Show or hide the highlight box.

Parameters
bShowWhether the box is shown.
Ghidra address:
NTSC-U/C: 0x001b54a8
Ghidra address:
PAL: 0x001be248

◆ ShowArrow()

void GfxManager::ShowArrow ( bool bShow)

Show or hide the highlight arrow.

Parameters
bShowWhether the arrow is shown.
Ghidra address:
NTSC-U/C: 0x001b54c8
Ghidra address:
PAL: 0x001be268

◆ SetBoxRect()

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

Move the highlight box.

Parameters
fX0The left edge.
fY0The top edge.
fX1The right edge.
fY1The bottom edge.
fDurationThe time the move takes.
Ghidra address:
NTSC-U/C: 0x001b54e8
Ghidra address:
PAL: 0x001be288

◆ SetArrowTarget()

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

Move the highlight arrow.

Parameters
fXThe horizontal position.
fYThe vertical position.
fAngleThe angle of the arrow.
fDurationThe time the move takes.
Ghidra address:
NTSC-U/C: 0x001b5508
Ghidra address:
PAL: 0x001be2a8

◆ ShowStick()

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

Show the diagram of a stick.

Parameters
nDirectionThe direction the diagram shows.
pPositionThe position of the diagram.
Ghidra address:
NTSC-U/C: 0x001b5528
Ghidra address:
PAL: 0x001be2c8

◆ HideStick()

void GfxManager::HideStick ( )

Hide the diagram of a stick.

Ghidra address:
NTSC-U/C: 0x001b5548
Ghidra address:
PAL: 0x001be2e8

◆ SetSectionCount()

void GfxManager::SetSectionCount ( int nCount)

Set the number of sections of the song the remix display lists.

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

◆ SetSectionLabel()

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

Set the label of a section of the song.

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

◆ ShowSections()

void GfxManager::ShowSections ( bool bShow)

Show or hide the sections of the song.

Parameters
bShowWhether the sections are shown.
Ghidra address:
NTSC-U/C: 0x001b55a8
Ghidra address:
PAL: 0x001be348

◆ HighlightSection()

void GfxManager::HighlightSection ( int nIndex)

Highlight a section of the song.

Parameters
nIndexThe section.
Ghidra address:
NTSC-U/C: 0x001b55c8
Ghidra address:
PAL: 0x001be368

◆ SetRemixPanelText()

void GfxManager::SetRemixPanelText ( int nPlayer,
int nIndex,
const char * pszText,
RemixSubPanel ePanel )

Set the text of an entry of a remix sub-panel.

Parameters
nPlayerThe player's index.
nIndexThe entry.
pszTextThe text.
ePanelThe sub-panel.
Ghidra address:
NTSC-U/C: 0x001b55e8
Ghidra address:
PAL: 0x001be388

◆ SelectRemixPanelEntry()

void GfxManager::SelectRemixPanelEntry ( int nPlayer,
int nIndex,
RemixSubPanel ePanel )

Move the cursor of a remix sub-panel to an entry.

Parameters
nPlayerThe player's index.
nIndexThe entry, or -1 for none.
ePanelThe sub-panel.
Ghidra address:
NTSC-U/C: 0x001b5608
Ghidra address:
PAL: 0x001be3a8

◆ FlashRemixPanel()

void GfxManager::FlashRemixPanel ( int nPlayer,
RemixSubPanel ePanel )

Flash the cursor of a remix sub-panel to confirm a choice.

Parameters
nPlayerThe player's index.
ePanelThe sub-panel.
Ghidra address:
NTSC-U/C: 0x001b5630
Ghidra address:
PAL: 0x001be3d0

◆ SetRemixPanelLit()

void GfxManager::SetRemixPanelLit ( int nPlayer,
int nIndex,
int nLit,
RemixSubPanel ePanel )

Light or darken an entry of a remix sub-panel.

Parameters
nPlayerThe player's index.
nIndexThe entry.
nLitNon-zero to light the entry.
ePanelThe sub-panel.
Ghidra address:
NTSC-U/C: 0x001b5650
Ghidra address:
PAL: 0x001be3f0

◆ ShowRemixPanel()

void GfxManager::ShowRemixPanel ( int nPlayer,
RemixSubPanel ePanel )

Show one sub-panel of a player's remix menu.

Parameters
nPlayerThe player's index.
ePanelThe sub-panel.
Ghidra address:
NTSC-U/C: 0x001b5670
Ghidra address:
PAL: 0x001be410

◆ ShowRemix()

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

Show or hide a player's remix menu.

Parameters
nPlayerThe player's index.
bShowWhether the menu is shown.
Ghidra address:
NTSC-U/C: 0x001b5690
Ghidra address:
PAL: 0x001be430

◆ SetFreqSize()

void GfxManager::SetFreqSize ( int nPlayer,
int nSize )

Set the size of the display of the tracks of a player.

Parameters
nPlayerThe index of the player.
nSizeOne of GameOptions::FreqSize.
Ghidra address:
NTSC-U/C: 0x001b5708
Ghidra address:
PAL: 0x001be4a8

◆ SetWinner()

void GfxManager::SetWinner ( int nPlayer)

Mark the winner of a song.

Parameters
nPlayerThe winner's index, or -1 for none.
Ghidra address:
NTSC-U/C: 0x001b5728
Ghidra address:
PAL: 0x001be4c8

◆ SetTrackPlayers()

void GfxManager::SetTrackPlayers ( int nTrack,
int nPlayers,
const int * pPlayers )

Show which players are on a track.

Parameters
nTrackThe track.
nPlayersThe number of players on the track.
pPlayersThe players, in the order they arrived, or null when there are none.
Ghidra address:
NTSC-U/C: 0x001b5730
Ghidra address:
PAL: 0x001be4d0

◆ ShowPlayerOnTrack()

void GfxManager::ShowPlayerOnTrack ( int nPlayer,
int nTrack )

Move a player to a track.

Parameters
nPlayerThe player's index.
nTrackThe track.
Ghidra address:
NTSC-U/C: 0x001b57b0
Ghidra address:
PAL: 0x001be550

◆ SetTrackInstrument()

void GfxManager::SetTrackInstrument ( int nTrack,
int nInstrument )

Show the instrument a track changed to, on the track and on every player on it.

Parameters
nTrackThe track.
nInstrumentThe instrument.
Ghidra address:
NTSC-U/C: 0x001b5878
Ghidra address:
PAL: 0x001be618

◆ ShowPlayerOnFreestyleTrack()

void GfxManager::ShowPlayerOnFreestyleTrack ( int nPlayer,
int nType,
int nInstrument,
bool bVictory,
int nReserved )

Show a player on the freestyle track.

Parameters
nPlayerThe player's index.
nTypeThe track type of the freestyle track.
nInstrumentThe instrument of the freestyle track.
bVictoryWhether the freestyle rewards a won song.
nReservedEvery caller passes 0.
Ghidra address:
NTSC-U/C: 0x001b5970
Ghidra address:
PAL: 0x001be710

◆ GetViewedTrack()

int GfxManager::GetViewedTrack ( int nPlayer)

Report the track the camera of a player shows.

Parameters
nPlayerThe player's index.
Returns
The track.
Ghidra address:
NTSC-U/C: 0x001b59f8
Ghidra address:
PAL: 0x001be798

◆ SetFreestylePosition()

void GfxManager::SetFreestylePosition ( int nPlayer,
const Vector3 & position )

Move a player's freestyle effect to a position of the first stick.

Parameters
nPlayerThe player index.
positionThe stick position in the horizontal and depth components.
Ghidra address:
NTSC-U/C: 0x001b5a30
Ghidra address:
PAL: 0x001be7d0

◆ SetFreestyleSecondPosition()

void GfxManager::SetFreestyleSecondPosition ( int nPlayer,
const Vector3 & position )
inline

Ignore a position of the second stick for a player's freestyle effect.

The body is empty.

Parameters
nPlayerThe player index.
positionThe stick position in the horizontal and depth components.
Ghidra address:
NTSC-U/C: 0x001b5a50
Ghidra address:
PAL: 0x001be7f0

◆ ShowScratchNote()

void GfxManager::ShowScratchNote ( int nPlayer,
float fTick,
float fDuration )

Show a note a scratch plays on a player's track.

Parameters
nPlayerThe player's index.
fTickThe song tick of the note.
fDurationThe length of the note in ticks.
Ghidra address:
NTSC-U/C: 0x001b5a58
Ghidra address:
PAL: 0x001be7f8

◆ PlaceGem()

void GfxManager::PlaceGem ( int nTrack,
int nSlot,
int nPlayer,
float fTick,
int nStyle,
int nFlags )

Place a gem on the play field.

Parameters
nTrackThe track.
nSlotThe gem button the gem lies under.
nPlayerThe player the gem is for, or -1.
fTickThe tick of the gem.
nStyleThe style of the gem.
nFlagsThe flags of the gem.
Ghidra address:
NTSC-U/C: 0x001b5a78
Ghidra address:
PAL: 0x001be818

◆ RemoveGem()

void GfxManager::RemoveGem ( int nTrack,
int nSlot,
float fTick )

Take a gem off the play field.

Parameters
nTrackThe track.
nSlotThe gem button the gem lies under.
fTickThe tick of the gem.
Ghidra address:
NTSC-U/C: 0x001b5a98
Ghidra address:
PAL: 0x001be838

◆ ClearGems()

void GfxManager::ClearGems ( int nTrack,
bool bAll,
float fStartTick,
float fEndTick )

Remove the gems of a track in a range of ticks.

Parameters
nTrackThe track.
bAllWhether every kind of gem is removed.
fStartTickThe first tick of the range.
fEndTickThe tick after the range.
Ghidra address:
NTSC-U/C: 0x001b5ab8
Ghidra address:
PAL: 0x001be858

◆ HideNextPhrase()

void GfxManager::HideNextPhrase ( int nPlayer)

Hide the pointers to the next phrase.

Parameters
nPlayerThe player's index.
Ghidra address:
NTSC-U/C: 0x001b5ad8
Ghidra address:
PAL: 0x001be878

◆ ShowNextPhrase()

void GfxManager::ShowNextPhrase ( int nTrack,
float fTick,
int nGemType )

Point at the next phrase on a track.

Parameters
nTrackThe track.
fTickThe tick of the first gem of the phrase.
nGemTypeThe type of that gem.
Ghidra address:
NTSC-U/C: 0x001b5af8
Ghidra address:
PAL: 0x001be898

◆ SetCatchMeter()

void GfxManager::SetCatchMeter ( int nPlayer,
float fLevel )

Set the meter that shows how much of a phrase a player has caught.

Parameters
nPlayerThe player's index.
fLevelThe level, from 0 to 1.
Ghidra address:
NTSC-U/C: 0x001b5b20
Ghidra address:
PAL: 0x001be8c0

◆ ShowGemResult()

void GfxManager::ShowGemResult ( int nTrack,
int nSlot,
bool bHit,
int nPlayer,
int nFlags,
float fTick )

Show the result of a gem a player played or removed.

The triggers fire for the leader, and for every player outside a game.

Parameters
nTrackThe track.
nSlotThe gem button of the gem.
bHitWhether the gem counts as hit.
nPlayerThe player's index.
nFlagsThe flags of the display.
fTickThe tick of the gem.
Ghidra address:
NTSC-U/C: 0x001b5b70
Ghidra address:
PAL: 0x001be910

◆ HitGem()

void GfxManager::HitGem ( int nPlayer,
int nTrack,
int nSlot,
float fTick )

Show a player hitting a gem.

Parameters
nPlayerThe player's index.
nTrackThe track.
nSlotThe gem button the gem lies under.
fTickThe tick of the gem.
Ghidra address:
NTSC-U/C: 0x001b5c40
Ghidra address:
PAL: 0x001be9e0

◆ SetFreestyle()

void GfxManager::SetFreestyle ( int nPlayer,
bool bActive,
int nColumn )

Show or hide a player's freestyle effect.

Parameters
nPlayerThe player index.
bActiveShow the effect.
nColumnThe column the effect is drawn at.
Ghidra address:
NTSC-U/C: 0x001b5cc0
Ghidra address:
PAL: 0x001bea60

◆ ResetFreestyle()

void GfxManager::ResetFreestyle ( int nPlayer)

Return a player's freestyle effect to its idle state.

Parameters
nPlayerThe player index.
Ghidra address:
NTSC-U/C: 0x001b5ce0
Ghidra address:
PAL: 0x001bea80

◆ ShowCapture()

void GfxManager::ShowCapture ( int nPlayer,
int nTrack,
int nStyle,
bool bQuiet,
float fStartTick,
float fEndTick )

Show a player catching a phrase.

Parameters
nPlayerThe player's index.
nTrackThe track.
nStyleThe style of the display. DuelTrack passes 0.
bQuietWhether the status display is not told. DuelTrack passes false.
fStartTickThe tick the phrase starts at.
fEndTickThe tick after the phrase.
Ghidra address:
NTSC-U/C: 0x001b5d00
Ghidra address:
PAL: 0x001beaa0

◆ CompleteStage()

void GfxManager::CompleteStage ( int nPlayer,
int nSection )

Rank the score bars at the end of a section and, in a solo game, fire the triggers that wait on it.

Parameters
nPlayerThe player whose completion the triggers receive.
nSectionThe section. The display does not read it.
Ghidra address:
NTSC-U/C: 0x001b5db0
Ghidra address:
PAL: 0x001beb50

◆ ShowResult()

void GfxManager::ShowResult ( bool bWon,
int nPlayer,
bool bUnlocked )

Show the result of a song.

Parameters
bWonWhether the song was won.
nPlayerThe player.
bUnlockedWhether winning the song unlocked a new one.
Ghidra address:
NTSC-U/C: 0x001b5e00
Ghidra address:
PAL: 0x001beba0

◆ ShowPhrase()

void GfxManager::ShowPhrase ( int nPlayer,
int nTrack,
bool bPlayable,
float fStartTick,
float fEndTick,
int nStyle,
bool bSlide )

Show the bars of a phrase on a track, from the camera of a player.

Parameters
nPlayerThe player's index.
nTrackThe track.
bPlayableWhether the player plays the phrase.
fStartTickThe tick the phrase starts at.
fEndTickThe tick after the phrase.
nStyleThe style of the display.
bSlideWhether the camera moves to the phrase.
Ghidra address:
NTSC-U/C: 0x001b5f08
Ghidra address:
PAL: 0x001beca8

◆ SetBar()

void GfxManager::SetBar ( int nTrack,
int nPlayer,
int nOwner,
bool bInSong,
bool bVisible,
int nFlags,
signed char nRiff,
float fTick,
float fTicks )

Set the look of one bar of a track.

Parameters
nTrackThe track.
nPlayerThe player whose camera shows the bar.
nOwnerThe player the bar belongs to, or -1.
bInSongWhether the bar maps to a bar of the song.
bVisibleWhether the bar is shown.
nFlagsThe flags of the bar.
nRiffThe riff of the bar, or -1.
fTickThe tick the bar starts at.
fTicksThe length of the bar in ticks.
Ghidra address:
NTSC-U/C: 0x001b5f30
Ghidra address:
PAL: 0x001becd0

◆ DimBar()

void GfxManager::DimBar ( int nTrack,
float fTick )

Dim one bar of a track.

Parameters
nTrackThe track.
fTickThe tick the bar starts at.
Ghidra address:
NTSC-U/C: 0x001b5f58
Ghidra address:
PAL: 0x001becf8

◆ SetTrackEnabled()

void GfxManager::SetTrackEnabled ( int nTrack,
bool bEnabled )

Show a track as enabled or disabled.

Parameters
nTrackThe track.
bEnabledWhether the track is enabled.
Ghidra address:
NTSC-U/C: 0x001b5f78
Ghidra address:
PAL: 0x001bed18

◆ AddCheckpoint()

void GfxManager::AddCheckpoint ( const char * pszLabel,
float fTick,
float fOffset,
float fScale )

Place a checkpoint on the tracks and on the position in the song.

The position in the song is the fraction of the song the tick makes, or fOffset when the arena does not know the length of the song.

Parameters
pszLabelThe label of the checkpoint, or null.
fTickThe tick of the checkpoint.
fOffsetThe position in the song used when the length of the song is unknown.
fScaleThe scale of the checkpoint.
Ghidra address:
NTSC-U/C: 0x001b5f98
Ghidra address:
PAL: 0x001bed38

◆ ClearCheckpoints()

void GfxManager::ClearCheckpoints ( )

Remove every checkpoint.

Ghidra address:
NTSC-U/C: 0x001b6030
Ghidra address:
PAL: 0x001bedd0

◆ SetOption()

void GfxManager::SetOption ( bool bOption)

Set the display option a solo player toggles.

Parameters
bOptionThe option.
Ghidra address:
NTSC-U/C: 0x001b6060
Ghidra address:
PAL: 0x001bee00

◆ GetOption()

bool GfxManager::GetOption ( )

Report the display option a solo player toggles.

Returns
The option.
Ghidra address:
NTSC-U/C: 0x001b6080
Ghidra address:
PAL: 0x001bee20

◆ SetScrollSpeed()

void GfxManager::SetScrollSpeed ( float fSpeed)

Set the scroll speed of the lanes.

Parameters
fSpeedThe speed, 1 for normal.
Ghidra address:
NTSC-U/C: 0x001b60a0
Ghidra address:
PAL: 0x001bee40

◆ BlendToArenaPath()

void GfxManager::BlendToArenaPath ( bool bArena)

Blend the camera of the tunnel towards the arena path or back.

The name is inferred.

Parameters
bArenaBlend towards the arena path.
Ghidra address:
NTSC-U/C: 0x001b60c8
Ghidra address:
PAL: 0x001bee68

◆ SetPlayerShown()

void GfxManager::SetPlayerShown ( int nPlayer,
bool bShown )

Show or hide the ship of a player.

Parameters
nPlayerThe player's index.
bShownWhether the ship is shown.
Ghidra address:
NTSC-U/C: 0x001b60e8
Ghidra address:
PAL: 0x001bee88

◆ SetCatcherShown()

void GfxManager::SetCatcherShown ( int nPlayer,
bool bShown )

Show or hide the catcher of a player.

Parameters
nPlayerThe player's index.
bShownWhether the catcher is shown.
Ghidra address:
NTSC-U/C: 0x001b6110
Ghidra address:
PAL: 0x001beeb0

◆ SetEnergyShown()

void GfxManager::SetEnergyShown ( int nPlayer,
bool bShown )

Show or hide the energy meter.

Parameters
nPlayerThe player's index. The display does not read it.
bShownWhether the meter is shown.
Ghidra address:
NTSC-U/C: 0x001b6130
Ghidra address:
PAL: 0x001beed0

◆ SetScoreShown()

void GfxManager::SetScoreShown ( int nPlayer,
bool bShown )

Show or hide the score of a player.

Parameters
nPlayerThe player's index.
bShownWhether the score is shown.
Ghidra address:
NTSC-U/C: 0x001b6150
Ghidra address:
PAL: 0x001beef0

◆ SetLaneShown()

void GfxManager::SetLaneShown ( int nPlayer,
bool bShown )

Show or hide the avatar display of a player.

Parameters
nPlayerThe player's index.
bShownWhether the display is shown.
Ghidra address:
NTSC-U/C: 0x001b6170
Ghidra address:
PAL: 0x001bef10

◆ ShowHud()

void GfxManager::ShowHud ( bool bShow)

Show or hide the display of the players' scores and meters over the tracks.

Parameters
bShowWhether the display shows.
Ghidra address:
NTSC-U/C: 0x001b6190
Ghidra address:
PAL: 0x001bef30

◆ ClearLanes()

void GfxManager::ClearLanes ( )

Clear the highlights of the cameras and reset the head-up display.

Ghidra address:
NTSC-U/C: 0x001b61b0
Ghidra address:
PAL: 0x001bef50

◆ ClearAll()

void GfxManager::ClearAll ( )

Clear every effect of the tunnel, reset the ships and the panels of the arena, and clear the start of the head-up display.

Ghidra address:
NTSC-U/C: 0x001b61e0
Ghidra address:
PAL: 0x001bef80

◆ SetActive()

void GfxManager::SetActive ( bool bActive)

Start or stop the victory lap.

The victory lap hides the energy and score bars.

Parameters
bActiveWhether the victory lap runs.
Ghidra address:
NTSC-U/C: 0x001b6250
Ghidra address:
PAL: 0x001beff0

◆ GetInstrumentColor()

const Color * GfxManager::GetInstrumentColor ( int nInstrument) const

Report the colour of an instrument, inst_color_<instrument>.

Parameters
nInstrumentThe instrument, one of Instrument.
Returns
The colour.
Ghidra address:
NTSC-U/C: 0x001b4cc0
Ghidra address:
PAL: 0x001bda60

◆ GetInstrumentBgColor()

const Color * GfxManager::GetInstrumentBgColor ( int nInstrument) const

Report the background colour of an instrument, inst_bg_color_<instrument>.

Parameters
nInstrumentThe instrument, one of Instrument.
Returns
The colour.
Ghidra address:
NTSC-U/C: 0x001b4ce0
Ghidra address:
PAL: 0x001bda80

◆ GetPlayerColor()

const Color * GfxManager::GetPlayerColor ( int nPlayer) const

Report the colour of a player, player_color_<colour>.

Parameters
nPlayerThe player.
Returns
The colour of the player's slot.
Ghidra address:
NTSC-U/C: 0x001b4cf8
Ghidra address:
PAL: 0x001bda98

◆ GetPlayerBgColor()

const Color * GfxManager::GetPlayerBgColor ( int nPlayer) const

Report the background colour of a player, player_bg_color_<colour>.

Parameters
nPlayerThe player.
Returns
The colour of the player's slot.
Ghidra address:
NTSC-U/C: 0x001b4d30
Ghidra address:
PAL: 0x001bdad0

◆ GetVortex()

Vortex * GfxManager::GetVortex ( ) const
inline
Returns
The vortex of the intro and the outro. Belongs to the display.

◆ GetVortexAfterViews()

int GfxManager::GetVortexAfterViews ( ) const
inline
Returns
Whether the vortex draws after the head-up display.

◆ SetVortexAfterViews()

void GfxManager::SetVortexAfterViews ( int nValue)
inline

Set whether the vortex draws after the head-up display.

Parameters
nValueThe new value.

◆ GetLoaders()

const std::list< GfxLoader > & GfxManager::GetLoaders ( ) const
inline
Returns
The loaders of the files of the load list.

◆ GetPreloads()

const std::list< std::unique_ptr< AsyncStream > > & GfxManager::GetPreloads ( ) const
inline
Returns
The streams of data_preloads. Belongs to the display.

◆ GetLoadStage()

int GfxManager::GetLoadStage ( ) const
inline
Returns
One of LoadStage.

◆ GetHudLoader()

RndLoader * GfxManager::GetHudLoader ( ) const
inline
Returns
The loader of the head-up display, or null. Borrowed.

◆ GetLoaded()

int GfxManager::GetLoaded ( ) const
inline
Returns
Whether the files of the world have loaded.

◆ GetLoadStartMs()

float GfxManager::GetLoadStartMs ( ) const
inline
Returns
The system time Load() ran at.

◆ GetState()

int GfxManager::GetState ( ) const
inline
Returns
One of State.

◆ GetLastTick()

float GfxManager::GetLastTick ( ) const
inline
Returns
The song tick of the last poll.

◆ GetLastTime()

float GfxManager::GetLastTime ( ) const
inline
Returns
The song time of the last poll.

◆ GetScrollSpeed()

float GfxManager::GetScrollSpeed ( ) const
inline
Returns
The scroll speed of the tunnel.

◆ GetInvScrollSpeed()

float GfxManager::GetInvScrollSpeed ( ) const
inline
Returns
The reciprocal of the scroll speed.

◆ GetSongTicks()

float GfxManager::GetSongTicks ( ) const
inline
Returns
The length of the song in ticks.

◆ SetSongTicks()

void GfxManager::SetSongTicks ( float fValue)
inline

Set the length of the song in ticks.

Parameters
fValueThe new value.

◆ GetCamPathScale()

float GfxManager::GetCamPathScale ( ) const
inline
Returns
The length of the camera path for each tick.

◆ GetVictoryLap()

int GfxManager::GetVictoryLap ( ) const
inline
Returns
Whether the victory lap runs.

◆ SetVictoryLap()

void GfxManager::SetVictoryLap ( int nValue)
inline

Set whether the victory lap runs.

Parameters
nValueThe new value.

◆ GetArenaUnlocked()

int GfxManager::GetArenaUnlocked ( ) const
inline
Returns
Whether the path of the arena is unlocked.

◆ GetNoArena()

int GfxManager::GetNoArena ( ) const
inline
Returns
The no_arena cheat.

◆ GetMonkeyGems()

int GfxManager::GetMonkeyGems ( ) const
inline
Returns
The monkey cheat.

◆ GetDrugs()

int GfxManager::GetDrugs ( ) const
inline
Returns
The drugs cheat.

◆ GetBlackPanels()

int GfxManager::GetBlackPanels ( ) const
inline
Returns
The black_panels cheat.

◆ GetNoPanels()

int GfxManager::GetNoPanels ( ) const
inline
Returns
The no_panels cheat.

◆ GetTunnelShape()

signed char GfxManager::GetTunnelShape ( ) const
inline
Returns
The shape of the circular cheat, from 0 to 2.

◆ GetHudFlags()

int GfxManager::GetHudFlags ( ) const
inline
Returns
The display of toggle_hud.

◆ GetTunnel()

GfxTunnel * GfxManager::GetTunnel ( ) const
inline
Returns
The tunnel of tracks, or null. Belongs to the display.

◆ GetOverlay()

Overlay * GfxManager::GetOverlay ( ) const
inline
Returns
The head-up display, or null. Belongs to the display.

◆ GetArena()

GfxArena * GfxManager::GetArena ( ) const
inline
Returns
The arena, or null. Belongs to the display.

◆ GetTunnelView()

RndView * GfxManager::GetTunnelView ( ) const
inline
Returns
The tunnelview view, or null. Borrowed.

◆ GetMainView()

RndView * GfxManager::GetMainView ( ) const
inline
Returns
The main view of the tunnel, or null. Borrowed.

◆ GetLocalViews()

const std::vector< LocalViews > & GfxManager::GetLocalViews ( ) const
inline
Returns
The views of each player.

◆ GetPanelView()

RndView * GfxManager::GetPanelView ( ) const
inline
Returns
panel mat render.view, or null. Borrowed.

◆ GetShips()

const std::unique_ptr< Ship > * GfxManager::GetShips ( ) const
inline
Returns
The ship of each player, or null. Each ship belongs to the display.

◆ GetShip()

Ship * GfxManager::GetShip ( int nPlayer) const
inline

Report the ship of a player.

Parameters
nPlayerThe player.
Returns
The ship, or null.

◆ GetLeader()

int GfxManager::GetLeader ( ) const
inline
Returns
The player in the lead.

◆ SetLeader() [2/2]

void GfxManager::SetLeader ( int nValue)
inline

Set the player in the lead.

Parameters
nValueThe new value.

◆ GetWinnerDrawn()

int GfxManager::GetWinnerDrawn ( ) const
inline
Returns
Whether the winner's avatar was drawn this frame.

◆ SetWinnerDrawn()

void GfxManager::SetWinnerDrawn ( int nValue)
inline

Set whether the winner's avatar was drawn this frame.

Parameters
nValueThe new value.

◆ GetWinner()

int GfxManager::GetWinner ( ) const
inline
Returns
The winning player, or -1.

◆ GetMsPerTick()

const float * GfxManager::GetMsPerTick ( ) const
inline
Returns
The milliseconds per tick of the song, or null. Borrowed.

◆ GetMultiplierFormat()

const char * GfxManager::GetMultiplierFormat ( ) const
inline
Returns
The localised MULTIPLIER_FORMAT. Borrowed.

◆ GetDebugMsgs()

const std::list< DebugMsg > & GfxManager::GetDebugMsgs ( ) const
inline
Returns
Messages for debugging.

◆ GetDebugMsgs2()

const std::list< DebugMsg > & GfxManager::GetDebugMsgs2 ( ) const
inline
Returns
More messages for debugging.

Member Data Documentation

◆ kMaxPlayers

int GfxManager::kMaxPlayers = 4
staticconstexpr

The number of ships the display has, one for each player.

◆ sInstrumentColors

Color GfxManager::sInstrumentColors[kNumInstruments]
static

The colours of the instruments, indexed by Instrument.

Ghidra address:
NTSC-U/C: 0x0043aea0

◆ sInstrumentBgColors

Color GfxManager::sInstrumentBgColors[kNumInstruments]
static

The background colours of the instruments, indexed by Instrument.

Ghidra address:
NTSC-U/C: 0x0043af00

◆ sPlayerColors

Color GfxManager::sPlayerColors[kNumPlayerColors]
static

The colours of the player slots, indexed by PlayerColor.

Ghidra address:
NTSC-U/C: 0x0043af60

◆ sPlayerBgColors

Color GfxManager::sPlayerBgColors[kNumPlayerColors]
static

The background colours of the player slots, indexed by PlayerColor.

Ghidra address:
NTSC-U/C: 0x0043afc0

◆ sMergesAlwaysAllowed

DataArray* GfxManager::sMergesAlwaysAllowed
static

The textures that may be skipped by a load without a report, merges_always_allowed.

Ghidra address:
NTSC-U/C: 0x003af8f4
Ghidra address:
PAL: 0x0042e788

◆ sEnergyHighZone

float GfxManager::sEnergyHighZone
static

The energy at which the top zone of the meter starts.

Ghidra address:
NTSC-U/C: 0x003af8f8
Ghidra address:
PAL: 0x0042e78c

◆ sEnergyLowZone

float GfxManager::sEnergyLowZone
static

The energy at which the middle zone of the meter starts.

Ghidra address:
NTSC-U/C: 0x003af8fc
Ghidra address:
PAL: 0x0042e790

◆ sInitialized

int GfxManager::sInitialized
static

Whether Init() ran.

Ghidra address:
NTSC-U/C: 0x003af900
Ghidra address:
PAL: 0x0042e794

◆ sTerminated

int GfxManager::sTerminated
static

Whether Terminate() ran.

Ghidra address:
NTSC-U/C: 0x003af904
Ghidra address:
PAL: 0x0042e798

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