Class default

Hierarchy

Host<ISteamworksEvents>
- default

Index

Constructors

Properties

event initialized

Accessors

isGameOverlayActive isLowPowerMode isRunningOnBatteryPower isRunningOnSteamDeck

Methods

activateSteamNetworkingDebugMessages clearServerToJoin clearSteamRichPresence closeWindow createArchive createLobby createSaveGameMod deleteSaveGameMod enableSafePaths enumerateRemoteFiles fillOutWorkshopMod getAbsolutePath getAppPath getBuild getBuildName getDedicatedServerInfo getFriends getGlobalStatInt 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 onGlobalSlotLoaded 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

new default(game: Game): default
Parameters
- game: Game
Returns default
Overrides Host.constructor
- Defined in src/game/steamworks/Steamworks.ts:122

Properties

`Readonly` event

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

`Protected` initialized

initialized: boolean = false

Accessors

isGameOverlayActive

get isGameOverlayActive(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:126

isLowPowerMode

get isLowPowerMode(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:138

isRunningOnBatteryPower

get isRunningOnBatteryPower(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:134

isRunningOnSteamDeck

get isRunningOnSteamDeck(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:130

Methods

activateSteamNetworkingDebugMessages

activateSteamNetworkingDebugMessages(): void
Insanely expensive to do and it's possible for it to cause crashes

Returns void
- Defined in src/game/steamworks/Steamworks.ts:2272

clearServerToJoin

clearServerToJoin(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1415

clearSteamRichPresence

clearSteamRichPresence(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:674

closeWindow

closeWindow(): Promise<void>
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:173

createArchive

createArchive(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:986

createLobby

createLobby(type: LobbyType): void
Parameters
- type: LobbyType
Returns void
- Defined in src/game/steamworks/Steamworks.ts:815

createSaveGameMod

createSaveGameMod(name: string, slot: number): Promise<boolean>
Parameters
- name: string
- slot: number
Returns Promise<boolean>
- Defined in src/game/steamworks/Steamworks.ts:1232

deleteSaveGameMod

deleteSaveGameMod(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:1350

enableSafePaths

enableSafePaths(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:514

enumerateRemoteFiles

enumerateRemoteFiles(): IRemoteFile[]
Returns IRemoteFile[]
- Defined in src/game/steamworks/Steamworks.ts:1628

fillOutWorkshopMod

fillOutWorkshopMod(index: number, item?: IWorkshopItem): void
Parameters
- index: number
- Optional item: IWorkshopItem
Returns void
- Defined in src/game/steamworks/Steamworks.ts:884

getAbsolutePath

getAbsolutePath(...p: string[]): string
Parameters
- Rest ...p: string[]
Returns string
- Defined in src/game/steamworks/Steamworks.ts:221

getAppPath

getAppPath(...p: string[]): string
Parameters
- Rest ...p: string[]
Returns string
- Defined in src/game/steamworks/Steamworks.ts:237

getBuild

getBuild(): undefined | IBuild
Returns undefined | IBuild
- Defined in src/game/steamworks/Steamworks.ts:579

getBuildName

getBuildName(): string
Returns string
- Defined in src/game/steamworks/Steamworks.ts:583

getDedicatedServerInfo

getDedicatedServerInfo(): undefined | IDedicatedServerInfo
Returns undefined | IDedicatedServerInfo
- Defined in src/game/steamworks/Steamworks.ts:257

getFriends

getFriends(): undefined | ISteamFriend[]
Returns undefined | ISteamFriend[]
- Defined in src/game/steamworks/Steamworks.ts:567

getGlobalStatInt

getGlobalStatInt(name: string): undefined | number
Parameters
- name: string
Returns undefined | number
- Defined in src/game/steamworks/Steamworks.ts:605

getLobbyData

getLobbyData(name: string): undefined | string
Parameters
- name: string
Returns undefined | string
- Defined in src/game/steamworks/Steamworks.ts:842

getLobbyId

getLobbyId(): undefined | string
Returns undefined | string
- Defined in src/game/steamworks/Steamworks.ts:807

getLobbyMembers

getLobbyMembers(): undefined | ISteamFriend[]
Returns undefined | ISteamFriend[]
- Defined in src/game/steamworks/Steamworks.ts:867

getLobbyOwner

getLobbyOwner(): undefined | string
Returns undefined | string
- Defined in src/game/steamworks/Steamworks.ts:859

getMatchmakingServer

getMatchmakingServer(): undefined | IMatchmakingServer
Returns undefined | IMatchmakingServer
- Defined in src/game/steamworks/Steamworks.ts:261

getMatchmakingServerPort

getMatchmakingServerPort(): number
Returns number
- Defined in src/game/steamworks/Steamworks.ts:265

getModPath

getModPath(name: string, modType: ModType, file?: string, checkIfExists?: boolean): Promise<undefined | IModPath>
Parameters
- name: string
- modType: ModType
- Optional file: string
- checkIfExists: boolean = false
Returns Promise<undefined | IModPath>
- Defined in src/game/steamworks/Steamworks.ts:1152

getModPathSync

getModPathSync(name: string, modType: ModType, file?: string): undefined | IModPath
Parameters
- name: string
- modType: ModType
- Optional file: string
Returns undefined | IModPath
- Defined in src/game/steamworks/Steamworks.ts:1174

getMultiplayerLogs

getMultiplayerLogs(): string
Returns string
- Defined in src/game/steamworks/Steamworks.ts:1600

getOsPlatform

getOsPlatform(): undefined | Platform
Returns undefined | Platform
- Defined in src/game/steamworks/Steamworks.ts:146

getPublishedItems

getPublishedItems(): Promise<IWorkshopItem[]>
Returns Promise<IWorkshopItem[]>
- Defined in src/game/steamworks/Steamworks.ts:996

getPublishedModFromPublishFileId

getPublishedModFromPublishFileId(publishFileId: string): undefined | IWorkshopItem
Parameters
- publishFileId: string
Returns undefined | IWorkshopItem
- Defined in src/game/steamworks/Steamworks.ts:879

getPublishedMods

getPublishedMods(): undefined | IWorkshopItem[]
Returns undefined | IWorkshopItem[]
- Defined in src/game/steamworks/Steamworks.ts:588

getScreenName

getScreenName(): undefined | string
Returns undefined | string
- Defined in src/game/steamworks/Steamworks.ts:571

getServerToJoin

getServerToJoin(): undefined | ServerInfo
Returns undefined | ServerInfo
- Defined in src/game/steamworks/Steamworks.ts:1403

getStatInt

getStatInt(name: string): undefined | number
Parameters
- name: string
Returns undefined | number
- Defined in src/game/steamworks/Steamworks.ts:592

getSteamId

getSteamId(): undefined | ISteamId
Returns undefined | ISteamId
- Defined in src/game/steamworks/Steamworks.ts:563

getSteamNetworking

getSteamNetworking(): undefined | ISteamworksNetworking
Returns undefined | ISteamworksNetworking
- Defined in src/game/steamworks/Steamworks.ts:271

hasServerToJoin

hasServerToJoin(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:1399

importFromSaveGameMod

importFromSaveGameMod(modIndex: number, jsonOrUint8Array: string | Uint8Array, callback?: ((success: boolean) => void)): Promise<boolean>
Do not remove callback. It's required for compatibility with pre 2.4 saves
Parameters
- modIndex: number
- jsonOrUint8Array: string | Uint8Array
- Optional callback: ((success: boolean) => void)
  - - (success: boolean): void
    - Parameters
      
      success: boolean
      
      Returns void
Returns Promise<boolean>
- Defined in src/game/steamworks/Steamworks.ts:1308

incrementStat

incrementStat(name: string): void
Parameters
- name: string
Returns void
- Defined in src/game/steamworks/Steamworks.ts:596

initialize

initialize(): Promise<undefined | IWaywardPreload>
Returns Promise<undefined | IWaywardPreload>
- Defined in src/game/steamworks/Steamworks.ts:275

isAbsolutePath

isAbsolutePath(path: string): boolean
Parameters
- path: string
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:229

isContentTracingRecording

isContentTracingRecording(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:609

isDedicatedServer

isDedicatedServer(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:253

isDevelopmentBranch

isDevelopmentBranch(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:575

isElectron

isElectron(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:142

isGreenworksEnabled

isGreenworksEnabled(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:209

isInLobby

isInLobby(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:811

isNapiEnabled

isNapiEnabled(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:213

isOverlayWorking

isOverlayWorking(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:205

isRelayNetworkReady

isRelayNetworkReady(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:217

isTestMode

isTestMode(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:249

isUsingAsar

isUsingAsar(): boolean
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:245

joinLobby

joinLobby(lobbyId: string): void
Parameters
- lobbyId: string
Returns void
- Defined in src/game/steamworks/Steamworks.ts:837

leaveLobby

leaveLobby(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:828

multiplayerLog

multiplayerLog(...args: any[]): void
Parameters
- Rest ...args: any[]
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1604

multiplayerLogError

multiplayerLogError(...args: any[]): void
Parameters
- Rest ...args: any[]
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1620

multiplayerLogWarn

multiplayerLogWarn(...args: any[]): void
Parameters
- Rest ...args: any[]
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1612

`Protected` onGlobalSlotLoaded

onGlobalSlotLoaded(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1466

onInputFocus

onInputFocus(inputElement: HTMLElement): void
Parameters
- inputElement: HTMLElement
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1536

onUnload

onUnload(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:518

openBackupsFolder

openBackupsFolder(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1104

openGpuInfoWindow

openGpuInfoWindow(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:165

openInviteDialog

openInviteDialog(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1056

openLogsFolder

openLogsFolder(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1097

openModFolder

openModFolder(modIndex: number): Promise<void>
Parameters
- modIndex: number
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:1080

openModsFolder

openModsFolder(): Promise<void>
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:1070

openSaveFolder

openSaveFolder(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1063

openUrl

openUrl(url: string): void
Parameters
- url: string
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1013

openWorkshop

openWorkshop(publishFileId?: string): Promise<void>
Parameters
- Optional publishFileId: string
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:1030

processDedicatedServerBackups

processDedicatedServerBackups(force?: boolean): Promise<boolean>
Parameters
- Optional force: boolean
Returns Promise<boolean>
- Defined in src/game/steamworks/Steamworks.ts:1423

publishMod

publishMod(modIndex: number): Promise<string>
Parameters
- modIndex: number
Returns Promise<string>
- Defined in src/game/steamworks/Steamworks.ts:900

reload

reload(): Promise<void>
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:150

saveFile

saveFile(fileName: string, blob: Blob): Promise<void>
Parameters
- fileName: string
- blob: Blob
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:1361

setCustomTitleBar

setCustomTitleBar(enabled: boolean): Promise<void>
Parameters
- enabled: boolean
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:528

setDiscordPresence

setDiscordPresence(presenceInfo: INapiDiscordPresenceInfo): Promise<void>
Parameters
- presenceInfo: INapiDiscordPresenceInfo
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:762

setFullscreen

setFullscreen(fullscreen: boolean): Promise<void>
Parameters
- fullscreen: boolean
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:524

setLobbyData

setLobbyData(name: string, data: string): boolean
Parameters
- name: string
- data: string
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:850

setLobbyType

setLobbyType(type: LobbyType): boolean
Parameters
- type: LobbyType
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:820

setOverlayWorks

setOverlayWorks(overlayWorks: boolean): void
Parameters
- overlayWorks: boolean
Returns void
- Defined in src/game/steamworks/Steamworks.ts:532

setServerToJoin

setServerToJoin(serverToJoin: ServerInfo, automatic?: Partial<IJoinServerOptions>): void
Parameters
- serverToJoin: ServerInfo
- Optional automatic: Partial<IJoinServerOptions>
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1407

setSteamNetworkingSendRates

setSteamNetworkingSendRates(min: number, max: number): void
Parameters
- min: number
- max: number
Returns void
- Defined in src/game/steamworks/Steamworks.ts:2264

setSteamRichPresence

setSteamRichPresence(key: string, value: string): boolean
Parameters
- key: string
- value: string
Returns boolean
- Defined in src/game/steamworks/Steamworks.ts:670

setupMods

setupMods(): Promise<void>
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:546

setupMultiplayerLog

setupMultiplayerLog(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:1596

shouldAutomaticallyJoinServer

shouldAutomaticallyJoinServer(): undefined | Partial<IJoinServerOptions>
Returns undefined | Partial<IJoinServerOptions>
- Defined in src/game/steamworks/Steamworks.ts:1419

startPlaytimeTracking

startPlaytimeTracking(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:638

stopPlaytimeTracking

stopPlaytimeTracking(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:658

subscribe

subscribe(publishFileIds: string[]): Promise<void>
Parameters
- publishFileIds: string[]
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:1111

toggleContentTracingRecording

toggleContentTracingRecording(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/game/steamworks/Steamworks.ts:613

toggleDeveloperTools

toggleDeveloperTools(): Promise<void>
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:1148

toggleOverlay

toggleOverlay(disabled: boolean): void
Parameters
- disabled: boolean
Returns void
- Defined in src/game/steamworks/Steamworks.ts:537

unsubscribe

unsubscribe(publishFileId: string): Promise<void>
Parameters
- publishFileId: string
Returns Promise<void>
- Defined in src/game/steamworks/Steamworks.ts:1133

updateDiscordPresence

updateDiscordPresence(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:719

updateSteamRichPresence

updateSteamRichPresence(): void
Returns void
- Defined in src/game/steamworks/Steamworks.ts:678

writeBackup

writeBackup(slot: number, data: Uint8Array): Promise<undefined | string>
Parameters
- slot: number
- data: Uint8Array
Returns Promise<undefined | string>
- Defined in src/game/steamworks/Steamworks.ts:1474

Generated using TypeDoc