Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Steamworks

Hierarchy

Implements

Index

Properties

Readonly event

event: IEventEmitter<this, ISteamworksEvents> = new EventEmitter<this, E>(this)

Accessors

isGameOverlayActive

  • get isGameOverlayActive(): boolean
  • Returns boolean

Methods

clearSteamRichPresence

  • clearSteamRichPresence(): void
  • Returns void

closeWindow

  • closeWindow(): void
  • Returns void

createArchive

  • createArchive(id: string): Promise<void>
  • Parameters

    • id: string

    Returns Promise<void>

createLobby

  • Parameters

    Returns void

createSaveGameMod

  • createSaveGameMod(name: string, slot: number): Promise<boolean>
  • Parameters

    • name: string
    • slot: number

    Returns Promise<boolean>

deleteSaveGameMod

  • deleteSaveGameMod(name: string): void
  • Parameters

    • name: string

    Returns void

enableSafePaths

  • enableSafePaths(): void
  • Returns void

enumerateRemoteFiles

  • Returns IRemoteFile[]

fillOutWorkshopMod

  • Parameters

    Returns void

getAbsolutePath

  • getAbsolutePath(...p: string[]): string
  • Parameters

    • Rest ...p: string[]

    Returns string

getAppPath

  • getAppPath(...p: string[]): string
  • Parameters

    • Rest ...p: string[]

    Returns string

getBetaName

  • getBetaName(): string
  • Returns string

getBuildTime

  • getBuildTime(): number | undefined
  • Returns number | undefined

getDedicatedServerInfo

getFriends

  • Returns ISteamFriend[] | undefined

getGlobalStatInt

  • getGlobalStatInt(name: string): number | undefined
  • Parameters

    • name: string

    Returns number | undefined

getLobbyData

  • getLobbyData(name: string): string | undefined
  • Parameters

    • name: string

    Returns string | undefined

getLobbyId

  • getLobbyId(): string | undefined
  • Returns string | undefined

getLobbyMembers

  • Returns ISteamFriend[] | undefined

getLobbyOwner

  • getLobbyOwner(): string | undefined
  • Returns string | undefined

getMatchmakingServer

getModPath

  • getModPath(name: string, modType: ModType, file?: undefined | string, checkIfExists?: boolean): IModPath | undefined
  • Parameters

    • name: string
    • modType: ModType
    • Optional file: undefined | string
    • Default value checkIfExists: boolean = false

    Returns IModPath | undefined

getMultiplayerLogs

  • getMultiplayerLogs(): string
  • Returns string

getPublishedItems

getPublishedMod

  • getPublishedMod(publishFileId: string): IWorkshopItem | undefined
  • Parameters

    • publishFileId: string

    Returns IWorkshopItem | undefined

getPublishedMods

  • Returns IWorkshopItem[] | undefined

getScreenName

  • getScreenName(): string | undefined
  • Returns string | undefined

getStatInt

  • getStatInt(name: string): number | undefined
  • Parameters

    • name: string

    Returns number | undefined

getSteamId

  • Returns ISteamId | undefined

getSteamNetworking

hasServerToJoin

  • hasServerToJoin(): boolean
  • Returns boolean

importFromSaveGameMod

  • importFromSaveGameMod(modIndex: number, json: string, callback?: undefined | ((success: boolean) => void)): Promise<boolean>
  • Do not remove callback. It's required for compatibility with pre 2.4 saves

    Parameters

    • modIndex: number
    • json: string
    • Optional callback: undefined | ((success: boolean) => void)

    Returns Promise<boolean>

incrementStat

  • incrementStat(name: string): void
  • Parameters

    • name: string

    Returns void

initialize

  • Returns Promise<void>

isAbsolutePath

  • isAbsolutePath(path: string): boolean
  • Parameters

    • path: string

    Returns boolean

isContentTracingRecording

  • isContentTracingRecording(): boolean
  • Returns boolean

isDedicatedServer

  • isDedicatedServer(): boolean
  • Returns boolean

isElectron

  • isElectron(): boolean
  • Returns boolean

isGreenworksEnabled

  • isGreenworksEnabled(): boolean
  • Returns boolean

isInLobby

  • isInLobby(): boolean
  • Returns boolean

isNapiEnabled

  • isNapiEnabled(): boolean
  • Returns boolean

isOverlayWorking

  • isOverlayWorking(): boolean
  • Returns boolean

