|
wavelength 1.0.0
|
Lyrics of a song loop, each shown when the song reaches its tick. More...
#include <lyric.h>
Classes | |
| class | LyricData |
| One lyric and the tick it is shown at. More... | |
Public Member Functions | |
| Lyric (int nTicksPerBar, int nLoopBars) | |
| Construct an empty lyric track and register the lyric script command. | |
| ~Lyric () | |
| Stop showing lyrics and unregister the lyric script command. | |
| void | AddLyric (int nTick, const char *pszText) |
| Add a lyric. | |
| void | Start () |
| Clear the lyric and schedule the first one. | |
| void | Stop () |
| Withdraw the scheduled lyric. | |
| void | Advance () |
| Show the current lyric and schedule the next one. | |
Static Public Member Functions | |
| static void | ToggleShowing (DataArray *pCommand, void *pUserData) |
| Toggle whether lyrics show on the display, the lyric script command. | |
Lyrics of a song loop, each shown when the song reaches its tick.
The RTTI includes the class name. The lyrics repeat every loop of mLoopBars bars. Each lyric is handed to TheTriggerMgr, and also shown on the first lyric line of TheGfxManager while the lyric cheat shows lyrics. A lyric before the first tick of the loop is shown only on the first pass.
| Lyric::Lyric | ( | int | nTicksPerBar, |
| int | nLoopBars ) |
Construct an empty lyric track and register the lyric script command.
| nTicksPerBar | The song ticks in one bar. |
| nLoopBars | The bars in one loop. |
| Lyric::~Lyric | ( | ) |
Stop showing lyrics and unregister the lyric script command.
| void Lyric::AddLyric | ( | int | nTick, |
| const char * | pszText ) |
Add a lyric.
A lyric whose tick falls at or past the end of the loop is ignored, and so is a second lyric at a tick already used.
| nTick | The tick within the loop. |
| pszText | The text. |
| void Lyric::Start | ( | ) |
Clear the lyric and schedule the first one.
| void Lyric::Stop | ( | ) |
Withdraw the scheduled lyric.
| void Lyric::Advance | ( | ) |
Show the current lyric and schedule the next one.
After the last lyric of the loop the first lyric at or past the loop's first tick is scheduled in the next loop.
|
static |
Toggle whether lyrics show on the display, the lyric script command.
| pCommand | The command. |
| pUserData | The Lyric that registered the command. |