Class EvaluateParameters_NamedIgnorableParamater

An ignorable named parameter.

This is used for the evaluateParameters function to allow changing the order of named ignorable parameters that are defined next to each other.

Implements

Constructors

constructor

Properties

delimeter key? name nameIsCaseSensitive type value valueType

Constructors

constructor

  • new EvaluateParameters_NamedIgnorableParamater(
        parameter: {
            delimeter?: LooseAutocomplete<"">;
            key?: LooseAutocomplete<"">;
            maxLength?: number;
            name: LooseAutocomplete<"">;
            nameIsCaseSensitive?: boolean;
            type: "ignorableNamedParameter";
            valueType?:
                | {
                    key?: LooseAutocomplete<""> | undefined;
                    maxLength?: number;
                    type: | "string"
                    | "number"
                    | "boolean"
                    | "Vector"
                    | "block"
                    | "dimension"
                    | "targetSelector"
                    | "presetText"
                    | "json"
                    | "placeholder"
                    | "neboolean"
                    | "non-booleanString"
                    | "Vector1"
                    | "Vector2"
                    | "Vector3"
                    | "Vector4"
                    | "Vector5"
                    | "Vector6"
                    | "Vector7"
                    | "Vector8"
                    | "blockStates"
                    | "blockPattern"
                    | "blockMask"
                    | `-${string}`
                    | `f-${string}`;
                }
                | {
                    key?: LooseAutocomplete<""> | undefined;
                    maxLength?: number;
                    type: "Vectors";
                    vectorCount?: number;
                }
                | stringEvaluateParametersParameter;
        },
    ): Globals.modules.cmds.EvaluateParameters_NamedIgnorableParamater

    Creates a new instance of the EvaluateParameters_NamedIgnorableParamater class.

    Parameters

    • parameter: {
          delimeter?: LooseAutocomplete<"">;
          key?: LooseAutocomplete<"">;
          maxLength?: number;
          name: LooseAutocomplete<"">;
          nameIsCaseSensitive?: boolean;
          type: "ignorableNamedParameter";
          valueType?:
              | {
                  key?: LooseAutocomplete<""> | undefined;
                  maxLength?: number;
                  type: | "string"
                  | "number"
                  | "boolean"
                  | "Vector"
                  | "block"
                  | "dimension"
                  | "targetSelector"
                  | "presetText"
                  | "json"
                  | "placeholder"
                  | "neboolean"
                  | "non-booleanString"
                  | "Vector1"
                  | "Vector2"
                  | "Vector3"
                  | "Vector4"
                  | "Vector5"
                  | "Vector6"
                  | "Vector7"
                  | "Vector8"
                  | "blockStates"
                  | "blockPattern"
                  | "blockMask"
                  | `-${string}`
                  | `f-${string}`;
              }
              | {
                  key?: LooseAutocomplete<""> | undefined;
                  maxLength?: number;
                  type: "Vectors";
                  vectorCount?: number;
              }
              | stringEvaluateParametersParameter;
      }

      The named ignorable parameter.

      • Optionaldelimeter?: LooseAutocomplete<"">

        The delimeter to use between the name and the value.

        This uses the LooseAutocomplete type to make sure that the type is inferred as a string literal rather than the generic string type.

        Default

        "="
      • Optionalkey?: LooseAutocomplete<"">

        The key to use for this parameter.

        If specified, it will be used as the property name used in the returned args object.

        This uses the LooseAutocomplete type to make sure that the type is inferred as a string literal rather than the generic string type.

        Default

        Index
      • OptionalmaxLength?: number

        The maximum length of the parameter.

        Deprecated

        This property is unused.

        Default

        Infinity
      • name: LooseAutocomplete<"">

        The name of the parameter.

        This will be used for users to provide the parameter.

        The value users will enter will be formatted as: ${name}${delimeter ?? "="}value or ${name}${delimeter ?? "="}"value with spaces and escape codes"

        This uses the LooseAutocomplete type to make sure that the type is inferred as a string literal rather than the generic string type.

      • OptionalnameIsCaseSensitive?: boolean

        Whether the name is case sensitive.

        Default

        false
      • type: "ignorableNamedParameter"

        The type of the parameter.

      • OptionalvalueType?:
            | {
                key?: LooseAutocomplete<""> | undefined;
                maxLength?: number;
                type: | "string"
                | "number"
                | "boolean"
                | "Vector"
                | "block"
                | "dimension"
                | "targetSelector"
                | "presetText"
                | "json"
                | "placeholder"
                | "neboolean"
                | "non-booleanString"
                | "Vector1"
                | "Vector2"
                | "Vector3"
                | "Vector4"
                | "Vector5"
                | "Vector6"
                | "Vector7"
                | "Vector8"
                | "blockStates"
                | "blockPattern"
                | "blockMask"
                | `-${string}`
                | `f-${string}`;
            }
            | {
                key?: LooseAutocomplete<""> | undefined;
                maxLength?: number;
                type: "Vectors";
                vectorCount?: number;
            }
            | stringEvaluateParametersParameter

        The value type of the parameter.

        This currently only supports the following types:

        • string
        • number
        • boolean

        Default

        "string"

    Returns Globals.modules.cmds.EvaluateParameters_NamedIgnorableParamater

