CommonLibSSE NG
SKSE::MessagingInterface Class Reference

#include <Interfaces.h>

Classes

struct  Message
 

Public Types

enum  { kVersion = 2 }
 
enum  : std::uint32_t {
  kPostLoad , kPostPostLoad , kPreLoadGame , kPostLoadGame ,
  kSaveGame , kDeleteGame , kInputLoaded , kNewGame ,
  kDataLoaded , kTotal
}
 
enum class  Dispatcher : std::uint32_t {
  kModEvent = 0 , kCameraEvent , kCrosshairEvent , kActionEvent ,
  kNiNodeUpdateEvent , kTotal
}
 
using EventCallback = void(Message *a_msg)
 

Public Member Functions

std::uint32_t Version () const
 
bool Dispatch (std::uint32_t a_messageType, void *a_data, std::uint32_t a_dataLen, const char *a_receiver) const
 
void * GetEventDispatcher (Dispatcher a_dispatcherID) const
 
bool RegisterListener (EventCallback *a_callback) const
 
bool RegisterListener (const char *a_sender, EventCallback *a_callback) const
 

Protected Member Functions

const detail::SKSEMessagingInterfaceGetProxy () const
 

Member Typedef Documentation

◆ EventCallback

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kVersion 

◆ anonymous enum

anonymous enum : std::uint32_t
Enumerator
kPostLoad 
kPostPostLoad 
kPreLoadGame 
kPostLoadGame 
kSaveGame 
kDeleteGame 
kInputLoaded 
kNewGame 
kDataLoaded 
kTotal 

◆ Dispatcher

enum SKSE::MessagingInterface::Dispatcher : std::uint32_t
strong
Enumerator
kModEvent 
kCameraEvent 
kCrosshairEvent 
kActionEvent 
kNiNodeUpdateEvent 
kTotal 

Member Function Documentation

◆ Dispatch()

bool SKSE::MessagingInterface::Dispatch ( std::uint32_t  a_messageType,
void *  a_data,
std::uint32_t  a_dataLen,
const char *  a_receiver 
) const

◆ GetEventDispatcher()

void* SKSE::MessagingInterface::GetEventDispatcher ( Dispatcher  a_dispatcherID) const

◆ GetProxy()

const detail::SKSEMessagingInterface* SKSE::MessagingInterface::GetProxy ( ) const
protected

◆ RegisterListener() [1/2]

bool SKSE::MessagingInterface::RegisterListener ( const char *  a_sender,
EventCallback a_callback 
) const

◆ RegisterListener() [2/2]

bool SKSE::MessagingInterface::RegisterListener ( EventCallback a_callback) const

◆ Version()

std::uint32_t SKSE::MessagingInterface::Version ( ) const

The documentation for this class was generated from the following file: