View source

class FreeplayState

package funkin.ui.freeplay

extends MusicBeatSubState › FlxSubState › FlxState › FlxTypedContainer › FlxTypedGroup › FlxBasic

@:directlyUsed@:nullSafety

Available on all platforms

The state for the freeplay menu, allowing the player to select any song to play.

Static variables

@:value(FullScreenScaleMode.gameCutoutSize.x / 1.5)staticCUTOUT_WIDTH:Float = FullScreenScaleMode.gameCutoutSize.x / 1.5

For scaling some sprites on wide displays.

@:value([260, 170])staticfinalread onlyDEFAULT_DOTS_GROUP_POS:Array<Int> = [260, 170]

For positioning the difficulty dots.

@:value(0.44)staticfinalread onlyDJ_POS_MULTI:Float = 0.44

For positioning the DJ on wide displays.

@:value(0.25)staticfinalread onlyFADE_IN_DELAY:Float = 0.25

For the audio preview, the time to wait before attempting to load a song preview.

@:value(0.5)staticfinalread onlyFADE_IN_DURATION:Float = 0.5

For the audio preview, the duration of the fade-in effect.

@:value(1.0)staticfinalread onlyFADE_IN_END_VOLUME:Float = 1.0

For the audio preview, the volume at which the fade-in ends.

@:value(0.25)staticfinalread onlyFADE_IN_START_VOLUME:Float = 0.25

For the audio preview, the volume at which the fade-in starts.

@:value(0.25)staticfinalread onlyFADE_OUT_DURATION:Float = 0.25

For the audio preview, the duration of the fade-out effect.

@:value(0.0)staticfinalread onlyFADE_OUT_END_VOLUME:Float = 0.0

For the audio preview, the volume at which the fade-out starts.

@:value(0.75)staticfinalread onlySONGS_POS_MULTI:Float = 0.75

For positioning the songs list on wide displays.

@:value(Constants.DEFAULT_CHARACTER)staticrememberedCharacterId:String = Constants.DEFAULT_CHARACTER

The character we were on when this menu was last accessed.

@:value(Constants.DEFAULT_DIFFICULTY)staticrememberedDifficulty:String = Constants.DEFAULT_DIFFICULTY

The difficulty we were on when this menu was last accessed.

@:value("tutorial")staticrememberedSongId:Null<String> = "tutorial"

The song we were on when this menu was last accessed. NOTE: null if the last song was Random.

@:value(Constants.DEFAULT_VARIATION)staticrememberedVariation:String = Constants.DEFAULT_VARIATION

The remembered variation we were on when this menu was last accessed.

Static methods

staticbuild(?params:Null<FreeplayStateParams>, ?stickers:StickerSubState):MusicBeatState

Build an instance of FreeplayState that is above the MainMenuState.

Returns:

The MainMenuState with the FreeplayState as a substate.

Constructor

new(?params:Null<FreeplayStateParams>, ?stickers:StickerSubState)

Variables

@:value(new AngleMask())angleMaskShader:AngleMask = new AngleMask()

backingImage:FunkinSprite

The backing card that has the toned dots, right now we just use that one dad graphic dave cooked up

freeplayArrow:Null<FlxText>

funnyCam:FunkinCamera

@:value(new UIStateMachine())uiStateMachine:UIStateMachine = new UIStateMachine()

Methods

cleanupInstSelectMenu():Void

clearPreviews():Void

@:privateAccesscreateFreeplayDJ(x:Float, y:Float, characterId:String):Void

Create a FreeplayDJ for the current character.

Parameters:

x

The X position.

y

The Y position.

characterId

The character ID to use.

dispatchEvent(event:ScriptEvent):Void

Dispatches script events to all relevant scripted classes.

Parameters:

null

event

@:value({ noJumpIn : false, onlyIfChanged : true, force : false })generateSongList(filterStuff:Null<SongFilter>, force:Bool = false, onlyIfChanged:Bool = true, noJumpIn:Bool = false):Void

Given the current filter, rebuild the current song list and display it. Automatically takes into account currentDifficulty, character, and variation

Parameters:

filterStuff

A filter to apply to the song list (regex, startswith, all, favorite)

