CommonLibSSE (Parapets fork)
SKSE::IMergeMapperInterface001 Struct Referenceabstract

#include <MergeMapper.h>

Public Member Functions

virtual unsigned int GetBuildNumber ()=0
 
virtual std::pair< const char *, RE::FormIDGetNewFormID (const char *oldName, const RE::FormID oldFormID)=0
 Get the new modName and formID. More...
 
virtual std::pair< const char *, RE::FormIDGetOriginalFormID (const char *newName, const RE::FormID newFormID)=0
 Get the original modName and formID. More...
 
virtual bool isMerge (const char *modName)=0
 Whether modName is a zmerge output file. To find old file use GetOldFormID(modName, 0) More...
 
virtual bool wasMerged (const char *modName)=0
 Whether modName was an input to a zmerge file. To find new file use GetNewFormID(modName, 0) More...
 

Member Function Documentation

◆ GetBuildNumber()

virtual unsigned int SKSE::IMergeMapperInterface001::GetBuildNumber ( )
pure virtual

◆ GetNewFormID()

virtual std::pair<const char*, RE::FormID> SKSE::IMergeMapperInterface001::GetNewFormID ( const char *  oldName,
const RE::FormID  oldFormID 
)
pure virtual

Get the new modName and formID.

Parameters
oldNameThe original modName char* e.g., Dragonborn.esp
oldFormIDThe original formID in hex format as an uint_32 e.g., 0x134ab
Returns
a pair with char* modName and uint32 FormID. If no merge is found, it will return oldName and oldFormID.

◆ GetOriginalFormID()

virtual std::pair<const char*, RE::FormID> SKSE::IMergeMapperInterface001::GetOriginalFormID ( const char *  newName,
const RE::FormID  newFormID 
)
pure virtual

Get the original modName and formID.

Parameters
newNameThe new merged modName char* e.g., Merge.esp
newFormIDThe new merged formID in hex format as an uint_32 e.g., 0x134ab
Returns
a pair with char* modName and uint32 FormID. If no merge is found, it will return newName and newFormID.

◆ isMerge()

virtual bool SKSE::IMergeMapperInterface001::isMerge ( const char *  modName)
pure virtual

Whether modName is a zmerge output file. To find old file use GetOldFormID(modName, 0)

Parameters
modNameThe modName to check, char* e.g., merged1.esp
Returns
true if merged

◆ wasMerged()

virtual bool SKSE::IMergeMapperInterface001::wasMerged ( const char *  modName)
pure virtual

Whether modName was an input to a zmerge file. To find new file use GetNewFormID(modName, 0)

Parameters
modNameThe modName to check, char* e.g., input1.esp
Returns
true if was merged into some file

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