Skip to main content

ModsStub

Kindclass
Packagebackend
Full namebackend.ModsStub
Sourcesource/backend/ModsStub.hx

No-op stub for non-MODS_ALLOWED targets (#52). This class has its own type path (backend.ModsStub); import.hx aliases it as Mods when MODS_ALLOWED is off, so exactly one Mods implementation is ever bound and the two classes can no longer collide on the backend.Mods type path.

Public fields​

NameTypeStaticDefaultNotes
currentModDirectoryStringyes''—
ignoreModFoldersArray<String>yes[]—
invalidModsArray<String>yes[]—
updatedOnStateBoolyesfalse—

Public methods​

markInvalidMod​

static function markInvalidMod(folder:String = null):Void
ParameterTypeDefault
folder (optional)Stringnull

View source

getGlobalMods​

static inline function getGlobalMods():Array<String>

View source

pushGlobalMods​

static inline function pushGlobalMods():Array<String>

View source

getModDirectories​

static inline function getModDirectories():Array<String>

View source

mergeAllTextsNamed​

static inline function mergeAllTextsNamed(path:String, defaultDirectory:String = null, allowDuplicates:Bool = false):Array<String>
ParameterTypeDefault
pathString—
defaultDirectory (optional)Stringnull
allowDuplicates (optional)Boolfalse

View source

directoriesWithFile​

static inline function directoriesWithFile(path:String, fileToFind:String, mods:Bool = true):Array<String>
ParameterTypeDefault
pathString—
fileToFindString—
mods (optional)Booltrue

View source

getPack​

static inline function getPack(folder:String = null):Dynamic
ParameterTypeDefault
folder (optional)Stringnull

View source

parseList​

static inline function parseList():ModsList

View source

loadTopMod​

static inline function loadTopMod():Void

View source