Struct APIStorage

pub struct APIStorage {

    pub plugin_name: Option<&'static str>,
    pub plugin_author: Option<&'static str>,
    pub plugin_version: Option<Version>,
    pub plugin_handle: PluginHandle,
    pub release_index: u32,
    pub scaleform_interface: ScaleformInterface,
    pub papyrus_interface: PapyrusInterface,
    pub serialization_interface: SerializationInterface,
    pub task_interface: TaskInterface,
    pub trampoline_interface: TrampolineInterface,
    pub messaging_interface: MessagingInterface,
    pub mod_callback_event_source: *mut BSTEventSource<ModCallbackEvent>,
    pub camera_event_source: *mut BSTEventSource<CameraEvent>,
    pub crosshair_ref_event_source: *mut BSTEventSource<CrosshairRefEvent>,
    pub action_event_source: *mut BSTEventSource<ActionEvent>,
    pub ni_node_update_event_source: *mut BSTEventSource<NiNodeUpdateEvent>,
    pub object_interface: ObjectInterface,
    pub delay_functor_manager: *mut SKSEDelayFunctorManager,
    pub object_registry: *mut SKSEObjectRegistry,
    pub persistent_object_storage: *mut SKSEPersistentObjectStorage,
}

Fields

plugin_name: Option<&'static str>

Your SKSE Plugin name

If the SKSEPlugin_Version symbol is not defined, Option::None is always included.

plugin_author: Option<&'static str>

Your SKSE Plugin author name

If the SKSEPlugin_Version symbol is not defined, Option::None is always included.

plugin_version: Option<Version>

Your SKSE Plugin version

If the SKSEPlugin_Version symbol is not defined, Option::None is always included.

plugin_handle: PluginHandle

The plugin handle (index of how many dlls SKSE has loaded) of this SKSE plugin dll.

release_index: u32

scaleform_interface: ScaleformInterface

papyrus_interface: PapyrusInterface

serialization_interface: SerializationInterface

task_interface: TaskInterface

trampoline_interface: TrampolineInterface

messaging_interface: MessagingInterface

mod_callback_event_source: *mut BSTEventSource<ModCallbackEvent>

camera_event_source: *mut BSTEventSource<CameraEvent>

crosshair_ref_event_source: *mut BSTEventSource<CrosshairRefEvent>

action_event_source: *mut BSTEventSource<ActionEvent>

ni_node_update_event_source: *mut BSTEventSource<NiNodeUpdateEvent>

object_interface: ObjectInterface

delay_functor_manager: *mut SKSEDelayFunctorManager

object_registry: *mut SKSEObjectRegistry

persistent_object_storage: *mut SKSEPersistentObjectStorage

Implementations

impl APIStorage

pub fn get() -> Result<&'static Self, ApiStorageError>

Returns a reference to the APIStorage instance.

Errors

Returns an error if the APIStorage is not initialized.

Example

use commonlibsse_ng::skse::api::APIStorage;
let storage = APIStorage::get();

pub fn map<F, R>(f: F) -> Result<R, ApiStorageError>

where F: FnOnce(&Self) -> R,

Maps over the APIStorage instance if it exists and returns a result of Option<R>.

Errors

Returns an error if the APIStorage is not initialized.

Example

use commonlibsse_ng::skse::api::APIStorage;
let result = APIStorage::map(|storage| storage.plugin_version.clone());

Trait Implementations

impl Debug for APIStorage

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

Formats the value using the given formatter.

impl Send for APIStorage

impl Sync for APIStorage