coastline 0.0.4
Loading...
Searching...
No Matches
coastline::ConsoleCredits Class Reference

Captions and scrolling credits for one attract-demo controller. More...

#include <racecredits.h>

Public Member Functions

bool Start (const std::filesystem::path &release)
 Read the captions and the scrolling credits of a release, and start them as the race of the credits starts: the first caption, and the scrolling credits below the screen, as CalculateScrollPositions() of the console places them.
void Step (float seconds)
 Advance the credits of the race of the credits that runs by a step of the race: the captions as DrawCreditCaption() of the console advances them, or the scrolling credits up a pixel as ScrollTextUp() of the console moves them once a frame.
void Draw (SceneRenderer &renderer, const MenuText &text) const
 Draw the credits of the race of the credits that runs, as DrawCreditCaption() and DrawScrollingText() of the console draw them.

Detailed Description

Captions and scrolling credits for one attract-demo controller.

Member Function Documentation

◆ Start()

bool coastline::ConsoleCredits::Start ( const std::filesystem::path & release)

Read the captions and the scrolling credits of a release, and start them as the race of the credits starts: the first caption, and the scrolling credits below the screen, as CalculateScrollPositions() of the console places them.

Parameters
releaseThe selected cartridge directory, n64/base of the prepared assets.
Returns
Whether the release has the credits, logged when it does not.

◆ Step()

void coastline::ConsoleCredits::Step ( float seconds)

Advance the credits of the race of the credits that runs by a step of the race: the captions as DrawCreditCaption() of the console advances them, or the scrolling credits up a pixel as ScrollTextUp() of the console moves them once a frame.

Parameters
secondsThe time of the step.

◆ Draw()

void coastline::ConsoleCredits::Draw ( SceneRenderer & renderer,
const MenuText & text ) const

Draw the credits of the race of the credits that runs, as DrawCreditCaption() and DrawScrollingText() of the console draw them.

Parameters
rendererThe renderer of the frame.
textThe fonts of the release.

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