Class default

Hierarchy

Host<IModManagerEvents>
- default

Index

Constructors

Properties

Accessors

Methods

canLoad canPublish canUnlockMilestones getAuthor getConfig getCreatedDate getDescription getEnabledMods getEnabledModsThatDisallowMilestoneUnlocks getFile getFolderName getIcon getIdentifier getIndexFromName getIndexFromPath getIndexFromPublishId getIndicesFromIdentifier getInstallDate getLastUpdatedDate getLoadabilityInfo getLoadedModByName getLoadedMods getLog getModFromIndex getMods getMultiplayerCompatibility getName getPath getProvided getPublishFileId getReadme getRequiredMods getState getSteamIdOwner getTags getType getVersion isEnabled isEnabledByName isInitializing isLoaded isLoadedByName isMultiplayerClientSide isMultiplayerCompatible isMultiplayerServerSide isUnloadable isValid load loadAll onGlobalSlotLoaded reload reloadByName removeMod save saveAll setCreatedDate setInstallDate setLastUpdated setPublishId setState setSteamIdOwner setupMod setupMods uninitialize uninitializeAll unload unloadAll waitForSetup

Constructors

constructor

new default(game: Game): default
Parameters
- game: Game
Returns default
Overrides Host.constructor
- Defined in src/game/mod/ModManager.ts:77

Properties

`Readonly` event

event: IEventEmitter<default, IModManagerEvents> = ...

Accessors

areModsLoaded

get areModsLoaded(): boolean
Returns boolean
- Defined in src/game/mod/ModManager.ts:81

Methods

canLoad

canLoad(index: number, fromModsMenu?: boolean, count?: number): CanLoadState
Parameters
- index: number
- fromModsMenu: boolean = false
- count: number = 0
Returns CanLoadState
- Defined in src/game/mod/ModManager.ts:1082

canPublish

