Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Steamworks

Hierarchy

Implements

Index

Methods

cancel

  • cancel(events: string | number | Array<string | number>, cb?: function): void
  • Parameters

    • events: string | number | Array<string | number>
    • Optional cb: function
        • (emitter: this, ...data: any[]): any
        • Parameters

          • emitter: this
          • Rest ...data: any[]

          Returns any

    Returns void

cancelAll

  • cancelAll(): void

clearRichPresence

  • clearRichPresence(): void

createArchive

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

    • id: string
    • source: string

    Returns Promise<void>

createLobby

createSaveGameMod

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

    • name: string
    • slot: number

    Returns Promise<boolean>

debugLog

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

    • Rest ...args: any[]

    Returns void

deleteSaveGameMod

  • deleteSaveGameMod(name: string): void

fillOutWorkshopMod

getAbsolutePath

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

    • Rest ...p: string[]

    Returns any

getBetaName

  • getBetaName(): string

getBuildTime

  • getBuildTime(): number | undefined

getDedicatedServerInfo

getFriends

getLobbyData

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

    • name: string

    Returns string | undefined

getLobbyMembers

getMatchmakingServer

  • getMatchmakingServer(): IMatchmakingServer | undefined

getModPath

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

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

    Returns IModPath | undefined

getMultiplayerLogs

  • getMultiplayerLogs(): string

getPublishedItems

  • Returns Promise<IWorkshopItem[]>

getPublishedMod

  • getPublishedMod(publishFileId: string): IWorkshopItem | undefined

getPublishedMods

getScreenName

  • getScreenName(): string | undefined

getSteamId

hasServerToJoin

  • hasServerToJoin(): boolean

importFromSaveGameMod

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

    Parameters

    • modIndex: number
    • json: string
    • Optional callback: function
        • (success: boolean): void
        • Parameters

          • success: boolean

          Returns void

    Returns Promise<boolean>

initialize

  • initialize(): void

isDedicatedServer

  • isDedicatedServer(): boolean

isElectron

  • isElectron(): boolean

isGreenworksEnabled

  • isGreenworksEnabled(): boolean

isInLobby

  • isInLobby(): boolean

isLinux

  • isLinux(): boolean
  • Returns boolean

isMac

  • isMac(): boolean
  • Returns boolean

isOverlayWorking

  • isOverlayWorking(): boolean

joinLobby

  • joinLobby(lobbyId: string): void
  • Parameters

    • lobbyId: string

    Returns void

leaveLobby

  • leaveLobby(): void

multiplayerLog

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

    • Rest ...args: any[]

    Returns void

multiplayerLogError

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

on

  • on(events: string | number | Array<string | number>, cb: function): this
  • Parameters

    • events: string | number | Array<string | number>
    • cb: function
        • (emitter: this, ...data: any[]): any
        • Parameters

          • emitter: this
          • Rest ...data: any[]

          Returns any

    Returns this

onMessage

  • onMessage(name: string, listener: function): boolean
  • Parameters

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

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

          Returns any

    Returns boolean

onReady

  • onReady(): void
  • Returns void

onUnload

  • onUnload(): void

once

  • once(event: string | number, cb: function): this
  • Parameters

    • event: string | number
    • cb: function
        • (emitter: this, ...data: any[]): any
        • Parameters

          • emitter: this
          • Rest ...data: any[]

          Returns any

    Returns this

openLogsFolder

  • openLogsFolder(): void

openModsFolder

  • openModsFolder(): void

openUrl

  • openUrl(url: string): void
  • Parameters

    • url: string

    Returns void

openWorkshop

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

    • Optional publishId: string

    Returns Promise<void>

processBackups

  • processBackups(): boolean

publishMod

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

    • modIndex: number

    Returns Promise<string>

recordProblem

  • recordProblem(message: string): void
  • Parameters

    • message: string

    Returns void

sendMessage

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

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

    Returns boolean

setLobbyData

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

    • name: string
    • data: string

    Returns boolean

setLobbyType

setOverlayWorks

  • setOverlayWorks(overlayWorks: boolean): void
  • Parameters

    • overlayWorks: boolean

    Returns void

setRichPresence

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

    • key: string
    • value: string

    Returns boolean

setupMods

  • setupMods(callback: function): void
  • Parameters

    • callback: function
        • (): void
        • Returns void

    Returns void

setupMultiplayerLog

  • setupMultiplayerLog(): void

setupReporting

  • setupReporting(): void

toggleDeveloperTools

  • toggleDeveloperTools(): void

trigger

  • trigger(event: string | number, ...data: any[]): Promise<any[]>
  • Parameters

    • event: string | number
    • Rest ...data: any[]

    Returns Promise<any[]>

unsubscribe

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

    • publishId: string

    Returns Promise<void>

waitUntil

  • waitUntil(event: string | number): Promise<Object>

Generated using TypeDoc