Properties

delimeter

delimeter: undefined | LooseAutocomplete<"">

The delimeter to use between the name and the value.

This uses the LooseAutocomplete type to make sure that the type is inferred as a string literal rather than the generic string type.

Default

"="

Optionalkey

key?: string

The key to use for this parameter.

If specified, it will be used as the property name used in the returned args object.

This uses the LooseAutocomplete type to make sure that the type is inferred as a string literal rather than the generic string type.

Default

Index

name

name: LooseAutocomplete<"">

The name of the parameter.

This will be used for users to provide the parameter.

The value users will enter will be formatted as: ${name}${delimeter ?? "="}value or ${name}${delimeter ?? "="}"value with spaces and escape codes"

This uses the LooseAutocomplete type to make sure that the type is inferred as a string literal rather than the generic string type.

nameIsCaseSensitive

nameIsCaseSensitive: undefined | boolean

Whether the name is case sensitive.

Default

false

type

type: "ignorableNamedParameter"

The type of the parameter.

value

value: undefined | null | string | number | boolean = null

The detected value of the parameter fron the command string.

Default

null

valueType

valueType:
    | undefined
    | {
        key?: LooseAutocomplete<""> | undefined;
        maxLength?: number;
        type: | "string"
        | "number"
        | "boolean"
        | "Vector"
        | "block"
        | "dimension"
        | "targetSelector"
        | "presetText"
        | "json"
        | "placeholder"
        | "neboolean"
        | "non-booleanString"
        | "Vector1"
        | "Vector2"
        | "Vector3"
        | "Vector4"
        | "Vector5"
        | "Vector6"
        | "Vector7"
        | "Vector8"
        | "blockStates"
        | "blockPattern"
        | "blockMask"
        | `-${string}`
        | `f-${string}`;
    }
    | {
        key?: LooseAutocomplete<""> | undefined;
        maxLength?: number;
        type: "Vectors";
        vectorCount?: number;
    }
    | stringEvaluateParametersParameter

The value type of the parameter.

This currently only supports the following types:

  • string
  • number
  • boolean

Type declaration

  • undefined
  • {
        key?: LooseAutocomplete<""> | undefined;
        maxLength?: number;
        type:
            | "string"
            | "number"
            | "boolean"
            | "Vector"
            | "block"
            | "dimension"
            | "targetSelector"
            | "presetText"
            | "json"
            | "placeholder"
            | "neboolean"
            | "non-booleanString"
            | "Vector1"
            | "Vector2"
            | "Vector3"
            | "Vector4"
            | "Vector5"
            | "Vector6"
            | "Vector7"
            | "Vector8"
            | "blockStates"
            | "blockPattern"
            | "blockMask"
            | `-${string}`
            | `f-${string}`;
    }
    • Optionalkey?: LooseAutocomplete<""> | undefined

      The key to use for this parameter.

      If specified, it will be used as the property name used in the returned args object.

      This uses the LooseAutocomplete type to make sure that the type is inferred as a string literal rather than the generic string type.

      Default

      Index
    • OptionalmaxLength?: number

      The maximum length of the parameter.

      Deprecated

      This property is unused.

      Default

      Infinity
    • type:
          | "string"
          | "number"
          | "boolean"
          | "Vector"
          | "block"
          | "dimension"
          | "targetSelector"
          | "presetText"
          | "json"
          | "placeholder"
          | "neboolean"
          | "non-booleanString"
          | "Vector1"
          | "Vector2"
          | "Vector3"
          | "Vector4"
          | "Vector5"
          | "Vector6"
          | "Vector7"
          | "Vector8"
          | "blockStates"
          | "blockPattern"
          | "blockMask"
          | `-${string}`
          | `f-${string}`

      The type of the parameter.

  • {
        key?: LooseAutocomplete<""> | undefined;
        maxLength?: number;
        type: "Vectors";
        vectorCount?: number;
    }
    • Optionalkey?: LooseAutocomplete<""> | undefined

      The key to use for this parameter.

      If specified, it will be used as the property name used in the returned args object.

      This uses the LooseAutocomplete type to make sure that the type is inferred as a string literal rather than the generic string type.

      Default

      Index
    • OptionalmaxLength?: number

      The maximum length of the parameter.

      Deprecated

      This property is unused.

      Default

      Infinity
    • type: "Vectors"

      The type of the parameter.

    • OptionalvectorCount?: number

      The number of vectors to expect.

      Default

      3
  • stringEvaluateParametersParameter

Default

"string"

Settings

Member Visibility

On This Page

Constructors
Properties