diff --git a/modules/Bindings.html b/modules/Bindings.html index fd493c1..26535f5 100644 --- a/modules/Bindings.html +++ b/modules/Bindings.html @@ -1,4 +1,4 @@ -Bindings | D2RMM Mod API

Module Bindings

Index

Type Aliases

Binding +Bindings | D2RMM Mod API

Module Bindings

Index

Type Aliases

Binding BindingAnd BindingConditional BindingConfigValue diff --git a/modules/ConsoleAPI.html b/modules/ConsoleAPI.html index 36f5d82..6649a0a 100644 --- a/modules/ConsoleAPI.html +++ b/modules/ConsoleAPI.html @@ -1,2 +1,2 @@ -ConsoleAPI | D2RMM Mod API

Module ConsoleAPI

Index

Type Aliases

ConsoleAPI +ConsoleAPI | D2RMM Mod API

Module ConsoleAPI

Index

Type Aliases

ConsoleAPI

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/JSON.html b/modules/JSON.html index c1ec3fc..a8c6432 100644 --- a/modules/JSON.html +++ b/modules/JSON.html @@ -1,4 +1,4 @@ -JSON | D2RMM Mod API

Module JSON

Index

Type Aliases

JSONData +JSON | D2RMM Mod API

Module JSON

Index

Type Aliases

JSONData JSONDataValue JSONDataValues

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/ModAPI.html b/modules/ModAPI.html index 09e70c2..dc109bc 100644 --- a/modules/ModAPI.html +++ b/modules/ModAPI.html @@ -1,2 +1,2 @@ -ModAPI | D2RMM Mod API

Module ModAPI

Index

Type Aliases

ModAPI +ModAPI | D2RMM Mod API

Module ModAPI

Index

Type Aliases

ModAPI

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/ModConfig.html b/modules/ModConfig.html index cb8dd33..7313da0 100644 --- a/modules/ModConfig.html +++ b/modules/ModConfig.html @@ -1,4 +1,4 @@ -ModConfig | D2RMM Mod API

Module ModConfig

Index

Type Aliases

ModConfig +ModConfig | D2RMM Mod API

Module ModConfig

Index

Type Aliases

ModConfig ModConfigField ModConfigFieldBase ModConfigFieldCheckbox diff --git a/modules/ModConfigValue.html b/modules/ModConfigValue.html index a884a72..4006493 100644 --- a/modules/ModConfigValue.html +++ b/modules/ModConfigValue.html @@ -1,3 +1,3 @@ -ModConfigValue | D2RMM Mod API

Module ModConfigValue

Index

Type Aliases

ModConfigSingleValue +ModConfigValue | D2RMM Mod API

Module ModConfigValue

Index

Type Aliases

ModConfigSingleValue ModConfigValue

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/TSV.html b/modules/TSV.html index 4e59083..fd04a3e 100644 --- a/modules/TSV.html +++ b/modules/TSV.html @@ -1,4 +1,4 @@ -TSV | D2RMM Mod API

Module TSV

Index

Type Aliases

TSVData +TSV | D2RMM Mod API

Module TSV

Index

Type Aliases

TSVData TSVDataHeader TSVDataRow

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.Binding.html b/types/Bindings.Binding.html index 0489db6..c61a7c5 100644 --- a/types/Bindings.Binding.html +++ b/types/Bindings.Binding.html @@ -1,4 +1,4 @@ Binding | D2RMM Mod API

Type alias Binding<T>

Binding<T>: T extends string
    ? StringBinding
    : T extends number
        ? NumberBinding
        : T extends boolean
            ? BooleanBinding
            : T extends string[]
                ? StringArrayBinding
                : T extends number[]
                    ? NumberArrayBinding
                    : BindingLiteralValue<T>

A binding that can be dynamically evaluated to a value.

Type Parameters

  • T

Example

