View source

class StickerPack

package funkin.ui.transition.stickers

implements IRegistryEntry<StickerData>

extended by ScriptedStickerPack

@:directlyUsed@:funkinProcessed@:build(funkin.util.macro.RegistryMacro.buildEntry())@:autoBuild(funkin.util.macro.RegistryMacro.buildEntry())

Available on all platforms

A class representing the data for a sticker pack as displayed in the Sticker SubState.

Constructor

new(id:String, ?params:Dynamic)

Variables

final_data:StickerData

The full data for this sticker pack.

finalid:String

The internal ID for this sticker pack.

Methods

destroy():Void

getRandomStickerPath(last:Bool):String

Retrieve a random sticker from the pack.

Parameters:

last

Whether this will be the last sticker to be placed on the screen.

Returns:

An asset path to a sticker to display.

getStickerPackArtist():String

Return the artist of the sticker pack.

Returns:

The list of artists

getStickerPackName():String

Return the name of the sticker pack.

Returns:

The name of the sticker pack

getStickers():Array<String>

Gets a list of all the sticker assets available in the pack.

Returns:

The list of stickers as raw strings.

toString():String