DisplayBpms Struct Reference

The list of BPMs to display. More...

#include <GameConstantsAndTypes.h>

Public Member Functions
void	Add (float f)
	Add a BPM to the list.
auto	GetMin () const -> float
	Retrieve the minimum BPM of the set.
auto	GetMax () const -> float
	Retrieve the maximum BPM of the set.
auto	GetMaxWithin (float highest=FLT_MAX) const -> float
	Retrieve the maximum BPM of the set, but no higher than a certain value.
auto	BpmIsConstant () const -> bool
	Determine if the BPM is really constant.
auto	IsSecret () const -> bool
	Determine if the BPM is meant to be a secret.

Public Attributes
std::vector< float >	vfBpms
	The list of the BPMs for the song.

Detailed Description

The list of BPMs to display.

Member Function Documentation

Add()

void DisplayBpms::Add

(

float

f

)

Add a BPM to the list.

Parameters

f	the BPM to add.

BpmIsConstant()

bool DisplayBpms::BpmIsConstant

(

)

const -> bool

Determine if the BPM is really constant.

Returns

Whether the BPM is constant or not.

GetMax()

float DisplayBpms::GetMax

(

)

const -> float

Retrieve the maximum BPM of the set.

Returns

the maximum BPM.

GetMaxWithin()

float DisplayBpms::GetMaxWithin

(

float

highest = FLT_MAX

)

const -> float

Retrieve the maximum BPM of the set, but no higher than a certain value.

Parameters

highest

the highest BPM to use.

Returns

the maximum BPM.

GetMin()

float DisplayBpms::GetMin

(

)

const -> float

Retrieve the minimum BPM of the set.

Returns

the minimum BPM.

IsSecret()

bool DisplayBpms::IsSecret

(

)

const -> bool

Determine if the BPM is meant to be a secret.

Returns

Whether the BPM is a secret or not.

---

The documentation for this struct was generated from the following files:

• /home/runner/work/etterna/etterna/src/Etterna/Models/Misc/GameConstantsAndTypes.h
• /home/runner/work/etterna/etterna/src/Etterna/Models/Misc/GameConstantsAndTypes.cpp