Struct RustModVTable 

pub struct RustModVTable {
    pub build: Option<Box<dyn FnOnce(&mut App) + Send + Sync>>,
    pub build_cleanup: Option<Box<dyn FnOnce(&mut App) + Send + Sync>>,
    pub load: Option<Box<dyn FnMut(ModState, &ModConfig, Commands<'_, '_>, &World) -> Result<(), String> + Send + Sync>>,
    pub config_keys: Option<HashSet<ConfigKey>>,
}

Fields

build: Option<Box<dyn FnOnce(&mut App) + Send + Sync>>

build_cleanup: Option<Box<dyn FnOnce(&mut App) + Send + Sync>>

load: Option<Box<dyn FnMut(ModState, &ModConfig, Commands<'_, '_>, &World) -> Result<(), String> + Send + Sync>>

config_keys: Option<HashSet<ConfigKey>>

Trait Implementations

impl Default for RustModVTable

fn default() -> RustModVTable

Returns the “default value” for a type.

impl ModLoaderInterface for RustModVTable

fn build(&mut self, app: &mut App)

Corresponds to App::finish

fn get_config_keys(&self) -> HashSet<ConfigKey>

Get the keys for the mod’s config. This is used to generate the config UI.

fn build_cleanup(&mut self, app: &mut App)

Corresponds to App::cleanup

fn load( &mut self, state: ModState, config: &ModConfig, commands: Commands<'_, '_>, world: &World, ) -> Result<(), String>

Loads the mod in a parallel fashion. Panics: if the mod requires exclusive access.

fn exclusive(&self) -> bool

Whether the mod shall be loaded exclusively.

fn unloadable(&self) -> bool

Is the mod able to be unloaded?

fn load_exclusive( &mut self, mod_state: ModState, config: &ModConfig, world: &mut World, ) -> Result<(), String>

Loads the mod with exclusive access.

fn unload( &mut self, mod_state: ModState, config: &ModConfig, commands: Commands<'_, '_>, world: &World, ) -> Result<(), String>

Unloads the mod in a parallel fashion. Panics: if the mod requires exclusive access.

fn unload_exclusive( &mut self, mod_state: ModState, config: &ModConfig, world: &mut World, ) -> Result<(), String>

Unloads the mod with exclusive access.

fn requires_build(&self) -> bool

If the mod requires to restart the game before loading.