Context

Description

Provides various value channels for accessing gameplay state and chart properties.

Remarks

This class provides channels (not plain values) that can be used to drive animations or read dynamic state. Most properties return ValueChannel objects.

Properties

---

Name	Type	Description
dropRate	ValueChannel	The current drop rate
globalOffset	ValueChannel	The global offset
currentScore	ValueChannel	The current score
currentCombo	ValueChannel	The current combo
currentTiming	ValueChannel	The current timing
screenWidth	ValueChannel	The screen's width in pixels
screenHeight	ValueChannel	The screen's height in pixels
screenAspectRatio	ValueChannel	The screen's width divided by height
is16By9	ValueChannel	Whether the screen is 16:9
isMirrorOn	ValueChannel	Whether mirror mode is on
laneFrom	ValueChannel	The starting lane (can be assigned to)
laneTo	ValueChannel	The ending lane (can be assigned to)

Methods

---

bpm(timingGroup = 0)

Description

Returns a channel that evaluates to the BPM at any given timing.

Parameters

Name	Type	Description
timingGroup	number	Timing group to calculate with

Return types

ValueChannel

Remarks

_

---

beatLength(timingGroup = 0)

Description

Returns a channel that evaluates to the length of a beat (in ms) at any given timing.

Parameters

Name	Type	Description
timingGroup	number	Timing group to calculate with

Return types

ValueChannel

Remarks

_

---

divisor(timingGroup = 0)

Description

Returns a channel that evaluates to the divisor at any given timing.

Parameters

Name	Type	Description
timingGroup	number	Timing group to calculate with

Return types

ValueChannel

Remarks

_

---

floorPosition(timingGroup = 0)

Description

Returns a channel that evaluates to the floor position at any given timing.

Parameters

Name	Type	Description
timingGroup	number	Timing group to calculate with

Return types

ValueChannel

Remarks

_