HoldNoteResult Struct Reference

The result of holding (or letting go of) a hold note. More...

#include <NoteTypes.h>

Public Member Functions
auto	GetLastHeldBeat () const -> float
auto	CreateNode () const -> XNode *
void	LoadFromNode (const XNode *pNode)
void	PushSelf (lua_State *L)

Public Attributes
HoldNoteScore	hns { HNS_None }
float	fLife { 1.F }
	the current life of the hold.
float	fOverlappedTime { 0 }
	The number of seconds the hold note has overlapped the current beat.
int	iLastHeldRow { 0 }
	Last index where fLife was greater than 0. If the tap was missed, this will be the first index of the hold.
int	iCheckpointsHit { 0 }
	If checkpoint holds are enabled, the number of checkpoints hit.
int	iCheckpointsMissed { 0 }
	If checkpoint holds are enabled, the number of checkpoints missed.
bool	bHeld { false }
	Was the button held during the last update?
bool	bActive { false }
	Is there life in the hold and does it overlap the current beat?

Detailed Description

The result of holding (or letting go of) a hold note.

Member Data Documentation

fLife

float HoldNoteResult::fLife { 1.F }

the current life of the hold.

1.0 means this HoldNote has full life.

0.0 means this HoldNote is dead.

When this value hits 0.0 for the first time, m_HoldScore becomes HNS_LetGo. If the life is > 0.0 when the HoldNote ends, then m_HoldScore becomes HNS_Held.

fOverlappedTime

float HoldNoteResult::fOverlappedTime { 0 }

The number of seconds the hold note has overlapped the current beat.

This value is 0 if it doesn't overlap.

---

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

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