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

Input event that rotates a player's view of the tracks by one track. More...

#include <rotateevent.h>

Public Types

enum  Direction { kDirectionPrevious = 0 , kDirectionNext = 1 }
 Values of mDirection. More...

Public Member Functions

 RotateEvent ()=default
 Construct an event with unset members.
 RotateEvent (BinStream &stream)
 Construct the event from a recording.
void Save (BinStream &stream) const
 Record the player in one byte and the direction in four bytes of the console's byte order.
void Load (BinStream &stream)
 Read the event Save() records.
unsigned char GetPlayer () const
void SetPlayer (unsigned char nPlayer)
int GetDirection () const
void SetDirection (int nDirection)

Detailed Description

Input event that rotates a player's view of the tracks by one track.

The RTTI includes the name as the argument of the input command template. The input router builds one for each rotation and for each repeat of a held rotation.

Member Enumeration Documentation

◆ Direction

Values of mDirection.

Enumerator
kDirectionPrevious 

The previous track.

kDirectionNext 

The next track.

Constructor & Destructor Documentation

◆ RotateEvent() [1/2]

RotateEvent::RotateEvent ( )
default

Construct an event with unset members.

Inline.

◆ RotateEvent() [2/2]

RotateEvent::RotateEvent ( BinStream & stream)
explicit

Construct the event from a recording.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x00151460
Ghidra address:
PAL: 0x00152d08

Member Function Documentation

◆ Save()

void RotateEvent::Save ( BinStream & stream) const

Record the player in one byte and the direction in four bytes of the console's byte order.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x00151488
Ghidra address:
PAL: 0x00152d30

◆ Load()

void RotateEvent::Load ( BinStream & stream)

Read the event Save() records.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x001514f8
Ghidra address:
PAL: 0x00152d88

◆ GetPlayer()

unsigned char RotateEvent::GetPlayer ( ) const
inline
Returns
The player index.

◆ SetPlayer()

void RotateEvent::SetPlayer ( unsigned char nPlayer)
inline
Parameters
nPlayerThe player index.

◆ GetDirection()

int RotateEvent::GetDirection ( ) const
inline
Returns
One of Direction.

◆ SetDirection()

void RotateEvent::SetDirection ( int nDirection)
inline
Parameters
nDirectionOne of Direction.

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