Struct ParamField

pub struct ParamField {
    pub field_def: ParamFieldDef,
    pub display_name: Option<String>,
    pub enum_tdf: Option<String>,
    pub description: Option<String>,
    pub printf_format: Option<String>,
    pub edit_flags: Option<EditFlags>,
    pub minimum: Option<f64>,
    pub maximum: Option<f64>,
    pub increment: Option<f64>,
    pub sort_id: Option<usize>,
}

Declared metadata about fields in a param

Fields

field_def: ParamFieldDef

The definition of the field, including type and internal name, among others.

display_name: Option<String>

A user-friends display name.

enum_tdf: Option<String>

A type of enum declared by a paramdex that can be applied to this field. Unused.

description: Option<String>

A user-friendly description

printf_format: Option<String>

A printf(3) compatible format string for printing the data in this field. Unused.

edit_flags: Option<EditFlags>

Flags that inform a potential editor how to handle this field. Unused.

minimum: Option<f64>

Minimum value allowed to be input in an editor. Unused.

maximum: Option<f64>

Maximum value allowed to be input in an editor. Unused.

increment: Option<f64>

Increment value allowed to be input in an editor. Unused.

sort_id: Option<usize>

Declares sorting for a potential editor. Unused.