Trait me3_game_support_fromsoft::sprj::SprjGame

pub trait SprjGame: Send + Sync {
    fn name(&self) -> &'static str;
    fn param_repository(&self) -> &'static ParamRepository;
    fn enable_file_overrides(&self) -> bool;
}

Global game instance for a FROM SOFTWARE game. This interface is exclusively for code shared among the majority of titles supported by the “SPRJ” framework.

Game specific data/functions can be accessed by downcasting a SprjGame via get_game_api:

let game: &dyn SprjGame = &DarkSouls3;
if let Some(ds3) = get_game_api::<DarkSouls3>(game) {
    ds3.enable_network_logging();
}

Required Methods

fn name(&self) -> &'static str

Get a friendly description of this game.

fn param_repository(&self) -> &'static ParamRepository

Get a reference to the ParamRepository of this game.

fn enable_file_overrides(&self) -> bool

Enable local file overrides. Colloquially known as the “UXM” patch.

Implementors