Funkin/source/funkin/data
2024-09-05 00:20:55 -04:00
..
animation FNFC file rework (includes command line quicklaunch) 2023-10-21 01:04:50 -04:00
character Rewrite Stage data handling to use the Registry pattern, and add support for solid colors. 2024-01-16 17:08:25 -05:00
dialogue Remove alot of unused imoprts 2024-05-27 22:34:28 -07:00
event Fixes for scripted song events, define vocal tracks per variation, display suffixed difficulties properly. 2024-07-28 01:42:09 -04:00
freeplay Merge branch 'bugfix/labor-daybor' into rewrite/master 2024-09-03 23:56:45 -04:00
notestyle Custom coutndown, judgements, and combo count now use the note style file instead of hardcoded paths. 2024-07-28 17:10:32 -04:00
song Merge branch 'rewrite/master' into bugfix/friday-fixes 2024-09-03 23:42:51 -04:00
stage registry updates 2024-09-03 19:16:46 +01:00
story/level Updated compile defines to use feature flag system 2024-08-26 18:01:36 -04:00
BaseRegistry.hx Custom coutndown, judgements, and combo count now use the note style file instead of hardcoded paths. 2024-07-28 17:10:32 -04:00
DataError.hx "Add Variation" button, SongMetadata format changes, bug fixes, resolve metadata loading issues. 2023-09-25 23:24:07 -04:00
DataParse.hx Fix a bunch of merge bugs. 2024-03-23 15:34:37 -04:00
DataWrite.hx FNFC file rework (includes command line quicklaunch) 2023-10-21 01:04:50 -04:00
IRegistryEntry.hx New song data parser 2023-09-08 17:45:47 -04:00
JsonFile.hx First implementation of credits state. 2024-03-26 12:33:54 -04:00
README.md New song data parser 2023-09-08 17:45:47 -04:00

funkin.data

Data structures are parsed using json2object, which uses macros to generate parser classes based on anonymous structures OR classes.

Parsing errors will be returned in parser.errors. See json2object.Error for an enumeration of possible parsing errors. If an error occurred, parser.value will be null.

The properties of these anonymous structures can have their behavior changed with annotations:

  • @:optional: The value is optional and will not throw a parsing error if it is not present in the JSON data.
  • @:default("test"): If the value is optional, this value will be used instead of null. Replace "test" with a value of the property's type.
  • @:default(auto): If the value is an anonymous structure with json2object annotations, each field will be initialized to its default value.
  • @:jignored: This value will be ignored by the parser. Their presence will not be checked in the JSON data and their values will not be parsed.
  • @:alias: Choose the name the value will use in the JSON data to be separate from the property name. Useful if the desired name is a reserved word like public.
  • @:jcustomparse: Provide a custom function for parsing from a JSON string into a value.
    • Functions must be of the signature (hxjsonast.Json, String) -> T, where the String is the property name and T is the type of the property.
    • hxjsonast.Json contains a pos and a value, with value being an enum: https://nadako.github.io/hxjsonast/hxjsonast/JsonValue.html
    • Errors thrown in this function will cause a parsing error (CustomFunctionException) along with a position!
    • Make sure to provide the FULLY QUALIFIED path to the custom function.
  • @:jcustomwrite: Provide a custom function for serializing the property into a string for storage as JSON.
    • Functions must be of the signature (T) -> String, where T is the type of the property.