Struct MessagingInterface

pub struct MessagingInterface(/* private fields */);

APIs that enable data to be sent and received between plugins.

Implementations

impl MessagingInterface

pub const VERSION: u32 = 2u32

The version number of the messaging interface.

pub const fn version(&self) -> u32

Returns the version number of the messaging interface.

pub fn dispatch<T>( &self, message_type: MessageType, data: &mut T, data_len: u32, receiver: Option<&CStr>, ) -> Result<(), MessagingError>

Dispatches a message to SKSE listeners.

Errors

If the internal global API storage is uninitialized because forgot to call skse::init

pub unsafe fn dispatch_raw( &self, message_type: MessageType, data: *mut c_void, data_len: u32, receiver: Option<&CStr>, ) -> Result<(), MessagingError>

Dispatches a message to SKSE listeners.

Errors

If the internal global API storage is uninitialized because forgot to call skse::init

Safety

If the reference to the pointer pointing to data is valid.

pub fn get_event_dispatcher(&self, dispatcher_id: Dispatcher) -> *mut c_void

Gets the event dispatcher for a specific dispatcher id.

pub fn register_skse_listener( &self, f: fn(msg: &Message), ) -> Result<(), MessagingError>

Registers a listener for SKSE’s in-game events (e.g., loading saves).

Errors

If the internal global API storage is uninitialized because forgot to call skse::init

Event Data

• PreLoadGame: The name of the save data
• PostLoadGame: Invalid ptr(data length 1)

Example

if let Ok(messaging) = commonlibsse_ng::skse::api::get_messaging_interface() {
    messaging.register_skse_listener(|message| {
        #[cfg(feature = "tracing")]
        tracing::info!("SKSE event: {message:#?}");
    });
}

pub fn register_listener( &self, sender: &CStr, f: fn(msg: &Message), ) -> Result<(), MessagingError>

Registers a listener for a specific plugin’s in-game events.

Errors

If the internal global API storage is uninitialized because forgot to call skse::init

Trait Implementations

impl Clone for MessagingInterface

fn clone(&self) -> MessagingInterface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessagingInterface

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

Formats the value using the given formatter.