ModsStub
| Kind | class |
| Package | backend |
| Full name | backend.ModsStub |
| Source | source/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
| Name | Type | Static | Default | Notes |
|---|---|---|---|---|
currentModDirectory | String | yes | '' | — |
ignoreModFolders | Array<String> | yes | [] | — |
invalidMods | Array<String> | yes | [] | — |
updatedOnState | Bool | yes | false | — |
Public methods
markInvalidMod
static function markInvalidMod(folder:String = null):Void
| Parameter | Type | Default |
|---|---|---|
folder (optional) | String | null |
getGlobalMods
static inline function getGlobalMods():Array<String>
pushGlobalMods
static inline function pushGlobalMods():Array<String>
getModDirectories
static inline function getModDirectories():Array<String>
mergeAllTextsNamed
static inline function mergeAllTextsNamed(path:String, defaultDirectory:String = null, allowDuplicates:Bool = false):Array<String>
| Parameter | Type | Default |
|---|---|---|
path | String | — |
defaultDirectory (optional) | String | null |
allowDuplicates (optional) | Bool | false |
directoriesWithFile
static inline function directoriesWithFile(path:String, fileToFind:String, mods:Bool = true):Array<String>
| Parameter | Type | Default |
|---|---|---|
path | String | — |
fileToFind | String | — |
mods (optional) | Bool | true |
getPack
static inline function getPack(folder:String = null):Dynamic
| Parameter | Type | Default |
|---|---|---|
folder (optional) | String | null |
parseList
static inline function parseList():ModsList
loadTopMod
static inline function loadTopMod():Void