ArrowEffects Class Reference

Functions that return properties of arrows based on Style and PlayerOptions. More...

#include <ArrowEffects.h>

Static Public Member Functions
static void	Update ()
static void	SetCurrentOptions (const PlayerOptions *options)
static auto	GetYOffset (const PlayerState *pPlayerState, int iCol, float fNoteBeat, float &fPeakYOffsetOut, bool &bIsPastPeakYOffset, bool bAbsolute=false) -> float
static auto	GetYOffset (const PlayerState *pPlayerState, int iCol, float fNoteBeat, bool bAbsolute=false) -> float
static void	GetXYZPos (const PlayerState *player_state, int col, float y_offset, float y_reverse_offset, RageVector3 &ret, bool with_reverse=true)
static auto	GetYPos (int iCol, float fYOffset, float fYReverseOffsetPixels, bool WithReverse=true) -> float
	Retrieve the actual display position.
static auto	GetYOffsetFromYPos (int iCol, float YPos, float fYReverseOffsetPixels) -> float
static auto	GetRotationZ (const PlayerState *pPlayerState, float fNoteBeat, bool bIsHoldHead) -> float
static auto	ReceptorGetRotationZ (const PlayerState *pPlayerState) -> float
static auto	GetRotationX (float fYOffset) -> float
static auto	GetRotationY (float fYOffset) -> float
static auto	GetXPos (const PlayerState *pPlayerState, int iCol, float fYOffset) -> float
static auto	GetZPos (int iCol, float fYPos) -> float
	Retrieve the Z position.
static auto	NeedZBuffer () -> bool
static auto	GetAlpha (int iCol, float fYPos, float fPercentFadeToFail, float fYReverseOffsetPixels, float fDrawDistanceBeforeTargetsPixels, float fFadeInPercentOfDrawFar) -> float
static auto	GetGlow (int iCol, float fYPos, float fPercentFadeToFail, float fYReverseOffsetPixels, float fDrawDistanceBeforeTargetsPixels, float fFadeInPercentOfDrawFar) -> float
static auto	GetBrightness (const PlayerState *pPlayerState, float fNoteBeat) -> float
	Retrieve the current brightness.
static auto	GetZoom (const PlayerState *pPlayerState) -> float
static auto	GetFrameWidthScale (const PlayerState *pPlayerState, float fYOffset, float fOverlappedTime) -> float

Detailed Description

Functions that return properties of arrows based on Style and PlayerOptions.

Member Function Documentation

GetBrightness()

float ArrowEffects::GetBrightness ( const PlayerState *  pPlayerState, float  fNoteBeat  ) -> float

static

Retrieve the current brightness.

Note that this depends on fYOffset.

Parameters

pPlayerState	the present PlayerState.
fNoteBeat	the current beat.

Returns

the current brightness.

GetYPos()

float ArrowEffects::GetYPos ( int  iCol, float  fYOffset, float  fYReverseOffsetPixels, bool  WithReverse = true  ) -> float

static

Retrieve the actual display position.

In this case, reverse and post-reverse-effects are factored in (fYOffset -> YPos).

Parameters

iCol	the specific arrow column.
fYOffset	the original display position.
fYReverseOffsetPixels	the amount offset due to reverse.
WithReverse	a flag to see if the Reverse mod is on.

Returns

the actual display position.

GetZPos()

float ArrowEffects::GetZPos ( int  iCol, float  fYPos  ) -> float

static

Retrieve the Z position.

This is normally 0. This is only visible with perspective modes.

Parameters

iCol	the specific arrow column.
fYPos	the Y position of the arrow.

Returns

the Z position.

---

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

• /home/runner/work/etterna/etterna/src/Etterna/Actor/Gameplay/ArrowEffects.h
• /home/runner/work/etterna/etterna/src/Etterna/Actor/Gameplay/ArrowEffects.cpp