Struct GameSettings

pub struct GameSettings { /* private fields */ }

Implementations

impl GameSettings

pub fn new(game_id: GameId, game_path: &Path) -> Result<GameSettings, Error>

pub fn with_local_path( game_id: GameId, game_path: &Path, local_path: &Path, ) -> Result<GameSettings, Error>

pub fn id(&self) -> GameId

pub fn load_order_method(&self) -> LoadOrderMethod

pub fn into_load_order( self, ) -> Box<dyn WritableLoadOrder + Send + Sync + 'static>

pub fn master_file(&self) -> &'static str

👎Deprecated: The master file is not necessarily of any significance: you should probably use early_loading_plugins() instead.

pub fn implicitly_active_plugins(&self) -> &[String]

pub fn is_implicitly_active(&self, plugin: &str) -> bool

pub fn early_loading_plugins(&self) -> &[String]

pub fn loads_early(&self, plugin: &str) -> bool

pub fn plugins_directory(&self) -> PathBuf

pub fn active_plugins_file(&self) -> &PathBuf

pub fn load_order_file(&self) -> Option<&PathBuf>

pub fn additional_plugins_directories(&self) -> &[PathBuf]

pub fn set_additional_plugins_directories(&mut self, paths: Vec<PathBuf>)

pub fn plugin_path(&self, plugin_name: &str) -> PathBuf

pub fn refresh_implicitly_active_plugins(&mut self) -> Result<(), Error>

Trait Implementations

impl Clone for GameSettings

fn clone(&self) -> GameSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameSettings

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

Formats the value using the given formatter.

impl Hash for GameSettings

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GameSettings

fn cmp(&self, other: &GameSettings) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GameSettings

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

fn partial_cmp(&self, other: &GameSettings) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for GameSettings

impl StructuralPartialEq for GameSettings