SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ContainerTextInput

    ContainerTextInput: Message<"soulfire.v1.ContainerTextInput"> & {
        currentValue: string;
        id: string;
        label: string;
        maxLength: number;
        placeholder: string;
    }

    Text input field in a container menu. Currently only used by the anvil for item renaming.

    Type Declaration

    • currentValue: string

      Current text value in the field. For anvil: the item's current custom name, or empty if none.

      from field: string current_value = 3;

    • id: string

      Field identifier for the SetContainerText RPC. Currently supported: "item_name" (anvil rename)

      from field: string id = 1;

    • label: string

      Display label for the input field.

      from field: string label = 2;

    • maxLength: number

      Maximum allowed character length. For anvil: 50 characters. Value of 0 means no limit.

      from field: int32 max_length = 4;

    • placeholder: string

      Placeholder text shown when field is empty.

      from field: string placeholder = 5;

    from message soulfire.v1.ContainerTextInput