View source

class SongTimeChange

package funkin.data.song

implements ICloneable<SongTimeChange>

import funkin.data.song.SongData

@:directlyUsed

Available on all platforms

Static variables

@:value(new SongTimeChange(0, 100))staticfinalread onlyDEFAULT_SONGTIMECHANGE:SongTimeChange = new SongTimeChange(0, 100)

@:value([DEFAULT_SONGTIMECHANGE])staticfinalread onlyDEFAULT_SONGTIMECHANGES:Array<SongTimeChange> = [DEFAULT_SONGTIMECHANGE]

Constructor

@:value({ timeSignatureDen : 4, timeSignatureNum : 4 })new(timeStamp:Float, bpm:Float, timeSignatureNum:Int = 4, timeSignatureDen:Int = 4, ?beatTime:Float, ?beatTuplets:Array<Int>)

Variables

@:optional@:alias("b")optionalbeatTime:Float

Time in beats (int). The game will calculate further beat values based on this one, so it can do it in a simple linear fashion.

@:optional@:alias("bt")optionalbeatTuplets:Array<Int>

Beat tuplets (Array or int). This defines how many steps each beat is divided into. It can either be an array of length n (see above) or a single integer number. Optional, defaults to [4].

@:alias("bpm")bpm:Float

Quarter notes per minute (float). Cannot be empty in the first element of the list, but otherwise it's optional, and defaults to the value of the previous element.

@:default(4)@:optional@:alias("d")optionaltimeSignatureDen:Int

Time signature denominator (int). Optional, defaults to 4. Should only ever be a power of two.

@:default(4)@:optional@:alias("n")optionaltimeSignatureNum:Int

Time signature numerator (int). Optional, defaults to 4.

@:alias("t")timeStamp:Float

Timestamp in specified timeFormat.

Methods

clone():SongTimeChange

toString():String

Produces a string representation suitable for debugging.