IInputSelect | Dataforged API

An input where the user selects a single option from a list of pre-set options. Suggested rendering: a drop-down selection menu.

example

{
  "Name": "Material",
  "Input Type": "Select",
  "Attributes": [
    { "Key": "Stat", "Type": "Stat" },
    { "Key": "Condition Meter", "Type": "Condition Meter" }
   ],
   "Options": [
     {
      "Name": "Thunderwood",
      "Sets": [
        { "Key": "Stat", "Value": "Edge" },
        { "Key": "Condition Meter", "Value": "Health" }
      ]
    }
  ]
}

Hierarchy

IInput
- IInputSelect

Index

Properties

$id

$id: string

pattern: ^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+(/Abilities/[1-3])?/Inputs/[A-z_-]+$

Adjustable

Adjustable: boolean

Whether the input's value is expected to change over the course of a campaign. For example, name fields are typically false, while something like a clock or tally would be true.

It's a good idea to make everything editable regardless, but this property might inform whether your UI presents that functionality "front and center" or as a secondary interaction (via long press, right click, etc);

Input Type

Input Type: Select

Name

Name: string

The item's internal name. Should be unique among its sibling elements, as this key is often used (along with the object's ancestors) to generate its $id.

If the item has Display.Title, that should be preferred for most user-facing labels.

Options

Options: IInputSelectOption[]

Sets

Sets: IInputSelectAttributeDefinition[]

Hints which attribute(s) set by this dropdown's options.