|
wavelength 1.0.0
|
Track whose phrases a player captures by playing them. More...
#include <catchtrack.h>


Classes | |
| class | DeactivateCmd |
| Command that ends the captured run of the track. More... | |
| class | CaptureReceiver |
| Receiver of the runs of the capturer of a track. More... | |
Public Member Functions | |
| CatchTrack (GameLogic *pLogic, CatchTrackData *pData, const float *pfMsPerTick, PlayMap *pPlayMap, SectionBoundaries *pSections, int nIndex, int nIntroBars, int nNumBars, int nTicksPerBar, int nFlags) | |
| Construct a catch track. | |
| ~CatchTrack () override | |
| Stop and release the track. | |
| void | Start () override |
| Start the display, the music, and the guide ticker of the track, once. | |
| void | Stop () override |
| Stop the track and every scheduled command. | |
| void | SetPlayer (Player *pPlayer) override |
| Give the track to the player it plays for. | |
| void | HandleInput (Player *pPlayer, const PlayNoteEvent &event) override |
| Pass a button press of the track's player to the capturer, or show another player that the track is behind. | |
| void | HandleInput (Player *pPlayer, const BtnEvent< 8 > &event) override |
| Ignore the input. | |
| void | HandleInput (Player *pPlayer, const StickEvent< 2 > &event) override |
| Ignore the input. | |
| void | HandleInput (Player *pPlayer, const StickEvent< 6 > &event) override |
| Ignore the input. | |
| void | HandleInput (Player *pPlayer, const BtnEvent< 10 > &event) override |
| Ignore the input. | |
| void | AddBackMusic (BackMusic *pMusic) |
| Play a background music track while a captured run of this track plays. | |
| void | Loop (int nBar) |
| Redraw the track from a bar and restart the capturer after the song gained a loop. | |
| void | SetPowerup (int nBar, int nPowerup) |
| Place a power-up in a bar. | |
| void | SetBarPowerup (int nBar, int nPowerup) |
| Place a power-up in a bar as written. | |
| void | Enable (int nBar) |
| Enable the bars with gems from a bar on, except the checkpoint bars at the start of each section, then redraw the track and start the capturer. | |
| void | Restart (Player *pPlayer, int nTick) |
| Enable every bar, give every bar to a player, and move the display to a tick. | |
| bool | HasPhraseAt (int nBar) |
| Report whether a phrase of the track is in a bar. | |
| bool | FindPhrase (int nBar, int *pTick, int *pLane) |
| Find the first gem of the next phrase from a bar. | |
| int | GetNextGemTick (int nTick, int *pLane) |
| Report the tick of the first gem at or after a tick. | |
| void | Capture (int nBar, Player *pPlayer) |
| Capture the phrase of a bar for a player. | |
| bool | Autocatch (int nBar, Player *pPlayer) |
| Capture the phrase of a bar or the next bar for a player with the autocatcher power-up. | |
| void | Freestyle (int nBar, int nBars, Player *pPlayer) |
| Give a player the freestyle power-up for a number of bars. | |
| void | AssignBars (int nBar, int nBars, Player *pPlayer) |
| Give a run of bars as written to a player, or take them from every player. | |
| void | SetAutopilot (bool bAutopilot) |
| Turn on or off the automatic play of the track's gems. | |
| void | SetNoSeeker (bool bNoSeeker) |
| Hide or show the seeker of the track. | |
| Public Member Functions inherited from Track | |
| Track (int nIndex) | |
| Construct a track with no player. | |
| virtual | ~Track () |
| Release the track. | |
| int | GetIndex () const |
| Player * | GetPlayer () const |
Static Public Member Functions | |
| static void | operator delete (void *pBlock) |
| Release a track to the pool heap GameLogic allocated it from. | |
Additional Inherited Members | |
| Protected Attributes inherited from Track | |
| int | mIndex |
| Player * | mPlayer |
Track whose phrases a player captures by playing them.
The RTTI records the class as deriving from Track, and includes the nested CatchTrack::DeactivateCmd and CatchTrack::CaptureReceiver. The object is 0x148 bytes, and GameLogic allocates it under the tag "CatchTrack". A captured run of bars plays its music and the background music of the track until the run ends.
| CatchTrack::CatchTrack | ( | GameLogic * | pLogic, |
| CatchTrackData * | pData, | ||
| const float * | pfMsPerTick, | ||
| PlayMap * | pPlayMap, | ||
| SectionBoundaries * | pSections, | ||
| int | nIndex, | ||
| int | nIntroBars, | ||
| int | nNumBars, | ||
| int | nTicksPerBar, | ||
| int | nFlags ) |
Construct a catch track.
| pLogic | The logic of the game. |
| pData | The gems of the track. |
| pfMsPerTick | The duration of one tick in milliseconds. |
| pPlayMap | The map of the song positions. |
| pSections | The sections of the song. |
| nIndex | The index of the track among the catch tracks. |
| nIntroBars | The bars before the first section. |
| nNumBars | The length of the song in bars. |
| nTicksPerBar | The length of a bar in ticks. |
| nFlags | Nonzero for each bar of music to stop the bar before it. |
|
override |
Stop and release the track.
|
inlinestatic |
Release a track to the pool heap GameLogic allocated it from.
| pBlock | The block. |
|
overridevirtual |
Start the display, the music, and the guide ticker of the track, once.
Implements Track.
|
overridevirtual |
Stop the track and every scheduled command.
Implements Track.
|
overridevirtual |
Give the track to the player it plays for.
| pPlayer | The player, or null. |
Reimplemented from Track.
|
overridevirtual |
Pass a button press of the track's player to the capturer, or show another player that the track is behind.
| pPlayer | The player. |
| event | The event. |
Implements Track.
|
inlineoverridevirtual |
Ignore the input.
| pPlayer | The player. |
| event | The event. |
Implements Track.
|
inlineoverridevirtual |
Ignore the input.
| pPlayer | The player. |
| event | The event. |
Implements Track.
|
inlineoverridevirtual |
Ignore the input.
| pPlayer | The player. |
| event | The event. |
Implements Track.
|
inlineoverridevirtual |
Ignore the input.
| pPlayer | The player. |
| event | The event. |
Implements Track.
| void CatchTrack::AddBackMusic | ( | BackMusic * | pMusic | ) |
Play a background music track while a captured run of this track plays.
| pMusic | The background music. |
| void CatchTrack::Loop | ( | int | nBar | ) |
Redraw the track from a bar and restart the capturer after the song gained a loop.
The name is inferred.
| nBar | The bar the loop plays from. |
| void CatchTrack::SetPowerup | ( | int | nBar, |
| int | nPowerup ) |
Place a power-up in a bar.
| nBar | The bar the song plays. |
| nPowerup | One of GameLogic::Powerup. |
| void CatchTrack::SetBarPowerup | ( | int | nBar, |
| int | nPowerup ) |
Place a power-up in a bar as written.
The name is inferred.
| nBar | The bar as written. |
| nPowerup | One of GameLogic::Powerup. |
| void CatchTrack::Enable | ( | int | nBar | ) |
Enable the bars with gems from a bar on, except the checkpoint bars at the start of each section, then redraw the track and start the capturer.
| nBar | The bar. A song with a loop enables every bar. |
| void CatchTrack::Restart | ( | Player * | pPlayer, |
| int | nTick ) |
Enable every bar, give every bar to a player, and move the display to a tick.
The name is inferred.
| pPlayer | The player, or null. |
| nTick | The song tick to show from. |
| bool CatchTrack::HasPhraseAt | ( | int | nBar | ) |
Report whether a phrase of the track is in a bar.
| nBar | The bar. |
| bool CatchTrack::FindPhrase | ( | int | nBar, |
| int * | pTick, | ||
| int * | pLane ) |
Find the first gem of the next phrase from a bar.
The name is inferred.
| nBar | The bar. |
| pTick | Receives the tick of the gem. |
| pLane | Receives the lane of the gem. |
| int CatchTrack::GetNextGemTick | ( | int | nTick, |
| int * | pLane ) |
Report the tick of the first gem at or after a tick.
| nTick | The tick. |
| pLane | Receives the lane of the gem when not null. |
| void CatchTrack::Capture | ( | int | nBar, |
| Player * | pPlayer ) |
Capture the phrase of a bar for a player.
| nBar | The bar. |
| pPlayer | The player. |
| bool CatchTrack::Autocatch | ( | int | nBar, |
| Player * | pPlayer ) |
Capture the phrase of a bar or the next bar for a player with the autocatcher power-up.
| nBar | The bar. |
| pPlayer | The player. |
| void CatchTrack::Freestyle | ( | int | nBar, |
| int | nBars, | ||
| Player * | pPlayer ) |
Give a player the freestyle power-up for a number of bars.
| nBar | The first bar. |
| nBars | The number of bars. |
| pPlayer | The player. |
| void CatchTrack::AssignBars | ( | int | nBar, |
| int | nBars, | ||
| Player * | pPlayer ) |
Give a run of bars as written to a player, or take them from every player.
The name is inferred.
| nBar | The first bar. |
| nBars | The number of bars. |
| pPlayer | The player, or null. |
| void CatchTrack::SetAutopilot | ( | bool | bAutopilot | ) |
Turn on or off the automatic play of the track's gems.
The name is inferred.
| bAutopilot | Play the gems automatically. |
| void CatchTrack::SetNoSeeker | ( | bool | bNoSeeker | ) |
Hide or show the seeker of the track.
The name is inferred.
| bNoSeeker | Hide the seeker. |