Struct Host 

pub struct Host { /* private fields */ }

The loader’s services for this mod, valid for the life of the process.

Each mod DLL links its own copy of this crate, so host always answers for the mod that calls it.

Examples

if let Some(host) = enshwick::host() {
    host.log(enshwick::abi::Level::INFO, "ready");
}

Implementations

impl Host

pub fn game_resource(&self, key: ResourceKey) -> Option<Vec<u8>>

A vanilla resource’s bytes from the game’s archive; see game_resource.

Examples

use enshwick::content::{Guid, types};

if let Some(host) = enshwick::host() {
    let chest = Guid::parse("6943053a-32c1-4718-ae22-e61427ddf54d");
    if let Ok(key) = chest.key(types::ITEM_INFO) {
        let _ = host.game_resource(key);
    }
}

impl Host

pub fn api(&self) -> &'static HostApi

The raw table, for calls the safe layer does not wrap.

Examples

if let Some(host) = enshwick::host() {
    assert_eq!(host.api().header.abi_major, enshwick::abi::ABI_MAJOR);
}

pub fn handle(&self) -> ModHandle

This mod’s handle.

Examples

if let Some(host) = enshwick::host() {
    assert_ne!(host.handle(), enshwick::abi::ModHandle::NONE);
}

pub fn build(&self) -> BuildInfo

The running game: side, image base and build fingerprint.

Examples

if let Some(host) = enshwick::host() {
    let build = host.build();
    assert_ne!(build.base, 0);
}

pub fn hosting(&self) -> bool

Whether this process runs a game server now: always on the dedicated server; on the client while it hosts a game, solo play included, from the built-in server’s first step until the game stops.

Examples

if let Some(host) = enshwick::host() {
    let acts = host.hosting();
}

pub fn log(&self, level: Level, message: &str)

Writes message to the log under this mod’s id.

Not for hot paths: a hook logs once per event worth knowing.

Examples

See Host.

pub fn log_level(&self) -> Level

The most detailed level the loader keeps for this mod’s lines, from mod-configs/enshwick.toml.

Examples

use enshwick::abi::Level;

if let Some(host) = enshwick::host() {
    let verbose = host.log_level() >= Level::DEBUG;
}

pub fn fault(&self, reason: &str)

Reports that this mod failed at run time. The loader unlinks every hook of the mod, so the game runs vanilla where the mod was.

Examples

if let Some(host) = enshwick::host() {
    host.fault("the altar table is corrupt");
}

pub fn caller_frame(&self) -> CallerFrame

The game caller’s context at entry of the running hook chain, for hooks declared with HookFlags::CALLER_FRAME.

Valid until the hook calls anything hooked.

Examples

if let Some(host) = enshwick::host() {
    let frame = host.caller_frame();
    let _ = frame.stack();
}

impl Host

pub fn language(&self) -> Language

The language the player reads the game in; see language.

Examples

if let Some(host) = enshwick::host() {
    enshwick::info!("texts in {}", host.language().code());
}

impl Host

pub fn game_text(&self, id: u32, language: Language) -> Option<&'static str>

The game’s own text of tag id in language; see game_text_in.

Examples

use enshwick::i18n::Language;

if let Some(host) = enshwick::host() {
    let _ = host.game_text(0x8f21_95d5, Language::DE_DE);
}

Trait Implementations

impl Clone for Host

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Host

impl Debug for Host

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

Formats the value using the given formatter.

impl EngineFacts for Host

fn offset(&self, id: &str) -> Result<usize, Off>

The byte offset the id names.

fn size(&self, id: &str) -> Result<usize, Off>

The size of the type the id names.

fn hash(&self, id: &str) -> Result<u32, Off>

The hash of the type the id names.