Interface NBTSchema

A top-level NBT schema.

interface NBTSchema {
    $comment?: string;
    $fragment?: false;
    $id?: string;
    $ref?: string;
    $schema?: string;
    additionalItems?: NBTSubSchemaRef;
    additionalProperties?: NBTSubSchemaRef;
    allOf?: NBTSubSchemaRef[];
    allowComments?: boolean;
    allowTrailingCommas?: boolean;
    anyOf?: NBTSubSchemaRef[];
    const?: any;
    contains?: NBTSubSchemaRef;
    default?: {
        type:
            | "string"
            | "byte"
            | "short"
            | "int"
            | "float"
            | "double"
            | "long"
            | "list"
            | "compound"
            | "byteArray"
            | "shortArray"
            | "intArray"
            | "longArray";
        value: any;
    };
    defaultSnippets?: {
        body?: any;
        bodyText?: string;
        description?: string;
        label?: string;
        markdownDescription?: string;
    }[];
    definitions?: { [name: string]: NBTSchema };
    dependencies?: NBTSchemaMap | { [prop: string]: string[] };
    deprecationMessage?: string;
    description?: string;
    doNotSuggest?: boolean;
    else?: NBTSubSchemaRef;
    enum?: (
        | Byte
        | Short
        | Int
        | Long
        | Float
        | Double
        | String
        | List<TagType>
        | Compound
        | ByteArray
        | ShortArray
        | IntArray
        | LongArray
    )[];
    enumDescriptions?: string[];
    errorMessage?: string;
    examples?: (
        | Byte
        | Short
        | Int
        | Long
        | Float
        | Double
        | String
        | List<TagType>
        | Compound
        | ByteArray
        | ShortArray
        | IntArray
        | LongArray
    )[];
    exclusiveMaximum?: number | boolean;
    exclusiveMinimum?: number | boolean;
    format?: string;
    id: string;
    if?: NBTSubSchemaRef;
    items?: NBTSubSchemaRef | NBTSubSchemaRef[];
    markdownDescription?: string;
    markdownEnumDescriptions?: string[];
    maximum?: number;
    maxItems?: number;
    maxLength?: number;
    maxProperties?: number;
    minimum?: number;
    minItems?: number;
    minLength?: number;
    minProperties?: number;
    multipleOf?: number;
    not?: NBTSubSchemaRef;
    oneOf?: NBTSubSchemaRef[];
    pattern?: string;
    patternErrorMessage?: string;
    patternProperties?: NBTSchemaMap;
    patternPropertiesTS?: NBTSchemaMap;
    properties?: NBTSchemaMap;
    propertyNames?: NBTSubSchemaRef;
    required?: string[];
    suggestSortText?: string;
    then?: NBTSubSchemaRef;
    title?: string;
    type: "compound";
    uniqueItems?: boolean;
}

Hierarchy (View Summary)

Properties

$comment? $fragment? $id? $ref? $schema? additionalItems? additionalProperties? allOf? allowComments? allowTrailingCommas? anyOf? const? contains? default? defaultSnippets? definitions? dependencies? deprecationMessage? description? doNotSuggest? else? enum? enumDescriptions? errorMessage? examples? exclusiveMaximum? exclusiveMinimum? format? id if? items? markdownDescription? markdownEnumDescriptions? maximum? maxItems? maxLength? maxProperties? minimum? minItems? minLength? minProperties? multipleOf? not? oneOf? pattern? patternErrorMessage? patternProperties? patternPropertiesTS? properties? propertyNames? required? suggestSortText? then? title? type uniqueItems?

Properties

Optional$comment

$comment?: string

Todo

Optional$fragment

$fragment?: false

If this is a schema fragment.

A schema fragment is a top-level schema that is able to have types other than compound, but is only meant to be used inside of other schemas.

Default

false

Optional$id

$id?: string

The ID of this schema.

Optional$ref

$ref?: string

The ID of another schema to reference.

Optional$schema

$schema?: string

The schema that this schema is based on.

OptionaladditionalItems

additionalItems?: NBTSubSchemaRef

Todo

OptionaladditionalProperties

additionalProperties?: NBTSubSchemaRef

Whether additional properties are allowed, or a schema to use for them.

OptionalallOf

allOf?: NBTSubSchemaRef[]

Todo

OptionalallowComments

allowComments?: boolean

Todo

OptionalallowTrailingCommas

