CommonLibSSE NG
Public Types | Public Member Functions | Protected Member Functions | List of all members
SKSE::SerializationInterface Class Reference

#include <Interfaces.h>

Public Types

enum  { kVersion = 4 }
 
using EventCallback = void(SerializationInterface *a_intfc)
 
using FormDeleteCallback = void(RE::VMHandle a_handle)
 

Public Member Functions

std::uint32_t Version () const
 
void SetUniqueID (std::uint32_t a_uid) const
 
void SetFormDeleteCallback (FormDeleteCallback *a_callback) const
 
void SetLoadCallback (EventCallback *a_callback) const
 
void SetRevertCallback (EventCallback *a_callback) const
 
void SetSaveCallback (EventCallback *a_callback) const
 
bool WriteRecord (std::uint32_t a_type, std::uint32_t a_version, const void *a_buf, std::uint32_t a_length) const
 
template<class T , std::enable_if_t< std::negation_v< std::is_pointer< T >>, int > = 0>
bool WriteRecord (std::uint32_t a_type, std::uint32_t a_version, const T &a_buf) const
 
template<class T , std::size_t N, std::enable_if_t< std::is_array_v< T >, int > = 0>
bool WriteRecord (std::uint32_t a_type, std::uint32_t a_version, const T(&a_buf)[N]) const
 
bool OpenRecord (std::uint32_t a_type, std::uint32_t a_version) const
 
bool WriteRecordData (const void *a_buf, std::uint32_t a_length) const
 
template<class T , std::enable_if_t< std::negation_v< std::is_pointer< T >>, int > = 0>
bool WriteRecordData (const T &a_buf) const
 
template<class T , std::size_t N, std::enable_if_t< std::is_array_v< T >, int > = 0>
bool WriteRecordData (const T(&a_buf)[N]) const
 
bool GetNextRecordInfo (std::uint32_t &a_type, std::uint32_t &a_version, std::uint32_t &a_length) const
 
std::uint32_t ReadRecordData (void *a_buf, std::uint32_t a_length) const
 
template<class T , std::enable_if_t< std::negation_v< std::is_pointer< T >>, int > = 0>
std::uint32_t ReadRecordData (T &a_buf) const
 
template<class T , std::size_t N, std::enable_if_t< std::is_array_v< T >, int > = 0>
std::uint32_t ReadRecordData (T(&a_buf)[N]) const
 
bool ResolveFormID (RE::FormID a_oldFormID, RE::FormID &a_newFormID) const
 
bool ResolveHandle (RE::VMHandle a_oldHandle, RE::VMHandle &a_newHandle) const
 

Protected Member Functions

const detail::SKSESerializationInterface * GetProxy () const
 

Member Typedef Documentation

◆ EventCallback

using SKSE::SerializationInterface::EventCallback = void(SerializationInterface* a_intfc)

◆ FormDeleteCallback

using SKSE::SerializationInterface::FormDeleteCallback = void(RE::VMHandle a_handle)

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kVersion 

Member Function Documentation

◆ GetNextRecordInfo()

bool SKSE::SerializationInterface::GetNextRecordInfo ( std::uint32_t &  a_type,
std::uint32_t &  a_version,
std::uint32_t &  a_length 
) const

◆ GetProxy()

const detail::SKSESerializationInterface* SKSE::SerializationInterface::GetProxy ( ) const
protected

◆ OpenRecord()

bool SKSE::SerializationInterface::OpenRecord ( std::uint32_t  a_type,
std::uint32_t  a_version 
) const

◆ ReadRecordData() [1/3]

template<class T , std::enable_if_t< std::negation_v< std::is_pointer< T >>, int > = 0>
std::uint32_t SKSE::SerializationInterface::ReadRecordData ( T &  a_buf) const
inline

◆ ReadRecordData() [2/3]

template<class T , std::size_t N, std::enable_if_t< std::is_array_v< T >, int > = 0>
std::uint32_t SKSE::SerializationInterface::ReadRecordData ( T(&)  a_buf[N]) const
inline

◆ ReadRecordData() [3/3]

std::uint32_t SKSE::SerializationInterface::ReadRecordData ( void *  a_buf,
std::uint32_t  a_length 
) const

◆ ResolveFormID()

bool SKSE::SerializationInterface::ResolveFormID ( RE::FormID  a_oldFormID,
RE::FormID &  a_newFormID 
) const

◆ ResolveHandle()

bool SKSE::SerializationInterface::ResolveHandle ( RE::VMHandle  a_oldHandle,
RE::VMHandle &  a_newHandle 
) const

◆ SetFormDeleteCallback()

void SKSE::SerializationInterface::SetFormDeleteCallback ( FormDeleteCallback *  a_callback) const

◆ SetLoadCallback()

void SKSE::SerializationInterface::SetLoadCallback ( EventCallback *  a_callback) const

◆ SetRevertCallback()

void SKSE::SerializationInterface::SetRevertCallback ( EventCallback *  a_callback) const

◆ SetSaveCallback()

void SKSE::SerializationInterface::SetSaveCallback ( EventCallback *  a_callback) const

◆ SetUniqueID()

void SKSE::SerializationInterface::SetUniqueID ( std::uint32_t  a_uid) const

◆ Version()

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

◆ WriteRecord() [1/3]

template<class T , std::enable_if_t< std::negation_v< std::is_pointer< T >>, int > = 0>
bool SKSE::SerializationInterface::WriteRecord ( std::uint32_t  a_type,
std::uint32_t  a_version,
const T &  a_buf 
) const
inline

◆ WriteRecord() [2/3]

template<class T , std::size_t N, std::enable_if_t< std::is_array_v< T >, int > = 0>
bool SKSE::SerializationInterface::WriteRecord ( std::uint32_t  a_type,
std::uint32_t  a_version,
const T(&)  a_buf[N] 
) const
inline

◆ WriteRecord() [3/3]

bool SKSE::SerializationInterface::WriteRecord ( std::uint32_t  a_type,
std::uint32_t  a_version,
const void *  a_buf,
std::uint32_t  a_length 
) const

◆ WriteRecordData() [1/3]

template<class T , std::enable_if_t< std::negation_v< std::is_pointer< T >>, int > = 0>
bool SKSE::SerializationInterface::WriteRecordData ( const T &  a_buf) const
inline

◆ WriteRecordData() [2/3]

template<class T , std::size_t N, std::enable_if_t< std::is_array_v< T >, int > = 0>
bool SKSE::SerializationInterface::WriteRecordData ( const T(&)  a_buf[N]) const
inline

◆ WriteRecordData() [3/3]

bool SKSE::SerializationInterface::WriteRecordData ( const void *  a_buf,
std::uint32_t  a_length 
) const
The documentation for this class was generated from the following file: