Enum ParameterKind 

pub enum ParameterKind {
    Boolean,
    Dropdown {
        choices: Vec<String>,
    },
    Number {
        min: f32,
        max: f32,
        step: Option<f32>,
    },
    Text,
}

The type of control a ModParameter is edited with, and the data that type needs. Serializes flat alongside id/name/help_text via #[serde(flatten)] on ModParameter::kind, tagged by a "type" field, e.g.:

{ "id": "Fov_Boost", "name": "FOV boost", "help_text": "...",
  "type": "number", "min": 0.0, "max": 20.0, "step": 0.5 }

Variants

Boolean

A checkbox. May gate a RedirectionRule::enable_if.

Dropdown

A dropdown among choices. May gate a RedirectionRule::enable_if (empty-string selection = off). “(None)” is not implicit, a dropdown only has a “no selection” state if "" is itself one of choices; otherwise every choice is non-empty and the parameter is always “on” for gating purposes.

Fields

choices: Vec<String>

Number

A numeric slider between min and max, with an optional step. Cannot gate a rule, only usable via ${param_id} interpolation.

Fields

min: f32

max: f32

step: Option<f32>

Text

A free-text field. Cannot gate a rule, only usable via ${param_id} interpolation.

Trait Implementations

impl Clone for ParameterKind

fn clone(&self) -> ParameterKind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParameterKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParameterKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ParameterKind

fn eq(&self, other: &ParameterKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ParameterKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ParameterKind