isRelayNetworkReady

  • isRelayNetworkReady(): boolean
  • Returns boolean

isTestMode

  • isTestMode(): boolean
  • Returns boolean

isUsingAsar

  • isUsingAsar(): boolean
  • Returns boolean

joinLobby

  • joinLobby(lobbyId: string): void
  • Parameters

    • lobbyId: string

    Returns void

leaveLobby

  • leaveLobby(): void
  • Returns void

multiplayerLog

  • multiplayerLog(...args: any[]): void
  • Parameters

    • Rest ...args: any[]

    Returns void

multiplayerLogError

  • multiplayerLogError(...args: any[]): void
  • Parameters

    • Rest ...args: any[]

    Returns void

multiplayerLogWarn

  • multiplayerLogWarn(...args: any[]): void
  • Parameters

    • Rest ...args: any[]

    Returns void

onMessage

  • onMessage(name: string, listener: (e: any, ...data: any[]) => any): boolean
  • Parameters

    • name: string
    • listener: (e: any, ...data: any[]) => any
        • (e: any, ...data: any[]): any
        • Parameters

          • e: any
          • Rest ...data: any[]

          Returns any

    Returns boolean

onReady

  • Returns Promise<void>

onUnload

  • onUnload(): void
  • Returns void

openGpuInfoWindow

  • openGpuInfoWindow(): void
  • Returns void

openInviteDialog

  • openInviteDialog(): void
  • Returns void

openLogsFolder

  • openLogsFolder(): void
  • Returns void

openModFolder

  • openModFolder(modIndex: number): void
  • Parameters

    • modIndex: number

    Returns void

openModsFolder

  • openModsFolder(): void
  • Returns void

openSaveFolder

  • openSaveFolder(): void
  • Returns void

openUrl

  • openUrl(url: string): void
  • Parameters

    • url: string

    Returns void

openWorkshop

  • openWorkshop(publishId?: undefined | string): Promise<void>
  • Parameters

    • Optional publishId: undefined | string

    Returns Promise<void>

processDedicatedServerBackups

  • processDedicatedServerBackups(force?: undefined | false | true): Promise<boolean>
  • Parameters

    • Optional force: undefined | false | true

    Returns Promise<boolean>

publishMod

  • publishMod(modIndex: number): Promise<any>
  • Parameters

    • modIndex: number

    Returns Promise<any>

reload

  • reload(): void
  • Returns void

sendMessage

  • sendMessage(name: string, ...data: any[]): boolean
  • Parameters

    • name: string
    • Rest ...data: any[]

    Returns boolean

setDiscordPresence

setLobbyData

  • setLobbyData(name: string, data: string): boolean
  • Parameters

    • name: string
    • data: string

    Returns boolean

setLobbyType

  • Parameters

    Returns boolean

setOverlayWorks

  • setOverlayWorks(overlayWorks: boolean): void
  • Parameters

    • overlayWorks: boolean

    Returns void

setServerToJoin

  • setServerToJoin(serverToJoin: ServerInfo, automatic?: undefined | false | true): void
  • Parameters

    • serverToJoin: ServerInfo
    • Optional automatic: undefined | false | true

    Returns void

setSteamRichPresence

  • setSteamRichPresence(key: string, value: string): boolean
  • Parameters

    • key: string
    • value: string

    Returns boolean

setupMods

  • Returns Promise<void>

setupMultiplayerLog

  • setupMultiplayerLog(): void
  • Returns void

startPlaytimeTracking

  • startPlaytimeTracking(): void
  • Returns void

stopPlaytimeTracking

  • stopPlaytimeTracking(): void
  • Returns void

toggleContentTracingRecording

  • toggleContentTracingRecording(): Promise<boolean>
  • Returns Promise<boolean>

toggleDeveloperTools

  • toggleDeveloperTools(): void
  • Returns void

unsubscribe

  • unsubscribe(publishId: string): Promise<void>
  • Parameters

    • publishId: string

    Returns Promise<void>

updateDiscordPresence

  • updateDiscordPresence(): void
  • Returns void

updateSteamRichPresence

  • updateSteamRichPresence(): void
  • Returns void

writeBackup

  • writeBackup(slot: number, data: Uint8Array): Promise<string | undefined>
  • Parameters

    • slot: number
    • data: Uint8Array

    Returns Promise<string | undefined>

Generated using TypeDoc