Struct cobble_core::instance::InstanceBuilder

pub struct InstanceBuilder { /* private fields */ }

Builder for Instance.

Implementations

impl InstanceBuilder

pub fn uuid(&mut self, value: Uuid) -> &mut Self

Instance UUID.

Defaults to Uuid::new_v4().

pub fn name<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Name of the instance.

pub fn description<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Optional description of the instance.

pub fn version<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Minecraft version identifier for this instance.

pub fn instance_path<VALUE: Into<PathBuf>>(&mut self, value: VALUE) -> &mut Self

Path for the instance folder. This path contains the .minecraftfolder and some other metadata.

pub fn libraries_path<VALUE: Into<PathBuf>>(&mut self, value: VALUE) -> &mut Self

Path for the libraries.

pub fn assets_path<VALUE: Into<PathBuf>>(&mut self, value: VALUE) -> &mut Self

Path for the assets.

pub fn fullscreen(&mut self, value: bool) -> &mut Self

Enables fullscreen. Overwrites the custom window size.

Defaults to false.

pub fn enable_custom_window_size(&mut self, value: bool) -> &mut Self

Enables custom window size. Takes effect when not launching in fullscreen. The width and height can be configured with custom_width and custom_height.

Defaults to false.

pub fn custom_width(&mut self, value: u32) -> &mut Self

Custom game window width. Used when enable_custom_window_size is enabled.

Defaults to 1280.

pub fn custom_height(&mut self, value: u32) -> &mut Self

Custom game window height. Used when enable_custom_window_size is enabled.

Defaults to 720.

pub fn enable_custom_memory(&mut self, value: bool) -> &mut Self

Enables custom JVM memory restrictions. The minimum and maximum can be configured with custom_min_memory and custom_max_memory.

Defaults to false.

pub fn custom_min_memory(&mut self, value: u32) -> &mut Self

JVM initial heap size in megabytes. Adds the -Xms option to the command. Gets added before custom_jvm_args. Used when enable_custom_memory is enabled.

Defaults to 1024.

pub fn custom_max_memory(&mut self, value: u32) -> &mut Self

JVM max heap size in megabytes. Adds the -Xmx option to the command. Gets added before custom_jvm_args. Used when enable_custom_memory` is enabled.

Defaults to 2048.

pub fn custom_java_executable<VALUE: Into<String>>(
    &mut self,
    value: VALUE
) -> &mut Self

Custom java executable.

Defaults to None.

pub fn custom_jvm_arguments<VALUE: Into<String>>(
    &mut self,
    value: VALUE
) -> &mut Self

Custom JVM arguments

Defaults to None.

pub fn environment_variables(
    &mut self,
    value: Vec<(String, Option<String>)>
) -> &mut Self

Environment variables used for launching the game.

Defaults to vec![].

pub fn installed(&mut self, value: bool) -> &mut Self

Flag whether the instance was installed.

Defaults to false.

pub fn created(&mut self, value: OffsetDateTime) -> &mut Self

Created timestamp.

Defaults to OffsetDateTime::now_utc().

pub fn fabric_version(&mut self, value: Option<String>) -> &mut Self

Available on crate feature fabric only.

Fabric loader version that is used by this instance.

Defaults to None.

pub fn build(&self) -> Result<Instance, InstanceBuilderError>

Builds a new Instance.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for InstanceBuilder

fn clone(&self) -> InstanceBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for InstanceBuilder

fn default() -> Self

Returns the “default value” for a type.