Struct LightArgs 

pub struct LightArgs {

    pub openmw_cfg: Option<PathBuf>,
    pub use_classic: bool,
    pub output: Option<PathBuf>,
    pub auto_enable: bool,
    pub no_notifications: bool,
    pub debug: bool,
    pub dry_run: Option<bool>,
    pub validate_config: Option<bool>,
    pub generate_completion: Option<Shell>,
    pub generate_manpage: bool,
    pub disable_flickering: Option<bool>,
    pub disable_pulse: Option<bool>,
    pub disable_negative_lights: Option<bool>,
    pub standard_hue: Option<f32>,
    pub standard_saturation: Option<f32>,
    pub standard_value: Option<f32>,
    pub standard_radius: Option<f32>,
    pub colored_hue: Option<f32>,
    pub colored_saturation: Option<f32>,
    pub colored_value: Option<f32>,
    pub colored_radius: Option<f32>,
    pub duration_mult: Option<f32>,
    pub excluded_ids: Vec<String>,
    pub excluded_plugins: Vec<String>,
    pub light_overrides: Vec<(String, CustomLightData)>,
    pub ambient_overrides: Vec<(String, CustomCellAmbient)>,
    pub update_light_config: bool,
}

Fields

openmw_cfg: Option<PathBuf>

Path to openmw.cfg By default, uses the system paths defined by: https://openmw.readthedocs.io/en/latest/reference/modding/paths.html Can be the literal path to an openmw.cfg file (including not literally being called openmw.cfg) Or the directory in which an openmw.cfg file lives.

use_classic: bool

Enables classic mode using vtastek shaders. ONLY for openmw 0.47. Relevant shaders can be found in the OpenMW discord: https://discord.com/channels/260439894298460160/718892786157617163/966468825321177148

output: Option<PathBuf>

Output directory. The plugin may be saved to any location, but its name will always be S3Lightfixes.omwaddon. Accepts relative and absolute terms.

auto_enable: bool

Whether to automatically enable the output plugin in openmw.cfg. Disabled by default. Typically lightfixes is ran under momw-configurator, making this param unnecessary for many users.

no_notifications: bool

If used, print to stdout instead of using native GUI dialogs. Not available on android.

debug: bool

Output debugging information during lightfixes generation Primarily displays output related to the openmw.cfg being used for generation

dry_run: Option<bool>

Validate config and source plugins, print planned changes, but do not write files.

validate_config: Option<bool>

Validate lightconfig.toml, CLI overrides, and regexes without generating a plugin.

generate_completion: Option<Shell>

Generate shell completion script to stdout

generate_manpage: bool

Generate roff manpage to stdout

disable_flickering: Option<bool>

Whether to disable flickering lights during lightfixes generation

disable_pulse: Option<bool>

Whether to disable pulsing lights during lightfixes generation

disable_negative_lights: Option<bool>

Whether to null negative lights during lightfixes generation

standard_hue: Option<f32>

standard_saturation: Option<f32>

standard_value: Option<f32>

standard_radius: Option<f32>

colored_hue: Option<f32>

colored_saturation: Option<f32>

colored_value: Option<f32>

colored_radius: Option<f32>

duration_mult: Option<f32>

excluded_ids: Vec<String>

excluded_plugins: Vec<String>

light_overrides: Vec<(String, CustomLightData)>

ambient_overrides: Vec<(String, CustomCellAmbient)>

update_light_config: bool

Trait Implementations

impl Args for LightArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl CommandFactory for LightArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for LightArgs

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

Formats the value using the given formatter.

impl FromArgMatches for LightArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for LightArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.