Skip to main content

OptimizerOptions

Struct OptimizerOptions 

Source
pub struct OptimizerOptions { /* private fields */ }
Expand description

Configuration options for the pack optimizer.

Controls which optimization operations are enabled. Each option can be individually toggled to customize the optimization behavior.

§Default Behavior

By default, safe optimizations are enabled (duplicate removal, ITM removal) while potentially destructive ones are disabled (datacored table optimization, unused art set removal).

Implementations§

Source§

impl OptimizerOptions

Source

pub fn pack_remove_itm_files(&self) -> &bool

Allow the optimizer to remove files unchanged from vanilla, reducing the pack size.

Source

pub fn pack_apply_compression(&self) -> &bool

Allow the optimizer to apply the most modern compression format the active game supports, so the next save compresses the files.

Overrides whatever format the pack had configured. Intended as a final step before release on a pack that’s been edited uncompressed. No-op if the active game supports no compression formats.

Source

pub fn db_import_datacores_into_twad_key_deletes(&self) -> &bool

Allows the optimizer to update the twad_key_deletes table using the data cored tables in your pack to guess the keys.

IT DOESN’T DELETE THE DATACORED TABLES.

Source

pub fn db_optimize_datacored_tables(&self) -> &bool

Allow the optimizer to optimize datacored tables. THIS IS NOT RECOMMENDED, as datacored tables usually are they way they are for a reason.

THIS IS NOT RECOMMENDED, as datacored tables usually are the way they are for a reason.

Source

pub fn table_remove_duplicated_entries(&self) -> &bool

Allows the optimizer to remove duplicated rows from db and loc files.

Source

pub fn table_remove_itm_entries(&self) -> &bool

Allows the optimizer to remove ITM (Identical To Master) rows from db and loc files.

Source

pub fn table_remove_itnr_entries(&self) -> &bool

Allows the optimizer to remove ITNR (Identical To New Row) rows from db and loc files.

Source

pub fn table_remove_empty_file(&self) -> &bool

Allows the optimizer to remove empty db and loc files.

Source

pub fn text_remove_unused_xml_map_folders(&self) -> &bool

Allows the optimizer to remove unused xml files in map folders.

Source

pub fn text_remove_unused_xml_prefab_folder(&self) -> &bool

Allows the optimizer to remove unused xml files in the prefab folder.

Source

pub fn text_remove_agf_files(&self) -> &bool

Allows the optimizer to remove unused agf files.

Source

pub fn text_remove_model_statistics_files(&self) -> &bool

Allows the optimizer to remove unused model_statistics files.

Source

pub fn pts_remove_unused_art_sets(&self) -> &bool

Allow the optimizer to remove unused art sets in Portrait Settings files.

Only use this after you have confirmed the unused art sets are actually unused and not caused by a typo.

Source

pub fn pts_remove_unused_variants(&self) -> &bool

Allow the optimizer to remove unused variants from art sets in Portrait Settings files.

Only use this after you have confirmed the unused variants are actually unused and not caused by a typo.

Source

pub fn pts_remove_empty_masks(&self) -> &bool

Allow the optimizer to remove empty masks in Portrait Settings file, reducing their side.

Ingame there’s no difference between an empty mask and an invalid one, so it’s better to remove them to reduce their size.

Source

pub fn pts_remove_empty_file(&self) -> &bool

Allows the optimizer to remove empty Portrait Settings files.

Source§

impl OptimizerOptions

Source

pub fn set_pack_remove_itm_files(&mut self, val: bool) -> &mut Self

Allow the optimizer to remove files unchanged from vanilla, reducing the pack size.

Source

pub fn set_pack_apply_compression(&mut self, val: bool) -> &mut Self

Allow the optimizer to apply the most modern compression format the active game supports, so the next save compresses the files.

Overrides whatever format the pack had configured. Intended as a final step before release on a pack that’s been edited uncompressed. No-op if the active game supports no compression formats.

Source

pub fn set_db_import_datacores_into_twad_key_deletes( &mut self, val: bool, ) -> &mut Self

Allows the optimizer to update the twad_key_deletes table using the data cored tables in your pack to guess the keys.

IT DOESN’T DELETE THE DATACORED TABLES.

Source

pub fn set_db_optimize_datacored_tables(&mut self, val: bool) -> &mut Self

Allow the optimizer to optimize datacored tables. THIS IS NOT RECOMMENDED, as datacored tables usually are they way they are for a reason.

THIS IS NOT RECOMMENDED, as datacored tables usually are the way they are for a reason.

Source

pub fn set_table_remove_duplicated_entries(&mut self, val: bool) -> &mut Self

Allows the optimizer to remove duplicated rows from db and loc files.

Source

pub fn set_table_remove_itm_entries(&mut self, val: bool) -> &mut Self

Allows the optimizer to remove ITM (Identical To Master) rows from db and loc files.

Source

pub fn set_table_remove_itnr_entries(&mut self, val: bool) -> &mut Self

Allows the optimizer to remove ITNR (Identical To New Row) rows from db and loc files.

Source

pub fn set_table_remove_empty_file(&mut self, val: bool) -> &mut Self

Allows the optimizer to remove empty db and loc files.

Source

pub fn set_text_remove_unused_xml_map_folders(&mut self, val: bool) -> &mut Self

Allows the optimizer to remove unused xml files in map folders.

Source

pub fn set_text_remove_unused_xml_prefab_folder( &mut self, val: bool, ) -> &mut Self

Allows the optimizer to remove unused xml files in the prefab folder.

Source

pub fn set_text_remove_agf_files(&mut self, val: bool) -> &mut Self

Allows the optimizer to remove unused agf files.

Source

pub fn set_text_remove_model_statistics_files(&mut self, val: bool) -> &mut Self

Allows the optimizer to remove unused model_statistics files.

Source

pub fn set_pts_remove_unused_art_sets(&mut self, val: bool) -> &mut Self

Allow the optimizer to remove unused art sets in Portrait Settings files.

Only use this after you have confirmed the unused art sets are actually unused and not caused by a typo.

Source

pub fn set_pts_remove_unused_variants(&mut self, val: bool) -> &mut Self

Allow the optimizer to remove unused variants from art sets in Portrait Settings files.

Only use this after you have confirmed the unused variants are actually unused and not caused by a typo.

Source

pub fn set_pts_remove_empty_masks(&mut self, val: bool) -> &mut Self

Allow the optimizer to remove empty masks in Portrait Settings file, reducing their side.

Ingame there’s no difference between an empty mask and an invalid one, so it’s better to remove them to reduce their size.

Source

pub fn set_pts_remove_empty_file(&mut self, val: bool) -> &mut Self

Allows the optimizer to remove empty Portrait Settings files.

Trait Implementations§

Source§

impl Clone for OptimizerOptions

Source§

fn clone(&self) -> OptimizerOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OptimizerOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OptimizerOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for OptimizerOptions

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for OptimizerOptions

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,