wavelength 1.0.0
Loading...
Searching...
No Matches
NoteMuseBase::NoteCommand Class Reference

Command that sends the note on and, the second time it runs, the note off. More...

#include <notemusebase.h>

Inheritance diagram for NoteMuseBase::NoteCommand:
Collaboration diagram for NoteMuseBase::NoteCommand:

Public Member Functions

 NoteCommand (NoteMuseBase *pMuse)
 Construct the command of a note.
 ~NoteCommand () override=default
 Release the command.
void Execute () override
 Send the note on, or the note off when the note sounds.
void Cancel ()
 Silence the note when it sounds and withdraw the command.
void NoteOff ()
 Send the note off.
void NoteOn ()
 Send the note on and report it to the receiver of the note.
NoteMuseBase * GetMuse () const
Scheduler * GetScheduler () const
void SetScheduler (Scheduler *pScheduler)
Public Member Functions inherited from Command
 ~Command () override
 Release the command.
virtual bool IsSerializable ()
 Report whether a recording saves the command.
virtual int GetSerialId ()
 Report the identifier a recording rebuilds the command by.
virtual void Save (BinStream &stream) const
 Write the command to a recording.
virtual void Load (BinStream &stream)
 Read the command Save() writes.
Public Member Functions inherited from Attachment
 Attachment ()
 Construct an object with no reference.
virtual ~Attachment ()
 Release the object.
void AddRef ()
 Take one reference.
void Release ()
 Give back one reference and delete the object once the last one is gone.

Static Public Member Functions

static void * operator new (size_t nSize)
 Allocate a command from the pool.
static void operator delete (void *pBlock)
 Return a command to the pool.
Static Public Member Functions inherited from Attachment
static void ReleaseIfSet (Attachment *pAttachment)
 Give back one reference to an object that may be null.

Detailed Description

Command that sends the note on and, the second time it runs, the note off.

The RTTI includes the nested name and records Command as the base. The allocations come from the pool of fixed-size blocks, billed to the tag "NoteMuse cmd".

Constructor & Destructor Documentation

◆ NoteCommand()

NoteMuseBase::NoteCommand::NoteCommand ( NoteMuseBase * pMuse)
inlineexplicit

Construct the command of a note.

Parameters
pMuseThe note.

◆ ~NoteCommand()

NoteMuseBase::NoteCommand::~NoteCommand ( )
overridedefault

Release the command.

Ghidra address:
NTSC-U/C: 0x0034ebc8
Ghidra address:
PAL: 0x003bbff0

Member Function Documentation

◆ operator new()

void * NoteMuseBase::NoteCommand::operator new ( size_t nSize)
inlinestatic

Allocate a command from the pool.

Parameters
nSizeThe object size.
Returns
The block.

◆ operator delete()

void NoteMuseBase::NoteCommand::operator delete ( void * pBlock)
inlinestatic

Return a command to the pool.

Parameters
pBlockThe block.

◆ Execute()

void NoteMuseBase::NoteCommand::Execute ( )
overridevirtual

Send the note on, or the note off when the note sounds.

Ghidra address:
NTSC-U/C: 0x0034ec20
Ghidra address:
PAL: 0x003bc048

Implements Command.

◆ Cancel()

void NoteMuseBase::NoteCommand::Cancel ( )

Silence the note when it sounds and withdraw the command.

Ghidra address:
NTSC-U/C: 0x0034ec70
Ghidra address:
PAL: 0x003bc098

◆ NoteOff()

void NoteMuseBase::NoteCommand::NoteOff ( )

Send the note off.

Ghidra address:
NTSC-U/C: 0x0034ecc0
Ghidra address:
PAL: 0x003bc0e8

◆ NoteOn()

void NoteMuseBase::NoteCommand::NoteOn ( )

Send the note on and report it to the receiver of the note.

Ghidra address:
NTSC-U/C: 0x0034ed40
Ghidra address:
PAL: 0x003bc168

◆ GetMuse()

NoteMuseBase * NoteMuseBase::NoteCommand::GetMuse ( ) const
inline
Returns
The note.

◆ GetScheduler()

Scheduler * NoteMuseBase::NoteCommand::GetScheduler ( ) const
inline
Returns
The scheduler that queued the command, or null.

◆ SetScheduler()

void NoteMuseBase::NoteCommand::SetScheduler ( Scheduler * pScheduler)
inline
Parameters
pSchedulerThe scheduler that queued the command, or null.

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