JSON and CSV Loader Maintainer Documentation ‐ JSON Object Tooltip Language

JSON Object Tooltip Language

This section goes over our Homemade JSON Object Tooltip Language used for creating our Schemas on the fly.

HARD-CODED VALUES

• REQUIRED - Mark this field as a Required field in the Schema.
• EXCLUDED - Mark this field as something to not include in the Schema.
• EXTENDS - Mark this field as extending the current Schema Level.
• ALTERNATIVES - Mark this field as having Alternatives.

VARIABLES

All Variables will work as follows: VariableName(Definition), kinda like a KeyPairValue. The following is a list of all Variables:

• MinimumLength - Int - Used in String and String Array - Mandates a Minimum Length.
• Pattern - Raw Regex - Used in String and String Array - Mandates a Pattern the Value must follow.
• Items - Boolean - Used in String Array and Object Array - Marks the fact the Array has items as true.
• ItemType - Type - Used in String Array and Object Array - Used to define the type of Array in which the items belong. (e.g. string or object)
• Enums - A List of Predefined Values - Used in String and String Array - This provides a Pre-Defined list of items users may use for defining the value.
• UniqueItems - Boolean - Used in String Array and Object Array - This mandates uniqueness among the values.
• Default - Value - Used in String, Int, and Boolean - This provides a default for Schema Validators.
• Minimum - Int - Used in Int - This mandates a Minimum Number.
• Maximum - Int - Used in Int - This mandates a Maximum Number.
• AdditionalProperties - Boolean - Used in Object and Object Array - Determines whether additional properties are valid.
• AnyOf - WOAH SEE THE SECTION BY THE SAME NAME - Used in String Array - Defines whether other variations are okay for this array.
• AlternativeNames - String Array - Used by any Property - Indicates Alternative Names for a Given Property.

If you inevitably need more as of present you'll need to code handling into the Schema and Linter.

MULTI-VARIABLE

To use more than one variable all you need to do is add a '|' between each Variable, this acts as a Delimiter.

An example of such would be:

[Tooltip("REQUIRED | MinimumLength(1) | Pattern(^[a-zA-Z\\d_]+$)")]

Notice the \\ in the Regex? That's because C# needs it to be escaped in quotes, but don't worry we properly escape it for JSON in ReadDocumentationFile.EscapeJSON().

AnyOf Variable

To use this we need to define some special syntaxes, it kinda has its own language within the language.

First things first, any valid AnyOf Items should be surrounded in [] and than after that split by the ; delimitor.

Next up to define the properties we have our own set of vars, with their own definitions:

• Title - The Title of the Validator Set for the Array.
• Description - The Description of the Validator Set for the Array.
• Type - The Type in which the Validator is used to Validate.
• Enums - A list of options which are valid under that validator.

To define it would be for example AnyOf([Title: Base Game Meta Category, Description: A Meta Category from the Base Game, Type: string, Enums: ChoiceNode > TraderOffer > Part3Random > Rare > GBCPack > GBCPlayable > AscensionUnlock];[Title: Modded Meta Category, Description: Format is {Mod GUID}.{Meta Category Name}, Type: string])

Each variable is delimited by , within the AnyOf Validator Set, and the : acts as delimiter between field and value. Lastly within Enums because we delimit our fields with , the delimiter is >.