{
  "id": "MyConfigField",
  "type": "checkbox",
},
{
  // ...
  "visible": ["value", "MyConfigField"],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingAnd.html b/types/Bindings.BindingAnd.html index 4a1bc5e..e7c87ca 100644 --- a/types/Bindings.BindingAnd.html +++ b/types/Bindings.BindingAnd.html @@ -1,4 +1,4 @@ BindingAnd | D2RMM Mod API

Type alias BindingAnd

BindingAnd: [operator: "and", binding1: Binding<boolean>, binding2: Binding<boolean>]

Checks if both the first parameters (boolean) and the second parameter (boolean) are both true.

Example

{
  "id": "MyConfigField1",
  "type": "checkbox",
},
{
  "id": "MyConfigField2",
  "type": "checkbox",
},
{
  // ...
  "visible": ["and", ["value", "MyConfigField1"], ["value", "MyConfigField2"]],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingConditional.html b/types/Bindings.BindingConditional.html index 653c9db..3ad160f 100644 --- a/types/Bindings.BindingConditional.html +++ b/types/Bindings.BindingConditional.html @@ -2,4 +2,4 @@

Type Parameters

  • T

Remarks

The type of the second and third parameters must be the same.

Example

{
  "id": "MyConfigField",
  "type": "checkbox",
},
{
  // ...
  "visible": ["if", ["value", "MyConfigField"], true, false],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingConfigValue.html b/types/Bindings.BindingConfigValue.html index edb668c..eb829f4 100644 --- a/types/Bindings.BindingConfigValue.html +++ b/types/Bindings.BindingConfigValue.html @@ -1,4 +1,4 @@ BindingConfigValue | D2RMM Mod API

Type alias BindingConfigValue<_T>

BindingConfigValue<_T>: [operator: "value", id: string]

Returns the value of a configuration field.

Type Parameters

Example

{
  "id": "MyConfigField",
  "type": "checkbox",
},
{
  // ...
  "visible": ["value", "MyConfigField"],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingEquals.html b/types/Bindings.BindingEquals.html index b3de6d0..9be8c43 100644 --- a/types/Bindings.BindingEquals.html +++ b/types/Bindings.BindingEquals.html @@ -1,4 +1,4 @@ BindingEquals | D2RMM Mod API

Type alias BindingEquals<T>

BindingEquals<T>: [operator: "eq", binding1: Binding<T>, binding2: Binding<T>]

Checks if the first parameter (T) is equal to the second parameter (T).

Type Parameters

  • T

Example

{
  "id": "MyConfigField",
  "type": "number",
},
{
  // ...
  "visible": ["eq", ["value", "MyConfigField"], 123],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingGreaterThan.html b/types/Bindings.BindingGreaterThan.html index 614f967..4be8819 100644 --- a/types/Bindings.BindingGreaterThan.html +++ b/types/Bindings.BindingGreaterThan.html @@ -1,4 +1,4 @@ BindingGreaterThan | D2RMM Mod API

Type alias BindingGreaterThan

BindingGreaterThan: [operator: "gt", binding1: Binding<number>, binding2: Binding<number>]

Checks if the first parameter (number) is greater than the second parameter (number).

Example

{
  "id": "MyConfigField",
  "type": "number",
},
{
  // ...
  "visible": ["gt", ["value", "MyConfigField"], 123],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingGreaterThanOrEqual.html b/types/Bindings.BindingGreaterThanOrEqual.html index 0b05fa5..9ac28e9 100644 --- a/types/Bindings.BindingGreaterThanOrEqual.html +++ b/types/Bindings.BindingGreaterThanOrEqual.html @@ -1,4 +1,4 @@ BindingGreaterThanOrEqual | D2RMM Mod API

Type alias BindingGreaterThanOrEqual

BindingGreaterThanOrEqual: [operator: "gte", binding1: Binding<number>, binding2: Binding<number>]

CHecks if the first parameter (number) is greater than or equal to the second parameter (number).

Example

{
  "id": "MyConfigField",
  "type": "number",
},
{
  // ...
  "visible": ["gte", ["value", "MyConfigField"], 123],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingIncludes.html b/types/Bindings.BindingIncludes.html index 4c3b9b8..3de009a 100644 --- a/types/Bindings.BindingIncludes.html +++ b/types/Bindings.BindingIncludes.html @@ -1,4 +1,4 @@ BindingIncludes | D2RMM Mod API

Type alias BindingIncludes<T>

BindingIncludes<T>: [operator: "in", binding1: Binding<T>, binding2: T extends string
    ? Binding<string[]>
    : T extends number
        ? Binding<number[]>
        : never]

Checks if the first parameter (string or number) is a part of the second parameter (string[] or number[]).

Type Parameters

  • T

Example

{
  "id": "MyConfigField",
  "type": "text",
},
{
  // ...
  "visible": ["in", "foo", ["value", "MyConfigField"]],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingLessThan.html b/types/Bindings.BindingLessThan.html index 0877aff..36ef61c 100644 --- a/types/Bindings.BindingLessThan.html +++ b/types/Bindings.BindingLessThan.html @@ -1,4 +1,4 @@ BindingLessThan | D2RMM Mod API

Type alias BindingLessThan

BindingLessThan: [operator: "lt", binding1: Binding<number>, binding2: Binding<number>]

Checks if the first parameter (number) is less than the second parameter (number).

Example

{
  "id": "MyConfigField",
  "type": "number",
},
{
  // ...
  "visible": ["lt", ["value", "MyConfigField"], 123],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingLessThanOrEqual.html b/types/Bindings.BindingLessThanOrEqual.html index adbd40b..ecde6d8 100644 --- a/types/Bindings.BindingLessThanOrEqual.html +++ b/types/Bindings.BindingLessThanOrEqual.html @@ -1,4 +1,4 @@ BindingLessThanOrEqual | D2RMM Mod API

Type alias BindingLessThanOrEqual

BindingLessThanOrEqual: [operator: "lte", binding1: Binding<number>, binding2: Binding<number>]

Checks if the first parameter (number) is less than or equal to the second parameter (number).

Example

{
  "id": "MyConfigField",
  "type": "number",
},
{
  // ...
  "visible": ["lte", ["value", "MyConfigField"], 123],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingLiteralValue.html b/types/Bindings.BindingLiteralValue.html index 5996791..eed18a7 100644 --- a/types/Bindings.BindingLiteralValue.html +++ b/types/Bindings.BindingLiteralValue.html @@ -1,4 +1,4 @@ BindingLiteralValue | D2RMM Mod API

Type alias BindingLiteralValue<T>

BindingLiteralValue<T>: T

A literal JSON value.

Type Parameters

  • T

Example

{
  // ...
  "visible": true,
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingNot.html b/types/Bindings.BindingNot.html index 2ec6622..fc025d9 100644 --- a/types/Bindings.BindingNot.html +++ b/types/Bindings.BindingNot.html @@ -1,4 +1,4 @@ BindingNot | D2RMM Mod API

Type alias BindingNot

BindingNot: [operator: "not", binding: Binding<boolean>]

Checks if the parameter (boolean) is false.

Example

{
  "id": "MyConfigField",
  "type": "checkbox",
},
{
  // ...
  "visible": ["not", ["value", "MyConfigField"]],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingNotEquals.html b/types/Bindings.BindingNotEquals.html index 7a6efc2..e4ba380 100644 --- a/types/Bindings.BindingNotEquals.html +++ b/types/Bindings.BindingNotEquals.html @@ -1,4 +1,4 @@ BindingNotEquals | D2RMM Mod API

Type alias BindingNotEquals<T>

BindingNotEquals<T>: [operator: "neq", binding1: Binding<T>, binding2: Binding<T>]

Checks if the first parameter (T) is not equal to the second parameter (T).

Type Parameters

  • T

Example

{
  "id": "MyConfigField",
  "type": "number",
},
{
  // ...
  "visible": ["neq", ["value", "MyConfigField"], 123],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BindingOr.html b/types/Bindings.BindingOr.html index 552d684..fd11945 100644 --- a/types/Bindings.BindingOr.html +++ b/types/Bindings.BindingOr.html @@ -1,4 +1,4 @@ BindingOr | D2RMM Mod API

Type alias BindingOr

BindingOr: [operator: "or", binding1: Binding<boolean>, binding2: Binding<boolean>]

Checks if either the first parameters (boolean) or the second parameter (boolean) is true.

Example

{
  "id": "MyConfigField1",
  "type": "checkbox",
},
{
  "id": "MyConfigField2",
  "type": "checkbox",
},
{
  // ...
  "visible": ["or", ["value", "MyConfigField1"], ["value", "MyConfigField2"]],
},
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.BooleanBinding.html b/types/Bindings.BooleanBinding.html index d448625..553317a 100644 --- a/types/Bindings.BooleanBinding.html +++ b/types/Bindings.BooleanBinding.html @@ -1,2 +1,2 @@ BooleanBinding | D2RMM Mod API

Type alias BooleanBinding

BooleanBinding: BindingLiteralValue<boolean> | BindingConfigValue<boolean> | BindingConditional<boolean> | BindingNot | BindingAnd | BindingOr | BindingEquals<string> | BindingEquals<boolean> | BindingEquals<number> | BindingNotEquals<string> | BindingNotEquals<boolean> | BindingNotEquals<number> | BindingLessThan | BindingLessThanOrEqual | BindingGreaterThan | BindingGreaterThanOrEqual | BindingIncludes<string> | BindingIncludes<number>

A binding that can be dynamically evaluated to a boolean value.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.NumberArrayBinding.html b/types/Bindings.NumberArrayBinding.html index 00bb5e3..2e20fba 100644 --- a/types/Bindings.NumberArrayBinding.html +++ b/types/Bindings.NumberArrayBinding.html @@ -1,2 +1,2 @@ NumberArrayBinding | D2RMM Mod API

Type alias NumberArrayBinding

NumberArrayBinding: BindingLiteralValue<number[]> | BindingConfigValue<number[]> | BindingConditional<boolean>

A binding that can be dynamically evaluated to a number[] value.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.NumberBinding.html b/types/Bindings.NumberBinding.html index fba46b0..d44c0ff 100644 --- a/types/Bindings.NumberBinding.html +++ b/types/Bindings.NumberBinding.html @@ -1,2 +1,2 @@ NumberBinding | D2RMM Mod API

Type alias NumberBinding

NumberBinding: BindingLiteralValue<number> | BindingConfigValue<number> | BindingConditional<boolean>

A binding that can be dynamically evaluated to a number value.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.StringArrayBinding.html b/types/Bindings.StringArrayBinding.html index 8badb88..5bbce99 100644 --- a/types/Bindings.StringArrayBinding.html +++ b/types/Bindings.StringArrayBinding.html @@ -1,2 +1,2 @@ StringArrayBinding | D2RMM Mod API

Type alias StringArrayBinding

StringArrayBinding: BindingLiteralValue<string[]> | BindingConfigValue<string[]> | BindingConditional<boolean>

A binding that can be dynamically evaluated to a string[] value.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Bindings.StringBinding.html b/types/Bindings.StringBinding.html index 8bf1104..0838382 100644 --- a/types/Bindings.StringBinding.html +++ b/types/Bindings.StringBinding.html @@ -1,2 +1,2 @@ StringBinding | D2RMM Mod API

Type alias StringBinding

StringBinding: BindingLiteralValue<string> | BindingConfigValue<string> | BindingConditional<boolean>

A binding that can be dynamically evaluated to a string value.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/ConsoleAPI.ConsoleAPI.html b/types/ConsoleAPI.ConsoleAPI.html index 53e7e0c..24841d1 100644 --- a/types/ConsoleAPI.ConsoleAPI.html +++ b/types/ConsoleAPI.ConsoleAPI.html @@ -1,4 +1,4 @@ ConsoleAPI | D2RMM Mod API

Type alias ConsoleAPI

ConsoleAPI: {
    debug: ((...args) => void);
    error: ((...args) => void);
    log: ((...args) => void);
    warn: ((...args) => void);
}

A console interface similar to that provided by the DOM or Node. It will print to D2RMM's logs tab.

Type declaration

  • debug: ((...args) => void)
      • (...args): void

      • Parameters

        • Rest ...args: unknown[]

        Returns void

  • error: ((...args) => void)
      • (...args): void

      • Parameters

        • Rest ...args: unknown[]

        Returns void

  • log: ((...args) => void)
      • (...args): void

      • Parameters

        • Rest ...args: unknown[]

        Returns void

  • warn: ((...args) => void)
      • (...args): void

      • Parameters

        • Rest ...args: unknown[]

        Returns void

See

https://developer.mozilla.org/en-US/docs/Web/API/Console

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/JSON.JSONData.html b/types/JSON.JSONData.html index 04d04fa..f467a63 100644 --- a/types/JSON.JSONData.html +++ b/types/JSON.JSONData.html @@ -1,2 +1,2 @@ JSONData | D2RMM Mod API

Type alias JSONData

JSONData: {
    [key: string]: JSONDataValues | JSONData;
}

The parsed data of a JSON file.

-

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/JSON.JSONDataValue.html b/types/JSON.JSONDataValue.html index ac2532b..b0dcf27 100644 --- a/types/JSON.JSONDataValue.html +++ b/types/JSON.JSONDataValue.html @@ -1,2 +1,2 @@ JSONDataValue | D2RMM Mod API

Type alias JSONDataValue

JSONDataValue: string | number | boolean

A single value in a JSON data structure.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/JSON.JSONDataValues.html b/types/JSON.JSONDataValues.html index 11e1857..4943960 100644 --- a/types/JSON.JSONDataValues.html +++ b/types/JSON.JSONDataValues.html @@ -1,2 +1,2 @@ JSONDataValues | D2RMM Mod API

Type alias JSONDataValues

JSONDataValues: JSONDataValue | JSONDataValue[]

One or more value in a JSON data structure.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/ModAPI.ModAPI.html b/types/ModAPI.ModAPI.html index 59e5309..a91d416 100644 --- a/types/ModAPI.ModAPI.html +++ b/types/ModAPI.ModAPI.html @@ -74,4 +74,4 @@

Returns

The raw text data.

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/ModConfig.ModConfig.html b/types/ModConfig.ModConfig.html index 3583d47..0f494b3 100644 --- a/types/ModConfig.ModConfig.html +++ b/types/ModConfig.ModConfig.html @@ -7,4 +7,4 @@
  • type: "d2rmm" | "data"

    Type of the mod.

  • Optional version?: string

    The version of the mod.

  • Optional website?: string

    The website of the mod. Ideally, this should link to the Nexus Mods page for the mod.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigField.html b/types/ModConfig.ModConfigField.html index bf2a663..484b359 100644 --- a/types/ModConfig.ModConfigField.html +++ b/types/ModConfig.ModConfigField.html @@ -1,2 +1,2 @@ ModConfigField | D2RMM Mod API

    Type alias ModConfigField

    ModConfigField: ModConfigFieldCheckbox | ModConfigFieldNumber | ModConfigFieldText | ModConfigFieldSelect | ModConfigFieldColor

    Represents a single configuration field.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigFieldBase.html b/types/ModConfig.ModConfigFieldBase.html index 7866bda..8ce8147 100644 --- a/types/ModConfig.ModConfigFieldBase.html +++ b/types/ModConfig.ModConfigFieldBase.html @@ -1,2 +1,2 @@ ModConfigFieldBase | D2RMM Mod API

    Type alias ModConfigFieldBase

    ModConfigFieldBase: {
        description: string;
        id: string;
        name: string;
        visible?: Binding<boolean>;
    }

    Represents the base structure of any configuration field.

    -

    Type declaration

    • description: string
    • id: string
    • name: string
    • Optional visible?: Binding<boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigFieldCheckbox.html b/types/ModConfig.ModConfigFieldCheckbox.html index e941324..152692b 100644 --- a/types/ModConfig.ModConfigFieldCheckbox.html +++ b/types/ModConfig.ModConfigFieldCheckbox.html @@ -1,3 +1,3 @@ ModConfigFieldCheckbox | D2RMM Mod API

    Type alias ModConfigFieldCheckbox

    ModConfigFieldCheckbox: ModConfigFieldBase & {
        defaultValue: boolean;
        type: "checkbox";
    }

    Represents a boolean (true/false) configuration field that will be represented as a checkbox or toggle element in the configuration UI.

    -

    Type declaration

    • defaultValue: boolean
    • type: "checkbox"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigFieldColor.html b/types/ModConfig.ModConfigFieldColor.html index c782946..b8f189c 100644 --- a/types/ModConfig.ModConfigFieldColor.html +++ b/types/ModConfig.ModConfigFieldColor.html @@ -1,3 +1,3 @@ ModConfigFieldColor | D2RMM Mod API

    Type alias ModConfigFieldColor

    ModConfigFieldColor: ModConfigFieldBase & {
        defaultValue: [number, number, number, number];
        isAlphaHidden?: boolean;
        type: "color";
    }

    Represents a color configuration field that will be represented as a color picker element in the configuration UI.

    -

    Type declaration

    • defaultValue: [number, number, number, number]
    • Optional isAlphaHidden?: boolean
    • type: "color"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigFieldNumber.html b/types/ModConfig.ModConfigFieldNumber.html index 1d126f5..ac54363 100644 --- a/types/ModConfig.ModConfigFieldNumber.html +++ b/types/ModConfig.ModConfigFieldNumber.html @@ -1,3 +1,3 @@ ModConfigFieldNumber | D2RMM Mod API

    Type alias ModConfigFieldNumber

    ModConfigFieldNumber: ModConfigFieldBase & {
        defaultValue: number;
        maxValue?: number;
        minValue?: number;
        type: "number";
    }

    Represents a number configuration field that will be represented as a number input in the configuration UI.

    -

    Type declaration

    • defaultValue: number
    • Optional maxValue?: number
    • Optional minValue?: number
    • type: "number"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigFieldOrSection.html b/types/ModConfig.ModConfigFieldOrSection.html index ea2d3ad..f71252a 100644 --- a/types/ModConfig.ModConfigFieldOrSection.html +++ b/types/ModConfig.ModConfigFieldOrSection.html @@ -1,2 +1,2 @@ ModConfigFieldOrSection | D2RMM Mod API

    Type alias ModConfigFieldOrSection

    ModConfigFieldOrSection: ModConfigFieldSection | ModConfigField

    Represents a single configuration field or section.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigFieldSection.html b/types/ModConfig.ModConfigFieldSection.html index 37f54d9..601e93e 100644 --- a/types/ModConfig.ModConfigFieldSection.html +++ b/types/ModConfig.ModConfigFieldSection.html @@ -1,2 +1,2 @@ ModConfigFieldSection | D2RMM Mod API

    Type alias ModConfigFieldSection

    ModConfigFieldSection: {
        children?: readonly ModConfigFieldOrSection[];
        defaultExpanded?: boolean;
        id: string;
        name: string;
        type: "section";
    }

    Represents a section in the configuration UI that can contain other fields or sections.

    -

    Type declaration

    • Optional children?: readonly ModConfigFieldOrSection[]
    • Optional defaultExpanded?: boolean
    • id: string
    • name: string
    • type: "section"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigFieldSelect.html b/types/ModConfig.ModConfigFieldSelect.html index 2e65f37..45f0419 100644 --- a/types/ModConfig.ModConfigFieldSelect.html +++ b/types/ModConfig.ModConfigFieldSelect.html @@ -1,3 +1,3 @@ ModConfigFieldSelect | D2RMM Mod API

    Type alias ModConfigFieldSelect

    ModConfigFieldSelect: ModConfigFieldBase & {
        defaultValue: string;
        options: {
            description?: string;
            label: string;
            value: ModConfigSingleValue;
        }[];
        type: "select";
    }

    Represents a select configuration field that will be represented as a dropdown select element in the configuration UI.

    -

    Type declaration

    • defaultValue: string
    • options: {
          description?: string;
          label: string;
          value: ModConfigSingleValue;
      }[]
    • type: "select"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfig.ModConfigFieldText.html b/types/ModConfig.ModConfigFieldText.html index 9567ce8..b645991 100644 --- a/types/ModConfig.ModConfigFieldText.html +++ b/types/ModConfig.ModConfigFieldText.html @@ -1,3 +1,3 @@ ModConfigFieldText | D2RMM Mod API

    Type alias ModConfigFieldText

    ModConfigFieldText: ModConfigFieldBase & {
        defaultValue: number;
        type: "text";
    }

    Represents a text configuration field that will be represented as a text input in the configuration UI.

    -

    Type declaration

    • defaultValue: number
    • type: "text"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfigValue.ModConfigSingleValue.html b/types/ModConfigValue.ModConfigSingleValue.html index d4dfbd5..14fe03a 100644 --- a/types/ModConfigValue.ModConfigSingleValue.html +++ b/types/ModConfigValue.ModConfigSingleValue.html @@ -1,2 +1,2 @@ ModConfigSingleValue | D2RMM Mod API

    Type alias ModConfigSingleValue

    ModConfigSingleValue: string | number | boolean | string[] | number[]

    Represents the valid value of any single configuration field.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ModConfigValue.ModConfigValue.html b/types/ModConfigValue.ModConfigValue.html index a2379ea..eae275b 100644 --- a/types/ModConfigValue.ModConfigValue.html +++ b/types/ModConfigValue.ModConfigValue.html @@ -1,3 +1,3 @@ ModConfigValue | D2RMM Mod API

    Type alias ModConfigValue

    ModConfigValue: Readonly<{
        [key: string]: ModConfigSingleValue;
    }>

    This is the structure of the mod config as it is passed to the mod's implementation.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TSV.TSVData.html b/types/TSV.TSVData.html index 429c41a..1f7ad02 100644 --- a/types/TSV.TSVData.html +++ b/types/TSV.TSVData.html @@ -1,4 +1,4 @@ TSVData | D2RMM Mod API

    Type alias TSVData

    TSVData: {
        headers: TSVDataHeader[];
        rows: TSVDataRow[];
    }

    The parsed data of a TSV file.

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TSV.TSVDataHeader.html b/types/TSV.TSVDataHeader.html index 2bf85ad..8ae50d4 100644 --- a/types/TSV.TSVDataHeader.html +++ b/types/TSV.TSVDataHeader.html @@ -1,2 +1,2 @@ TSVDataHeader | D2RMM Mod API

    Type alias TSVDataHeader

    TSVDataHeader: string

    The name of a column in a TSV file.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TSV.TSVDataRow.html b/types/TSV.TSVDataRow.html index d22aac7..795722e 100644 --- a/types/TSV.TSVDataRow.html +++ b/types/TSV.TSVDataRow.html @@ -1,2 +1,2 @@ TSVDataRow | D2RMM Mod API

    Type alias TSVDataRow

    TSVDataRow: {
        [header: TSVDataHeader]: string;
    }

    A single row in a TSV file.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file