Codename LogoCodename Logo

funkin.backend.scripting.events.WeekSelectEvent

APIWiki
View source

final class WeekSelectEvent

package funkin.backend.scripting.events

extends CancellableEvent

@:directlyUsed@:build(funkin.backend.system.macros.EventMacro.build())@:autoBuild(funkin.backend.system.macros.EventMacro.build())

Constructor

View in GitHub

new()

Variables

difficulty:String

The difficulty that has been selected

difficultyID:Int

At which emplacement the difficulty is. Goes from 0 to the number of weeks - 1.

week:WeekData

Week that is going to be selected

weekID:Int

At which emplacement the week is. Goes from 0 to the number of weeks - 1.

Methods

View in GitHub

recycle(week:WeekData, difficulty:String, weekID:Int, difficultyID:Int):WeekSelectEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

View in GitHub

destroy():Void

View in GitHub

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

View in GitHub

recycleBase():Void

View in GitHub

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] [CancellableEvent (Cancelled)]

Returns:

String