View source

class Countdown

package funkin.play

@:directlyUsed

Available on all platforms

Static variables

@:value(BEFORE)staticread onlycountdownStep:CountdownStep = BEFORE

The current step of the countdown.

@:value("")staticgraphicSuffix:String = ""

Which alternate graphic on countdown to use. You can set this via script. For example, in Week 6 it is -pixel.

@:value("")staticsoundSuffix:String = ""

Which alternate graphic/sound on countdown to use. This is set via the current notestyle. For example, in Week 6 it is pixel.

Static methods

staticdecrement(step:CountdownStep):CountdownStep

staticpauseCountdown():Void

Pauses the countdown at the current step. You can start it up again later by calling resumeCountdown().

If you want to call this from a module, it's better to use the event system and cancel the onCountdownStep event.

staticperformCountdown():Bool

Performs the countdown. Pauses the song, plays the countdown graphics/sound, and then starts the song. This will automatically stop and restart the countdown if it is already running.

Returns:

false if the countdown was cancelled by a script.

staticplayCountdownSound(step:CountdownStep):FunkinSound

Retrieves the sound file to use for this step of the countdown.

staticreset():Void

Reset the countdown configuration to the default.

staticresetCountdown():Void

Resets the countdown. Only works if it's already running.

staticresumeCountdown():Void

Resumes the countdown at the current step. Only makes sense if you called pauseCountdown() first.

If you want to call this from a module, it's better to use the event system and cancel the onCountdownStep event.

staticshowCountdownGraphic(index:CountdownStep):Void

Retrieves the graphic to use for this step of the countdown.

staticskipCountdown():Void

Stops the current countdown, then starts the song for you.

staticstopCountdown():Void

Stops the countdown at the current step. You will have to restart it again later.

If you want to call this from a module, it's better to use the event system and cancel the onCountdownStart event.