Struct ModParameter 

pub struct ModParameter {
    pub id: String,
    pub name: String,
    pub help_text: String,
    pub kind: ParameterKind,
    pub enable_if: Option<String>,
    pub hidden: bool,
    pub validation: Option<String>,
}

One configurable setting a mod exposes to the launcher’s Mods page.

Fields

id: String

Stable identifier, referenced from RedirectionRule::enable_if, ${param_id} interpolation placeholders, and as a key into both this mod’s own ModConfig::configuration defaults and its entry in crate::mods_state::ModConfigurations.

name: String

Display name shown in the launcher UI.

help_text: String

Shown as a tooltip/help text next to the control in the launcher UI.

kind: ParameterKind

enable_if: Option<String>

Optional Rhai expression that must evaluate to true for this parameter to be editable in the launcher UI. When false (or when evaluation fails), the parameter falls back to its default value from ModConfig::configuration (or the type-appropriate zero value if no default exists). Other parameters’ enable_if expressions and rule enable_if expressions may still reference this parameter, gating only affects the UI control, not the parameter’s availability in the evaluation scope.

hidden: bool

hide this parameter from the launcher’s parameter editors entirely. Hidden parameters keep EVERY other behavior (validation, enable_if scope, ${...} interpolation, configuration merge, launcher-written overrides), they are just not user-facing controls. The online-tournament mod declares its tournament_env / tournament_difficulty / tournament_room_id this way: the launcher sets them when the player creates or joins a room; a user has no business editing them.

validation: Option<String>

Optional name of a shared validation rule set (see crate::validation) the launcher enforces live while the user edits this parameter: invalid input renders an error stroke and a warning icon whose hover carries the reason. Known tags: player_name, room_name; unknown tags fail ModConfig::validate. Only meaningful on text parameters.

Implementations

impl ModParameter

pub fn validate(&self) -> Result<(), String>

Structural validation, independent of any other parameter or rule, called from ModConfig::validate so a malformed mod.json surfaces as a clear per-mod error at load time.

Errors

Returns an error describing the problem if this parameter’s data is internally inconsistent (e.g. a dropdown with no choices, or a number range with min > max).

Trait Implementations

impl Clone for ModParameter

fn clone(&self) -> ModParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModParameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModParameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModParameter

fn eq(&self, other: &ModParameter) -> 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 ModParameter

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 ModParameter