allowTrailingCommas?: boolean

Todo

OptionalanyOf

anyOf?: NBTSubSchemaRef[]

Todo

Optionalconst

const?: any

Todo

Optionalcontains

contains?: NBTSubSchemaRef

Todo

Optionaldefault

default?: {
    type:
        | "string"
        | "byte"
        | "short"
        | "int"
        | "float"
        | "double"
        | "long"
        | "list"
        | "compound"
        | "byteArray"
        | "shortArray"
        | "intArray"
        | "longArray";
    value: any;
}

The default value for this schema.

OptionaldefaultSnippets

defaultSnippets?: {
    body?: any;
    bodyText?: string;
    description?: string;
    label?: string;
    markdownDescription?: string;
}[]

Type declaration

  • Optionalbody?: any

    The body of this snippet.

  • OptionalbodyText?: string

    The body text of this snippet.

  • Optionaldescription?: string

    The description of this snippet.

  • Optionallabel?: string

    The label of this snippet.

  • OptionalmarkdownDescription?: string

    The markdown description of this snippet.

Todo

Optionaldefinitions

definitions?: { [name: string]: NBTSchema }

Todo

Optionaldependencies

dependencies?: NBTSchemaMap | { [prop: string]: string[] }

Todo

OptionaldeprecationMessage

deprecationMessage?: string

Todo

Optionaldescription

description?: string

The description of this schema.

OptionaldoNotSuggest

doNotSuggest?: boolean

Todo

Optionalelse

else?: NBTSubSchemaRef

Todo

Optionalenum

enum?: (
    | Byte
    | Short
    | Int
    | Long
    | Float
    | Double
    | String
    | List<TagType>
    | Compound
    | ByteArray
    | ShortArray
    | IntArray
    | LongArray
)[]

The values of this enum.

OptionalenumDescriptions

enumDescriptions?: string[]

Descriptions for each enum value, in the same order as NBTSubSchema.enum.

OptionalerrorMessage

errorMessage?: string

Todo

Optionalexamples

examples?: (
    | Byte
    | Short
    | Int
    | Long
    | Float
    | Double
    | String
    | List<TagType>
    | Compound
    | ByteArray
    | ShortArray
    | IntArray
    | LongArray
)[]

Todo

OptionalexclusiveMaximum

exclusiveMaximum?: number | boolean

Todo

OptionalexclusiveMinimum

exclusiveMinimum?: number | boolean

Todo

Optionalformat

format?: string

Todo

id

id: string

The ID of this schema.

Optionalif

if?: NBTSubSchemaRef

Todo

Optionalitems

items?: NBTSubSchemaRef | NBTSubSchemaRef[]

Todo

OptionalmarkdownDescription

markdownDescription?: string

Todo

OptionalmarkdownEnumDescriptions

markdownEnumDescriptions?: string[]

Todo

Optionalmaximum

maximum?: number

Todo

OptionalmaxItems

maxItems?: number

Todo

OptionalmaxLength

maxLength?: number

Todo

OptionalmaxProperties

maxProperties?: number

Todo

Optionalminimum

minimum?: number

Todo

OptionalminItems

minItems?: number

Todo

OptionalminLength

minLength?: number

Todo

OptionalminProperties

minProperties?: number

Todo

OptionalmultipleOf

multipleOf?: number

Todo

Optionalnot

not?: NBTSubSchemaRef

Todo

OptionaloneOf

oneOf?: NBTSubSchemaRef[]

Todo

Optionalpattern

pattern?: string

Todo

OptionalpatternErrorMessage

patternErrorMessage?: string

Todo

OptionalpatternProperties

patternProperties?: NBTSchemaMap

A map of RegExp patterns to the NBT schemas for the properties that match.

OptionalpatternPropertiesTS

patternPropertiesTS?: NBTSchemaMap

Todo

Optionalproperties

properties?: NBTSchemaMap

The properties of this compound schema.

OptionalpropertyNames

propertyNames?: NBTSubSchemaRef

Todo

Optionalrequired

required?: string[]

Todo

OptionalsuggestSortText

suggestSortText?: string

Todo

Optionalthen

then?: NBTSubSchemaRef

Todo

Optionaltitle

title?: string

The title of this schema.

type

type: "compound"

The type of NBT tag this schema describes.

OptionaluniqueItems

uniqueItems?: boolean

Todo

Settings

Member Visibility

On This Page

Properties