force

Whether the capsules should "jump" back in or not using their animation

onlyIfChanged

Only apply the filter if the song list has changed

noJumpIn

Will not call the jump-in function, used when changing difficulties to update the song list correctly without this happening twice

playCurSongPreview(?daSongCapsule:SongMenuItem):Void

sortSongs(songsToFilter:Array<Null<FreeplaySongData>>, songFilter:SongFilter):Array<Null<FreeplaySongData>>

Filters an array of songs based on a filter

Parameters:

songsToFilter

What data to use when filtering

songFilter

The filter to apply

Returns:

Array

switchBackingImage(?freeplaySongData:FreeplaySongData):Void

Inherited Variables

Defined by MusicBeatSubState

conductorInUse:Conductor

@:value(null)leftWatermarkText:Null<FlxText> = null

@:value(null)rightWatermarkText:Null<FlxText> = null

Defined by FlxSubState

closeCallback:() ‑> Void

Callback method for state close event.

openCallback:() ‑> Void

Callback method for state open/resume event.

Available since

4.3.0

.

Defined by FlxState

bgColor:FlxColor

The natural background color the cameras default to. In AARRGGBB format.

@:value(true)destroySubStates:Bool = true

If substates get destroyed when they are closed, setting this to false might reduce state creation time, at greater memory cost.

@:value(true)persistentDraw:Bool = true

Determines whether the current state is drawn, even when it is not the active state. For example, if you have your game state open first, and then you push a pause state on top of it, if this is set to true, the game state would still continue to be drawn behind that pause state.

By default, this is set to true, so the background states will continue to be "drawn" behind the current state.

If you do not want background states to be visible when you have a different state on top, then you should set this to false for improved performance.

@:value(false)persistentUpdate:Bool = false

Determines whether the current state is updated, even when it is not the active state. For example, if you have your game state open first, and then you push a pause state on top of it, if this is set to true, the game state would still continue to be updated in the background.

By default, this is set to false, so the background states will continue to be "paused" when they are not active.

read onlysubState:FlxSubState

Current substate. Substates also can be nested.

read onlysubStateClosed:FlxTypedSignal<FlxSubState ‑> Void>

A FlxSignal that dispatches when a sub state is closed from this state.

Available since

4.9.0

.

read onlysubStateOpened:FlxTypedSignal<FlxSubState ‑> Void>

A FlxSignal that dispatches when a sub state is opened from this state.

Available since

4.9.0

.

Defined by FlxTypedGroup

@:value(0)read onlylength:Int = 0

The number of entries in the members array. For performance and safety you should check this variable instead of members.length unless you really know what you're doing!

maxSize:Int

The maximum capacity of this group. Default is 0, meaning no max capacity, and the group can just grow.

read onlymemberAdded:FlxTypedSignal<T ‑> Void>

A FlxSignal that dispatches when a child is added to this group.

Available since

4.4.0

.

read onlymemberRemoved:FlxTypedSignal<T ‑> Void>

A FlxSignal that dispatches when a child is removed from this group.

Available since

4.4.0

.

read onlymembers:Array<T>

Array of all the members in this group.

Defined by FlxBasic

@:value(idEnumerator++)ID:Int = idEnumerator++

A unique ID starting from 0 and increasing by 1 for each subsequent FlxBasic that is created.

@:value(true)active:Bool = true

Controls whether update() is automatically called by FlxState/FlxGroup.

@:value(true)alive:Bool = true

Useful state for many game objects - "dead" (!alive) vs alive. kill() and revive() both flip this switch (along with exists, but you can override that).

camera:FlxCamera

Gets or sets the first camera of this object.

cameras:Array<FlxCamera>

This determines on which FlxCameras this object will be drawn. If it is null / has not been set, it uses the list of default draw targets, which is controlled via FlxG.camera.setDefaultDrawTarget as well as the DefaultDrawTarget argument of FlxG.camera.add.

read onlycontainer:Null<FlxContainer>

The parent containing this basic, typically if you check this recursively you should reach the state

Available since

5.7.0

.

@:value(true)exists:Bool = true

Controls whether update() and draw() are automatically called by FlxState/FlxGroup.

