Class default

Hierarchy

Constructors

constructor

Properties

event initialized loadedMods

Accessors

build buildName buildTime isGameOverlayActive isLowPowerMode isRunningOnBatteryPower isRunningOnSteamDeck

Methods

activateSteamNetworkingDebugMessages clearServerToJoin clearSteamRichPresence closeWindow createArchive createLobby createSaveGameMod deleteSaveGameMod enableSafePaths enumerateRemoteFiles getAbsolutePath getAppPath getDedicatedServerInfo getFriends getGlobalStatInt getHeapStatistics getLobbyData getLobbyId getLobbyMembers getLobbyOwner getMatchmakingServer getMatchmakingServerPort getModPath getModPathSync getMultiplayerLogs getOsPlatform getPublishedItems getPublishedModFromPublishFileId getPublishedMods getScreenName getServerToJoin getStatInt getSteamId getSteamNetworking hasServerToJoin importFromSaveGameMod incrementStat initialize isAbsolutePath isContentTracingRecording isDedicatedServer isDevelopmentBranch isElectron isGreenworksEnabled isInLobby isNapiEnabled isOverlayWorking isRelayNetworkReady isTestMode isUsingAsar joinLobby leaveLobby multiplayerLog multiplayerLogError multiplayerLogWarn onAddHistoricalAction onGlobalSlotReady onInputFocus onUnload openBackupsFolder openGpuInfoWindow openInviteDialog openLogsFolder openModFolder openModsFolder openSaveFolder openUrl openWorkshop processDedicatedServerBackups publishMod reload saveFile setCustomTitleBar setDiscordPresence setFullscreen setLobbyData setLobbyType setOverlayWorks setServerToJoin setSteamNetworkingSendRates setSteamRichPresence setupMods setupMultiplayerLog shouldAutomaticallyJoinServer startPlaytimeTracking stopPlaytimeTracking subscribe toggleContentTracingRecording toggleDeveloperTools toggleOverlay unsubscribe updateDiscordPresence updateSteamRichPresence writeBackup

Constructors

constructor

  • Parameters

    Returns default

Properties

Readonly event

event: IEventEmitter<default, ISteamworksEvents>

Protected initialized

initialized: boolean = false

Readonly loadedMods

loadedMods: Record<string, IWorkshopItem> = {}

Accessors

build

  • get build(): undefined | IBuild

  • Returns undefined | IBuild

buildName

  • get buildName(): string

  • Returns string

buildTime

  • get buildTime(): number

  • Returns the build time of the game, not depending on any save that's currently loaded.

    If there is no IBuild data associated with this build, the build is considered as having happened "now". This will only be the case in dev builds, and means that after this build time is saved with a version, no further upgrades will be run. Build time is saved in the following places:

    • saveDataGlobal.gameLastPlayedBuildTime
    • saveData.gameBuildTime
    • Island.mapGenBuildTime
    • Island.saveBuildTime

    Returns number

isGameOverlayActive

  • get isGameOverlayActive(): boolean

  • Returns boolean

isLowPowerMode

  • get isLowPowerMode(): boolean

  • Returns boolean

isRunningOnBatteryPower

  • get isRunningOnBatteryPower(): boolean

  • Returns boolean

isRunningOnSteamDeck

  • get isRunningOnSteamDeck(): boolean

  • Returns boolean

Methods

activateSteamNetworkingDebugMessages

  • Insanely expensive to do and it's possible for it to cause crashes

    Returns void

clearServerToJoin

  • Returns void

clearSteamRichPresence

  • Returns void

closeWindow

  • Returns Promise<void>

createArchive

  • Parameters

    • id: string

    Returns Promise<void>

createLobby

  • Parameters

    • type: LobbyType

    Returns void

createSaveGameMod

  • Parameters

    • name: string
    • slot: number

    Returns Promise<boolean>

deleteSaveGameMod

  • Parameters

    • name: string

    Returns Promise<void>

enableSafePaths

  • Returns void

enumerateRemoteFiles

  • Returns IRemoteFile[]

getAbsolutePath

  • Parameters

    • Rest ...p: string[]

    Returns string

getAppPath

  • Parameters

    • Rest ...p: string[]

    Returns string

getDedicatedServerInfo

getFriends

  • Returns undefined | ISteamFriend[]

getGlobalStatInt

  • Parameters

    • name: string

    Returns undefined | number

getHeapStatistics

  • Returns Promise<undefined | HeapStatistics>

getLobbyData

  • Parameters

    • name: string

    Returns undefined | string

getLobbyId

  • Returns undefined | string

getLobbyMembers

  • Returns undefined | ISteamFriend[]

getLobbyOwner

  • Returns undefined | string

getMatchmakingServer

  • Returns undefined | IMatchmakingServer

getMatchmakingServerPort

  • Returns number

getModPath

  • Parameters

    • name: string
    • modType: ModType
    • Optional file: string
    • checkIfExists: boolean = false

    Returns Promise<undefined | IModPath>

