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

One gem of a pitch track. More...

#include <pitchgem.h>

Public Member Functions

 PitchGem ()=default
 PitchGem (signed char nSlot, int nTick, signed char nOwner)
 Construct a gem.
bool operator< (const PitchGem &other) const
 Order gems by tick.
int GetTick () const
void SetTick (int nTick)
signed char GetSlot () const
signed char GetOwner () const
void SetOwner (signed char nOwner)

Detailed Description

One gem of a pitch track.

The RTTI includes the class name. The class is not polymorphic.

Constructor & Destructor Documentation

◆ PitchGem() [1/2]

PitchGem::PitchGem ( )
default

◆ PitchGem() [2/2]

PitchGem::PitchGem ( signed char nSlot,
int nTick,
signed char nOwner )
inline

Construct a gem.

Parameters
nSlotThe gem button the gem lies under.
nTickThe tick of the gem.
nOwnerThe player who placed the gem, or -1.

Member Function Documentation

◆ operator<()

bool PitchGem::operator< ( const PitchGem & other) const
inline

Order gems by tick.

Inline. The searches of a bar's gems expand it.

Parameters
otherThe other gem.
Returns
Whether this gem comes first.

◆ GetTick()

int PitchGem::GetTick ( ) const
inline
Returns
The tick of the gem.

◆ SetTick()

void PitchGem::SetTick ( int nTick)
inline
Parameters
nTickThe tick of the gem.

◆ GetSlot()

signed char PitchGem::GetSlot ( ) const
inline
Returns
The gem button the gem lies under.

◆ GetOwner()

signed char PitchGem::GetOwner ( ) const
inline
Returns
The player who placed the gem, or -1.

◆ SetOwner()

void PitchGem::SetOwner ( signed char nOwner)
inline
Parameters
nOwnerThe player who placed the gem, or -1.

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