Class default

Hierarchy

Host<IModManagerEvents>
- default

Index

Constructors

constructor

new default(game: Game): default
Parameters
- game: Game
Returns default
Overrides EventEmitter.Host<IModManagerEvents>.constructor
- Defined in src/game/mod/ModManager.ts:55

Properties

`Readonly` event

event: IEventEmitter<default, IModManagerEvents>

Accessors

enabledMods

get enabledMods(): readonly ModInformation[]
Returns readonly ModInformation[]
- Defined in src/game/mod/ModManager.ts:67

hasLoadedMods

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

loadedMods

get loadedMods(): readonly ModInformation[]
Returns readonly ModInformation[]
- Defined in src/game/mod/ModManager.ts:71

mods

get mods(): ReadonlySet<ModInformation>
Returns ReadonlySet<ModInformation>
- Defined in src/game/mod/ModManager.ts:59

modsArray

get modsArray(): readonly ModInformation[]
Returns readonly ModInformation[]
- Defined in src/game/mod/ModManager.ts:63

Methods

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:571

getEnabledModsThatDisallowMilestoneUnlocks

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

Returns ModInformation[]
- Defined in src/game/mod/ModManager.ts:563

getLoadabilityInfo

getLoadabilityInfo(publishFileIdOrServerModOrMod: string | ModInformation | IServerMod): ICanLoadInfo
Parameters
- publishFileIdOrServerModOrMod: string | ModInformation | IServerMod
Returns ICanLoadInfo
- Defined in src/game/mod/ModManager.ts:488

getModByPath

getModByPath(path: string): undefined | ModInformation
Parameters
- path: string
Returns undefined | ModInformation
- Defined in src/game/mod/ModManager.ts:548

getModsByIdentifier

getModsByIdentifier(identifier: string): ModInformation[]
Parameters
- identifier: string
Returns ModInformation[]
- Defined in src/game/mod/ModManager.ts:544

getModsByName

getModsByName(name: string): ModInformation[]
Parameters
- name: string
Returns ModInformation[]
- Defined in src/game/mod/ModManager.ts:552

getModsByPublishId

getModsByPublishId(publishedFileId: string): ModInformation[]
Parameters
- publishedFileId: string
Returns ModInformation[]
- Defined in src/game/mod/ModManager.ts:556

loadAll

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

`Protected` onGlobalSlotLoaded

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

reloadByName

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

removeMod

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

saveAll

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

setupMod

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

`Protected` setupMods

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

unloadAll

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

waitForSetup

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

Generated using TypeDoc