Class ModInformation

Hierarchy

ModInformation

Implements

IModInformation

Constructors

constructor

new ModInformation(game: Game, config: IModConfig, extra: {
    folderName: string;
    path: string;
    type: ModType;
}): ModInformation
Parameters
- game: Game
- config: IModConfig
- extra: {
      folderName: string;
      path: string;
      type: ModType;
  }
  - folderName: string
  - path: string
  - type: ModType
Returns ModInformation
- Defined in src/game/mod/ModInformation.ts:74

Properties

`Readonly` config

config: Readonly<IModConfig>

`Optional` createdDate

createdDate?: number

`Readonly` folderName

folderName: string

`Optional` installDate

installDate?: number

`Optional` languages

languages?: IModLanguage[]

`Optional` lastUpdated

lastUpdated?: number

`Readonly` log

log: Log

`Readonly` path

path: string

`Readonly` provides

provides: IModProvides

`Optional` publishedFileId

publishedFileId?: string

state

state: ModState = ModState.Error

`Optional` steamIdOwner

steamIdOwner?: string

`Readonly` type

Accessors

author

get author(): string
Returns string
- Defined in src/game/mod/ModInformation.ts:127

canPublish

get canPublish(): boolean
Returns boolean
- Defined in src/game/mod/ModInformation.ts:256

canUnlockMilestones

get canUnlockMilestones(): boolean
Returns whether the given mod allows unlocking milestones

Returns boolean
- Defined in src/game/mod/ModInformation.ts:138

description

get description(): string
Returns string
- Defined in src/game/mod/ModInformation.ts:119

identifier

get identifier(): string
Returns string
- Defined in src/game/mod/ModInformation.ts:112

imageOverrides

get imageOverrides(): readonly IImageOverrides[]
Returns readonly IImageOverrides[]
- Defined in src/game/mod/ModInformation.ts:188

instance

get instance(): undefined | default
Returns undefined | default
- Defined in src/game/mod/ModInformation.ts:100

isEnabled

get isEnabled(): boolean
Returns boolean
- Defined in src/game/mod/ModInformation.ts:104

isInitialized

get isInitialized(): boolean
Returns boolean
- Defined in src/game/mod/ModInformation.ts:171

isLoaded

get isLoaded(): boolean
Returns boolean
- Defined in src/game/mod/ModInformation.ts:108

isMultiplayerClientSide

get isMultiplayerClientSide(): boolean
Returns boolean
- Defined in src/game/mod/ModInformation.ts:158

isMultiplayerCompatible

get isMultiplayerCompatible(): boolean
Returns boolean
- Defined in src/game/mod/ModInformation.ts:152

isMultiplayerServerSide

get isMultiplayerServerSide(): boolean
Returns boolean
- Defined in src/game/mod/ModInformation.ts:163

isUnloadable

get isUnloadable(): boolean
Returns boolean
- Defined in src/game/mod/ModInformation.ts:167

loadOrder

get loadOrder(): number
Returns number
- Defined in src/game/mod/ModInformation.ts:175

multiplayerCompatibility

get multiplayerCompatibility(): MultiplayerCompatibility
Returns MultiplayerCompatibility
- Defined in src/game/mod/ModInformation.ts:142

name

get name(): string
Returns string
Implementation of IModInformation.name
- Defined in src/game/mod/ModInformation.ts:115

requiredMods

get requiredMods(): string[]
Returns string[]
- Defined in src/game/mod/ModInformation.ts:131

scriptFileName

get scriptFileName(): undefined | string
Returns undefined | string
- Defined in src/game/mod/ModInformation.ts:179

tags

get tags(): ReadonlySet<string>
Returns ReadonlySet<string>
- Defined in src/game/mod/ModInformation.ts:192

version

get version(): string
Returns string
- Defined in src/game/mod/ModInformation.ts:123

Methods

canLoad

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

fillOutWorkshopMod

fillOutWorkshopMod(item?: IWorkshopItem): void
Parameters
- Optional item: IWorkshopItem
Returns void
- Defined in src/game/mod/ModInformation.ts:375

getFileText

getFileText(fileName: string): Promise<undefined | string>
Parameters
- fileName: string
Returns Promise<undefined | string>
- Defined in src/game/mod/ModInformation.ts:238

getIcon

getIcon(): Promise<undefined | string | false>
Returns Promise<undefined | string | false>
- Defined in src/game/mod/ModInformation.ts:228

getPath

getPath(fileName: undefined | string): Promise<undefined | IModPath>
Parameters
- fileName: undefined | string
Returns Promise<undefined | IModPath>
- Defined in src/game/mod/ModInformation.ts:823

getReadme

getReadme(): Promise<string | false>
Returns Promise<string | false>
- Defined in src/game/mod/ModInformation.ts:218

load

load(loadOrder: number): Promise<void>
Parameters
- loadOrder: number
Returns Promise<void>
- Defined in src/game/mod/ModInformation.ts:429

loadScript

loadScript(requireJs: undefined | IRequireJs, modPath: IModPath, scriptFileName: string, reloading: boolean): Promise<void>
Called when ModManager setups up the mod
Parameters
- requireJs: undefined | IRequireJs
- modPath: IModPath
- scriptFileName: string
  
  javascript file name without ".js"
- reloading: boolean
Returns Promise<void>
- Defined in src/game/mod/ModInformation.ts:831

reload

reload(): Promise<boolean>
Used by pro developers

Returns Promise<boolean>
- Defined in src/game/mod/ModInformation.ts:482

save

save(): void
Returns void
- Defined in src/game/mod/ModInformation.ts:368

setState

setState(state: ModState, force?: boolean, unloaded?: boolean): Promise<boolean>
Parameters
- state: ModState
- force: boolean = false
- unloaded: boolean = false
Returns Promise<boolean>
- Defined in src/game/mod/ModInformation.ts:391

toString

toString(): string
Returns string
- Defined in src/game/mod/ModInformation.ts:96

unload

unload(): Promise<void>
Returns Promise<void>
- Defined in src/game/mod/ModInformation.ts:456

Generated using TypeDoc