getModPathSync

  • Parameters

    • name: string
    • modType: ModType
    • Optional file: string

    Returns undefined | IModPath

getMultiplayerLogs

  • Returns string

getOsPlatform

  • Returns undefined | Platform

getPublishedItems

  • Returns Promise<IWorkshopItem[]>

getPublishedModFromPublishFileId

  • Parameters

    • publishFileId: string

    Returns undefined | IWorkshopItem

getPublishedMods

  • Returns undefined | IWorkshopItem[]

getScreenName

  • Returns undefined | string

getServerToJoin

  • Returns undefined | ServerInfo

getStatInt

  • Parameters

    • name: string

    Returns undefined | number

getSteamId

  • Returns undefined | ISteamId

getSteamNetworking

  • Returns undefined | ISteamworksNetworking

hasServerToJoin

  • Returns boolean

importFromSaveGameMod

  • Do not remove callback. It's required for compatibility with pre 2.4 saves

    Parameters

    • mod: ModInformation
    • jsonOrUint8Array: string | Uint8Array
    • Optional callback: ((success: boolean) => void)
        • (success: boolean): void

        • Parameters

          • success: boolean

          Returns void

    Returns Promise<boolean>

incrementStat

  • Increases the specified stat. This will never throw errors todo: strongly typed stat areas & types? method to automatically fetch all stats for each area?

    Type Parameters

    Parameters

    Returns void

initialize

  • Returns Promise<undefined | IWaywardPreload>

isAbsolutePath

  • Parameters

    • path: string

    Returns boolean

isContentTracingRecording

  • Returns boolean

isDedicatedServer

  • Returns boolean

isDevelopmentBranch

  • Returns boolean

isElectron

  • Returns boolean

isGreenworksEnabled

  • Returns boolean

isInLobby

  • Returns boolean

isNapiEnabled

  • Returns boolean

isOverlayWorking

  • Returns boolean

isRelayNetworkReady

  • Returns boolean

isTestMode

  • Returns boolean

isUsingAsar

  • Returns boolean

joinLobby

  • Parameters

    • lobbyId: string

    Returns void

leaveLobby

  • Returns void

multiplayerLog

  • Parameters

    • Rest ...args: any[]

    Returns void

multiplayerLogError

  • Parameters

    • Rest ...args: any[]

    Returns void

multiplayerLogWarn

  • Parameters

    • Rest ...args: any[]

    Returns void

onAddHistoricalAction

Protected onGlobalSlotReady

  • Returns void

onInputFocus

  • Parameters

    • inputElement: HTMLElement

    Returns void

onUnload

  • Returns void

openBackupsFolder

  • Returns void

openGpuInfoWindow

  • Returns void

openInviteDialog

  • Returns void

openLogsFolder

  • Returns void

openModFolder

  • Parameters

    Returns Promise<void>

openModsFolder

  • Returns Promise<void>

openSaveFolder

  • Returns void

openUrl

  • Parameters

    • url: string

    Returns void

openWorkshop

  • Parameters

    • Optional publishFileId: string

    Returns Promise<void>

processDedicatedServerBackups

  • Parameters

    • Optional force: boolean

    Returns Promise<boolean>

publishMod

  • Parameters

    Returns Promise<string>

reload

  • Returns Promise<void>

saveFile

  • Parameters

    • fileName: string
    • blob: Blob

    Returns Promise<void>

setCustomTitleBar

  • Parameters

    • enabled: boolean

    Returns Promise<void>

setDiscordPresence

  • Parameters

    • presenceInfo: INapiDiscordPresenceInfo

    Returns Promise<void>

setFullscreen

  • Parameters

    • fullscreen: boolean

    Returns Promise<void>

setLobbyData

  • Parameters

    • name: string
    • data: string

    Returns boolean

setLobbyType

  • Parameters

    • type: LobbyType

    Returns boolean

setOverlayWorks

  • Parameters

    • overlayWorks: boolean

    Returns void

setServerToJoin

setSteamNetworkingSendRates

  • Parameters

    • min: number
    • max: number

    Returns void

setSteamRichPresence

  • Parameters

    • key: string
    • value: string

    Returns boolean

setupMods

  • Returns Promise<void>

setupMultiplayerLog

  • Returns void

shouldAutomaticallyJoinServer

startPlaytimeTracking

  • Returns void

stopPlaytimeTracking

  • Returns void

subscribe

  • Parameters

    • publishFileIds: string[]

    Returns Promise<void>

toggleContentTracingRecording

  • Returns Promise<boolean>

toggleDeveloperTools

  • Returns Promise<void>

toggleOverlay

  • Parameters

    • disabled: boolean

    Returns void

unsubscribe

  • Parameters

    • publishFileId: string

    Returns Promise<void>

updateDiscordPresence

  • Returns void

updateSteamRichPresence

  • Returns void

writeBackup

  • Parameters

    • slot: number
    • data: Uint8Array

    Returns Promise<undefined | string>

Settings

Member Visibility

Theme

Generated using TypeDoc