canPublish(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:1064

canUnlockMilestones

canUnlockMilestones(): boolean
Returns whether every mod that's enabled either allows unlocking milestones or doesn't provide scripts.

Returns boolean
- Defined in src/game/mod/ModManager.ts:1460
canUnlockMilestones(mod: number | IModInfo): boolean
Returns whether the given mod allows unlocking milestones
Parameters
- mod: number | IModInfo
Returns boolean
- Defined in src/game/mod/ModManager.ts:1464

getAuthor

getAuthor(index: number): string
Parameters
- index: number
Returns string
- Defined in src/game/mod/ModManager.ts:1031

getConfig

getConfig(mod: number | IModInfo): undefined | IModConfig
Parameters
- mod: number | IModInfo
Returns undefined | IModConfig
- Defined in src/game/mod/ModManager.ts:938

getCreatedDate

getCreatedDate(index: number): undefined | number
Parameters
- index: number
Returns undefined | number
- Defined in src/game/mod/ModManager.ts:1023

getDescription

getDescription(index: number): string
Parameters
- index: number
Returns string
- Defined in src/game/mod/ModManager.ts:950

getEnabledMods

getEnabledMods(): number[]
Returns number[]
- Defined in src/game/mod/ModManager.ts:791

getEnabledModsThatDisallowMilestoneUnlocks

getEnabledModsThatDisallowMilestoneUnlocks(): IModInfo[]
Returns a list of every enabled mod that doesn't allow unlocking milestones and provides scripts.

Returns IModInfo[]
- Defined in src/game/mod/ModManager.ts:1488

getFile

getFile(modIndex: number, file: string): Promise<undefined | string>
Parameters
- modIndex: number
- file: string
Returns Promise<undefined | string>
- Defined in src/game/mod/ModManager.ts:388

getFolderName

getFolderName(index: number): string
Parameters
- index: number
Returns string
- Defined in src/game/mod/ModManager.ts:1048

getIcon

getIcon(index: number): Promise<undefined | string | false>
Parameters
- index: number
Returns Promise<undefined | string | false>
- Defined in src/game/mod/ModManager.ts:965

getIdentifier

getIdentifier(index: number): string
Parameters
- index: number
Returns string
- Defined in src/game/mod/ModManager.ts:934

getIndexFromName

getIndexFromName(name: string): number[]
Parameters
- name: string
Returns number[]
- Defined in src/game/mod/ModManager.ts:1231

getIndexFromPath

getIndexFromPath(path: string): undefined | number
Parameters
- path: string
Returns undefined | number
- Defined in src/game/mod/ModManager.ts:1255

getIndexFromPublishId

getIndexFromPublishId(publishFileId: string): number[]
Parameters
- publishFileId: string
Returns number[]
- Defined in src/game/mod/ModManager.ts:1243

getIndicesFromIdentifier

getIndicesFromIdentifier(identifier: string): number[]
Parameters
- identifier: string
Returns number[]
- Defined in src/game/mod/ModManager.ts:1227

getInstallDate

getInstallDate(index: number): undefined | number
Parameters
- index: number
Returns undefined | number
- Defined in src/game/mod/ModManager.ts:1015

getLastUpdatedDate

getLastUpdatedDate(index: number): undefined | number
Parameters
- index: number
Returns undefined | number
- Defined in src/game/mod/ModManager.ts:1007

getLoadabilityInfo

getLoadabilityInfo(publishFileIdOrModOrIndex: string | number | IServerMod): ICanLoadInfo
Parameters
- publishFileIdOrModOrIndex: string | number | IServerMod
Returns ICanLoadInfo
- Defined in src/game/mod/ModManager.ts:1178

getLoadedModByName

getLoadedModByName(name: string): undefined | IModInfo
Parameters
- name: string
Returns undefined | IModInfo
- Defined in src/game/mod/ModManager.ts:777

getLoadedMods

getLoadedMods(): IModInfo[]
Returns IModInfo[]
- Defined in src/game/mod/ModManager.ts:766

getLog

getLog(index: number): default
Parameters
- index: number
Returns default
- Defined in src/game/mod/ModManager.ts:946

getModFromIndex

getModFromIndex(i: number): IModInfo
Parameters
- i: number
Returns IModInfo
- Defined in src/game/mod/ModManager.ts:787

getMods

getMods(): IModInfo[]
Returns IModInfo[]
- Defined in src/game/mod/ModManager.ts:762

getMultiplayerCompatibility

getMultiplayerCompatibility(index: number): MultiplayerCompatibility
Parameters
- index: number
Returns MultiplayerCompatibility
- Defined in src/game/mod/ModManager.ts:264

getName

getName(index: number): string
Parameters
- index: number
Returns string
- Defined in src/game/mod/ModManager.ts:942

getPath

getPath(index: number): string
Parameters
- index: number
Returns string
- Defined in src/game/mod/ModManager.ts:1044

getProvided

getProvided(index: number): IModProvides
Parameters
- index: number
Returns IModProvides
- Defined in src/game/mod/ModManager.ts:1060

getPublishFileId

getPublishFileId(index: number): undefined | string
Parameters
- index: number
Returns undefined | string
- Defined in src/game/mod/ModManager.ts:1052

getReadme

getReadme(index: number): Promise<string | false>
Parameters
- index: number
Returns Promise<string | false>
- Defined in src/game/mod/ModManager.ts:954

getRequiredMods

getRequiredMods(index: number): string[]
Parameters
- index: number
Returns string[]
- Defined in src/game/mod/ModManager.ts:1039

getState

getState(index: number): ModState
Parameters
- index: number
Returns ModState
- Defined in src/game/mod/ModManager.ts:1311

getSteamIdOwner

getSteamIdOwner(index: number): undefined | string
Parameters
- index: number
Returns undefined | string
- Defined in src/game/mod/ModManager.ts:1056

getTags

getTags(index: number): Set<string>
Parameters
- index: number
Returns Set<string>
- Defined in src/game/mod/ModManager.ts:976

getType

getType(index: number): ModType
Parameters
- index: number
Returns ModType
- Defined in src/game/mod/ModManager.ts:1035

getVersion

getVersion(index: number): string
Parameters
- index: number
Returns string
- Defined in src/game/mod/ModManager.ts:1003

isEnabled

isEnabled(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:926

isEnabledByName

isEnabledByName(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/game/mod/ModManager.ts:1265

isInitializing

isInitializing(index: number): ModState
Parameters
- index: number
Returns ModState
- Defined in src/game/mod/ModManager.ts:1315

isLoaded

isLoaded(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:930

isLoadedByName

isLoadedByName(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/game/mod/ModManager.ts:1278

isMultiplayerClientSide

isMultiplayerClientSide(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:282

isMultiplayerCompatible

isMultiplayerCompatible(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:275

isMultiplayerServerSide

isMultiplayerServerSide(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:288

isUnloadable

isUnloadable(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:293

isValid

isValid(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:922

load

load(index: number, loadOrder: number): Promise<void>
Parameters
- index: number
- loadOrder: number
Returns Promise<void>
- Defined in src/game/mod/ModManager.ts:802

loadAll

loadAll(options: Partial<IPlayOptions>): Promise<[ModLoadFailureReason, ...any[]][]>
Parameters
- options: Partial<IPlayOptions>
Returns Promise<[ModLoadFailureReason, ...any[]][]>
- Defined in src/game/mod/ModManager.ts:101

`Protected` onGlobalSlotLoaded

onGlobalSlotLoaded(): void
Returns void
- Defined in src/game/mod/ModManager.ts:1493

reload

reload(index: number, cacheHooks?: boolean): Promise<boolean>
Used by pro developers
Parameters
- index: number
- cacheHooks: boolean = true
Returns Promise<boolean>
- Defined in src/game/mod/ModManager.ts:877

reloadByName

reloadByName(name: string): Promise<boolean>
Used by pro developers
Parameters
- name: string
Returns Promise<boolean>
- Defined in src/game/mod/ModManager.ts:861

removeMod

removeMod(id: number, uninstall?: boolean): void
Parameters
- id: number
- uninstall: boolean = false
Returns void
- Defined in src/game/mod/ModManager.ts:751

save

save(index: number): void
Parameters
- index: number
Returns void
- Defined in src/game/mod/ModManager.ts:850

saveAll

saveAll(): void
Returns void
- Defined in src/game/mod/ModManager.ts:374

setCreatedDate

setCreatedDate(index: number, createdDate: number): void
Parameters
- index: number
- createdDate: number
Returns void
- Defined in src/game/mod/ModManager.ts:1307

setInstallDate

setInstallDate(index: number, installDate: number): void
Parameters
- index: number
- installDate: number
Returns void
- Defined in src/game/mod/ModManager.ts:1303

setLastUpdated

setLastUpdated(index: number, lastUpdated: number): void
Parameters
- index: number
- lastUpdated: number
Returns void
- Defined in src/game/mod/ModManager.ts:1299

setPublishId

setPublishId(index: number, publishedFileId: string): void
Parameters
- index: number
- publishedFileId: string
Returns void
- Defined in src/game/mod/ModManager.ts:1291

setState

setState(index: number, state: ModState, force?: boolean, cacheHooks?: boolean, callback?: NullaryFunction<any>, unloaded?: boolean): Promise<boolean>
Parameters
- index: number
- state: ModState
- force: boolean = false
- cacheHooks: boolean = false
- Optional callback: NullaryFunction<any>
- unloaded: boolean = false
Returns Promise<boolean>
- Defined in src/game/mod/ModManager.ts:1319

setSteamIdOwner

setSteamIdOwner(index: number, steamIdOwner: string): void
Parameters
- index: number
- steamIdOwner: string
Returns void
- Defined in src/game/mod/ModManager.ts:1295

setupMod

setupMod(folderName: string, modType: ModType, initialModState?: ModState): Promise<undefined | number>
Parameters
- folderName: string
- modType: ModType
- initialModState: ModState = ModState.Enabled
Returns Promise<undefined | number>
- Defined in src/game/mod/ModManager.ts:408

setupMods

setupMods(): Promise<void>
Returns Promise<void>
- Defined in src/game/mod/ModManager.ts:335

uninitialize

uninitialize(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/game/mod/ModManager.ts:1395

uninitializeAll

uninitializeAll(): void
Returns void
- Defined in src/game/mod/ModManager.ts:1449

unload

unload(index: number, cacheHooks?: boolean): Promise<void>
Parameters
- index: number
- cacheHooks: boolean = false
Returns Promise<void>
- Defined in src/game/mod/ModManager.ts:829

unloadAll

unloadAll(resetState?: boolean): Promise<void>
Parameters
- resetState: boolean = false
Returns Promise<void>
- Defined in src/game/mod/ModManager.ts:298

waitForSetup

waitForSetup(showLoad: boolean): Promise<void>
Parameters
- showLoad: boolean
Returns Promise<void>
- Defined in src/game/mod/ModManager.ts:85

Generated using TypeDoc