@:value(true)visible:Bool = true

Controls whether draw() is automatically called by FlxState/FlxGroup.

@:value(0)zIndex:Int = 0

Inherited Methods

Defined by MusicBeatSubState

beatHit():Bool

Called when a beat is hit in the current song. Continues outside of PlayState, for things like animations in menus.

Returns:

Whether the event should continue (not canceled).

initConsoleHelpers():Void

refresh():Void

Refreshes the state, by redoing the render order of all sprites. It does this based on the zIndex of each prop.

stepHit():Bool

Called when a step is hit in the current song. Continues outside of PlayState, for things like animations in menus.

Returns:

Whether the event should continue (not canceled).

switchSubState(substate:FlxSubState):Void

Close this substate and replace it with a different one.

Defined by FlxSubState

close():Void

Closes this substate.

Defined by FlxState

onResize(Width:Int, Height:Int):Void

This function is called whenever the window size has been changed.

Parameters:

Width

The new window width

Height

The new window Height

resetSubState():Void

Load substate for this state

Defined by FlxTypedGroup

add(basic:T):T

Adds a new FlxBasic subclass (FlxBasic, FlxSprite, Enemy, etc) to the group. FlxGroup will try to replace a null member of the array first. Failing that, FlxGroup will add it to the end of the member array. WARNING: If the group has a maxSize that has already been met, the object will NOT be added to the group!

Parameters:

basic

The FlxBasic you want to add to the group.

Returns:

The same FlxBasic object that was passed in.

any(func:T ‑> Bool):Bool

Tests whether any member satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

clear():Void

Remove all instances of FlxBasic subclasses (FlxSprite, FlxTileblock, etc) from the list. WARNING: does not destroy() or kill() any of these objects!

countDead():Int

Call this function to find out how many members of the group are dead.

Returns:

The number of FlxBasics flagged as dead. Returns -1 if group is empty.

countLiving():Int

Call this function to find out how many members of the group are not dead.

Returns:

The number of FlxBasics flagged as not dead. Returns -1 if group is empty.

every(func:T ‑> Bool):Bool

Tests whether every member satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

