Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Steamworks

Hierarchy

  • Steamworks

Implements

Index

Methods

addZoomFactor

  • addZoomFactor(change: number): void
  • Parameters

    • change: number

    Returns void

clearRichPresence

  • clearRichPresence(): void

createArchive

  • createArchive(id: string, source: string, callback: function): void
  • Parameters

    • id: string
    • source: string
    • callback: function
        • (err?: string): void
        • Parameters

          • Optional err: string

          Returns void

    Returns void

createLobby

createSaveGameMod

  • createSaveGameMod(name: string, slot: number, callback: function): void
  • Parameters

    • name: string
    • slot: number
    • callback: function
        • (success: boolean): void
        • Parameters

          • success: boolean

          Returns void

    Returns void

debugLog

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

    • Rest ...args: any[]

    Returns void

deleteSaveGameMod

  • deleteSaveGameMod(name: string): void

fillOutWorkshopMod

getAbsolutePath

  • getAbsolutePath(p: string): any

getBetaName

  • getBetaName(): string

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

getPublishedItems

  • getPublishedItems(callback: function): void
  • Parameters

    • callback: function
        • Parameters

          Returns void

    Returns void

getPublishedMod

  • getPublishedMod(publishFileId: string): IWorkshopItem | undefined

getPublishedMods

getScreenName

  • getScreenName(): string | undefined

getSteamId

hasServerToJoin

  • hasServerToJoin(): boolean

importFromSaveGameMod

  • importFromSaveGameMod(modIndex: number, json: string, callback: function): void
  • Parameters

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

          • success: boolean

          Returns void

    Returns void

initialize

  • initialize(): void

isElectron

  • isElectron(): boolean

isGreenworksEnabled

  • isGreenworksEnabled(): 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

multiplayerLogSkipConsole

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

onReady

  • onReady(): void
  • Returns void

onUnload

  • onUnload(): void

onUpdateZoomFactor

  • onUpdateZoomFactor(): void

openLogsFolder

  • openLogsFolder(): void

openModsFolder

  • openModsFolder(): void

openUrl

  • openUrl(url: string): void
  • Parameters

    • url: string

    Returns void

openWorkshop

  • openWorkshop(publishId?: string): void
  • Parameters

    • Optional publishId: string

    Returns void

publishMod

  • publishMod(modIndex: number, callback: function): void
  • Parameters

    • modIndex: number
    • callback: function
        • (err?: string, publishedFileId?: string): void
        • Parameters

          • Optional err: string
          • Optional publishedFileId: string

          Returns void

    Returns void

recordProblem

  • recordProblem(message: string): void
  • Parameters

    • message: string

    Returns void

sendMessage

  • sendMessage(name: string, data: string): void
  • Parameters

    • name: string
    • data: string

    Returns void

setDefaultZoomFactor

  • setDefaultZoomFactor(): void

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

unsubscribe

  • unsubscribe(publishId: string, callback: function): void
  • Parameters

    • publishId: string
    • callback: function
        • (err?: string): void
        • Parameters

          • Optional err: string

          Returns void

    Returns void

updateZoomFactor

  • updateZoomFactor(): void

Generated using TypeDoc