View source

class StickerRegistry

package funkin.data.stickers

extends BaseRegistry_funkin_ui_transition_stickers_StickerPack_funkin_data_stickers_StickerData_funkin_data_stickers_StickerEntryParams

@:directlyUsed@:nullSafety

Available on all platforms

Static variables

@:value("1.0.0")staticfinalread onlySTICKER_DATA_VERSION:Version = "1.0.0"

The current version string for the sticker pack data format. Handle breaking changes by incrementing this value and adding migration to the migrateStickerData() function.

@:value("1.0.x")staticfinalread onlySTICKER_DATA_VERSION_RULE:VersionRule = "1.0.x"

@:value(new StickerRegistry())staticfinalread onlyinstance:StickerRegistry = new StickerRegistry()

Constructor

new()

Methods

fetchDefault():StickerPack

parseEntryData(id:String):Null<StickerData>

Read, parse, and validate the JSON data and produce the corresponding data object.

Parameters:

id

The ID of the entry to load.

Returns:

The parsed data object.

parseEntryDataRaw(contents:String, ?fileName:String):Null<StickerData>

Parse and validate the JSON data and produce the corresponding data object.

NOTE: Must be implemented on the implementation class.

Parameters:

contents

The JSON as a string.

fileName

An optional file name for error reporting.

Returns:

The parsed data object.