@:value({ recurse : false })forEach(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachAlive(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all alive members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachDead(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all dead members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachExists(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all existing members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachOfType<K>(objectClass:Class<K>, func:K ‑> Void, recurse:Bool = false):Void

Applies a function to all members of type Class<K>.

Parameters:

objectClass

A class that objects will be checked against before Function is applied, ex: FlxSprite.

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

getFirst(func:T ‑> Bool):Null<T>

Searches for, and returns the first member that satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

getFirstAlive():Null<T>

Call this function to retrieve the first object with dead == false in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc.

Returns:

A FlxBasic currently flagged as not dead.

@:value({ force : false })getFirstAvailable(?objectClass:Class<T>, force:Bool = false):Null<T>

Call this function to retrieve the first object with exists == false in the group. This is handy for recycling in general, e.g. respawning enemies.

Parameters:

objectClass

An optional parameter that lets you narrow the results to instances of this particular class.

force

Force the object to be an ObjectClass and not a super class of ObjectClass.

Returns:

A FlxBasic currently flagged as not existing.

getFirstDead():Null<T>

Call this function to retrieve the first object with dead == true in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc.

Returns:

A FlxBasic currently flagged as dead.

getFirstExisting():Null<T>

Call this function to retrieve the first object with exists == true in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc.

Returns:

A FlxBasic currently flagged as existing.

getFirstIndex(func:T ‑> Bool):Int

Searches for, and returns the index of the first member that satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

getFirstNull():Int

Call this function to retrieve the first index set to null. Returns -1 if no index stores a null object.

Returns:

An Int indicating the first null slot in the group.

getLast(func:T ‑> Bool):Null<T>

Searches for, and returns the last member that satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

getLastIndex(func:T ‑> Bool):Int

Searches for, and returns the index of the last member that satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

@:value({ length : 0, startIndex : 0 })getRandom(startIndex:Int = 0, length:Int = 0):T

Returns a member at random from the group.

Parameters:

startIndex

Optional offset off the front of the array. Default value is 0, or the beginning of the array.

length

Optional restriction on the number of values you want to randomly select from.

Returns:

A FlxBasic from the members list.

insert(position:Int, object:T):T

Inserts a new FlxBasic subclass (FlxBasic, FlxSprite, Enemy, etc) into the group at the specified position. FlxGroup will try to replace a null member at the specified position of the array first. Failing that, FlxGroup will insert it at the position of the member array. WARNING: If the group has a maxSize that has already been met, the object will NOT be inserted to the group!

Parameters:

position

The position in the group where you want to insert the object.

object

The object you want to insert into the group.

Returns:

The same FlxBasic object that was passed in.

inlineiterator(?filter:T ‑> Bool):FlxTypedGroupIterator<T>

Iterates through every member.

inlinekeyValueIterator():ArrayKeyValueIterator<T>

Iterates through every member and index.

kill():Void

Calls killMembers() and then kills the group itself. Revive this group via revive().

killMembers():Void

Calls kill() on the group's unkilled members. Revive them via reviveMembers().

Available since

5.4.0

.

@:value({ revive : true, force : false })recycle(?objectClass:Class<T>, ?objectFactory:() ‑> T, force:Bool = false, revive:Bool = true):T

Recycling is designed to help you reuse game objects without always re-allocating or "newing" them. It behaves differently depending on whether maxSize equals 0 or is bigger than 0.

maxSize > 0 / "rotating-recycling" (used by FlxEmitter): - at capacity: returns the next object in line, no matter its properties like alive, exists etc. - otherwise: returns a new object.

maxSize == 0 / "grow-style-recycling" - tries to find the first object with exists == false - otherwise: adds a new object to the members array

WARNING: If this function needs to create a new object, and no object class was provided, it will return null instead of a valid object!

Parameters:

objectClass

The class type you want to recycle (e.g. FlxSprite, EvilRobot, etc).

objectFactory

Optional factory function to create a new object if there aren't any dead members to recycle. If null, Type.createInstance() is used, which requires the class to have no constructor parameters.

force

Force the object to be an ObjectClass and not a super class of ObjectClass.

revive

Whether recycled members should automatically be revived (by calling revive() on them).

Returns:

A reference to the object that was created.

@:value({ splice : false })remove(basic:T, splice:Bool = false):T

Removes an object from the group.

Parameters:

basic

The FlxBasic you want to remove.

splice

Whether the object should be cut from the array entirely or not.

Returns:

The removed object.

replace(oldObject:T, newObject:T):T

Replaces an existing FlxBasic with a new one. Does not do anything and returns null if the old object is not part of the group.

Parameters:

oldObject

The object you want to replace.

newObject

The new object you want to use instead.

Returns:

The new object.

revive():Void

Calls reviveMembers() and then revives the group itself.

reviveMembers():Void

Calls revive() on the group's killed members and then on the group itself.

Available since

5.4.0

.

@:value({ order : FlxSort.ASCENDING })inlinesort(func:(Int, T, T) ‑> Int, order:Int = FlxSort.ASCENDING):Void

Call this function to sort the group according to a particular value and order. For example, to sort game objects for Zelda-style overlaps you might call group.sort(FlxSort.byY, FlxSort.ASCENDING) at the bottom of your FlxState#update() override.

Parameters:

func

The sorting function to use - you can use one of the premade ones in FlxSort or write your own using FlxSort.byValues() as a "backend".

order

A constant that defines the sort order. Possible values are FlxSort.ASCENDING (default) and FlxSort.DESCENDING.

Defined by FlxBasic

getCameras():Array<FlxCamera>

The cameras that will draw this. Use this.cameras to set specific cameras for this object, otherwise the container's cameras are used, or the container's container and so on. If there is no container, say, if this is inside FlxGroups rather than a FlxContainer then the default draw cameras are returned.

Available since

5.7.0

.

getDefaultCamera():FlxCamera

The main camera that will draw this. Use this.cameras to set specific cameras for this object, otherwise the container's camera is used, or the container's container and so on. If there is no container, say, if this is inside FlxGroups rather than a FlxContainer then FlxG.camera is returned.

Available since

5.7.0

.

toString():String