Fields

A field is a description for a single named value, like a text or number (value) contained in a sheet. The description contains all the necessary propriety to validate, transmit and display instances of those values.

Each field is a table of property like this, those are defined propertie, provided by the dice witch, so one cannot choose the keys. All of them are optional, with a default value

Key For type Meaning Type(s) Default

Key	For type	Meaning	Type(s)	Default
`type`	all	type of the field either `"text"` or `"value"`	String	`"value"`
`name`	all	name to use in the interface	String	use related key as a string
`single_line`	text	Flag saying the text field is only one line and refuse line breaks	Boolean	false
`lines`	text	Limit of the number of lines	Integer	255
`max`	value	Maximum value of the number, it is a hint preventing accidental errors that can be manually overidden by the person running the game, op characters are safe	Integer	Upper Signed 32 bit integer limit
`min`	value	Minum value of the number, counterpart to `max`	Integer	Lower Signed 32 bit integer limit
`consumable`	value	Indicate a value is made of two numbers, a maximum and a current values. For example it’s what is often used to note health.	Boolean	`false`
`link`	all	Open ended link to an other field usable in rolls and derived fields. One can use it for example to declare the other characteristic something is always rolled with.	String or Array of String
`calc`	value	An automatic calculation whose result replace the value at all time	String*
`calc_initial`	value	An automatic calculation whose result is taken optionally during character creation, but doesn`t update during regular game	String*
`calc_current`	value with consumable=true	An automatic calculation whose result is taken optionally at all time, only for the current value of a consumable value	String*
`calc_initial_current`	value with consumable=true	An automatic calculation whose result is taken optionally during character creation, but doesn`t update during regular game, only for the current value of a consumable value	String*
`calc_max`	value with consumable=true	An automatic calculation whose result is taken optionally at all time, only for the max value of a consumable value	String*
`calc_initial_max`	value with consumable=true	An automatic calculation whose result is taken optionally during character creation, but doesn`t update during regular game, only for the max value of a consumable value	String*

type

all

type of the field either "text" or "value"

String

"value"

name

all

name to use in the interface

String

use related key as a string

single_line

text

Flag saying the text field is only one line and refuse line breaks

Boolean

false

lines

text

Limit of the number of lines

Integer

255

max

value

Maximum value of the number, it is a hint preventing accidental errors that can be manually overidden by the person running the game, op characters are safe

Integer

Upper Signed 32 bit integer limit

min

value

Minum value of the number, counterpart to max

Integer

Lower Signed 32 bit integer limit

consumable

value

Indicate a value is made of two numbers, a maximum and a current values. For example it’s what is often used to note health.

Boolean

false

link

all

Open ended link to an other field usable in rolls and derived fields.

One can use it for example to declare the other characteristic something is always rolled with.

String or Array of String

calc

value

An automatic calculation whose result replace the value at all time

String*

calc_initial

value

An automatic calculation whose result is taken optionally during character creation, but doesn`t update during regular game

String*

calc_current

value with consumable=true

An automatic calculation whose result is taken optionally at all time, only for the current value of a consumable value

String*

calc_initial_current

value with consumable=true

An automatic calculation whose result is taken optionally during character creation, but doesn`t update during regular game, only for the current value of a consumable value

String*

calc_max

value with consumable=true

An automatic calculation whose result is taken optionally at all time, only for the max value of a consumable value

String*

calc_initial_max

value with consumable=true

An automatic calculation whose result is taken optionally during character creation, but doesn`t update during regular game, only for the max value of a consumable value

String*

*: see calculation details

String shorthand

There is a possiblity to replace the table with a short pre defined text for common options. using the default values described above.

"value"

a simple number

"short_text"

a single line text

"text"

a text with multiple lines