Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace steamworks

Index

Functions

Variables

Functions

activateActionSet

  • activateActionSet(controllerIndex: number, actionSetName: string): void

claimAchievement

  • claimAchievement(achievement: string): void

createLobby

  • createLobby(lobbyType: "Private" | "FriendsOnly" | "Public" | "Invisible", maxPlayers: number, result: Variable): AsyncTask

createWorkshopItem

currentBetaName

  • currentBetaName(): string

currentGameLanguage

  • currentGameLanguage(): string

deleteFile

  • deleteFile(fileName: string, results: Variable): void

fileExists

  • fileExists(fileName: string): boolean

getAnalogActionVectorX

  • getAnalogActionVectorX(controllerIndex: number, actionName: string): float

getAnalogActionVectorY

  • getAnalogActionVectorY(controllerIndex: number, actionName: string): float

getAppID

  • getAppID(): number

getAppInstallDirectory

  • getAppInstallDirectory(appId: string): string

getBuildId

  • getBuildId(): number

getControllerCount

  • getControllerCount(): integer

getCountry

  • getCountry(): string

getCurrentLobbyAttribute

  • getCurrentLobbyAttribute(attribute: string): string

getCurrentLobbyId

  • getCurrentLobbyId(): string

getCurrentLobbyMemberCount

  • getCurrentLobbyMemberCount(): number

getCurrentLobbyMemberLimit

  • getCurrentLobbyMemberLimit(): number

getCurrentLobbyMembersList

  • getCurrentLobbyMembersList(storeIn: Variable): void

getCurrentLobbyOwner

  • getCurrentLobbyOwner(): string

getKnownLobby

  • getKnownLobby(lobbyId: string): null | Lobby

getLevel

  • getLevel(): number

getLobbiesList

getLobbyAttribute

  • getLobbyAttribute(lobbyId: string, attribute: string): string

getLobbyMemberCount

  • getLobbyMemberCount(lobbyId: string): number

getLobbyMemberLimit

  • getLobbyMemberLimit(lobbyId: string): number

getLobbyMembersList

  • getLobbyMembersList(lobbyId: string, storeIn: Variable): void

getLobbyOwner

  • getLobbyOwner(lobbyId: string): string

getName

  • getName(): string

getServerRealTime

  • getServerRealTime(): number

getSteamId

  • getSteamId(): string

getWorkshopItemDownloadProgress

  • getWorkshopItemDownloadProgress(itemId: string): number

getWorkshopItemDownloadTotal

  • getWorkshopItemDownloadTotal(itemId: string): number

getWorkshopItemInstallTimestamp

  • getWorkshopItemInstallTimestamp(itemId: string): number

getWorkshopItemLocation

  • getWorkshopItemLocation(itemId: string): string

getWorkshopItemSizeOnDisk

  • getWorkshopItemSizeOnDisk(itemId: string): number

hasAchievement

  • hasAchievement(achievement: string): boolean

isAppInstalled

  • isAppInstalled(appId: string): boolean

isAppOwned

  • isAppOwned(appId: string): boolean

isCloudEnabled

  • isCloudEnabled(): boolean

isDLCInstalled

  • isDLCInstalled(dlcId: string): boolean

isDigitalActionPressed

  • isDigitalActionPressed(controllerIndex: number, actionName: string): boolean

isLowViolence

  • isLowViolence(): boolean

isOnSteamDeck

  • isOnSteamDeck(): boolean

isSteamworksProperlyLoaded

  • isSteamworksProperlyLoaded(): boolean

isVacBanned

  • isVacBanned(): boolean

joinLobby

leaveCurrentLobby

  • leaveCurrentLobby(): void

openDialogForInvitingUsersToTheCurrentLobby

  • openDialogForInvitingUsersToTheCurrentLobby(): void

readFile

  • readFile(fileName: string): string

setCurrentLobbyAttribute

  • setCurrentLobbyAttribute(attribute: string, value: string, success: Variable): void

setCurrentLobbyJoinability

  • setCurrentLobbyJoinability(shouldBeJoinable: boolean, success: Variable): void

setRichPresence

  • setRichPresence(key: string, value: string): void

startWorkshopDownload

  • startWorkshopDownload(itemId: string, highPriority: boolean): void

subscribeToWorkshopItem

unclaimAchievement

  • unclaimAchievement(achievement: string): void

unsubscribeToWorkshopItem

updateWorkshopItem

  • updateWorkshopItem(itemId: string, title: string, description: string, changeNote: string, previewPath: string, contentPath: string, tags: string, visibility: "toString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf" | "toLocaleString", result: Variable): AsyncTask

  • Parameters

    • itemId: string
    • title: string
    • description: string
    • changeNote: string
    • previewPath: string
    • contentPath: string
    • tags: string
    • visibility: "toString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf" | "toLocaleString"
    • result: Variable

    Returns AsyncTask

userBoughtTheGame

  • userBoughtTheGame(): boolean

workshopItemState

  • workshopItemState(itemId: string, state: "toString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf" | "toLocaleString"): boolean

writeFile

  • writeFile(fileName: string, content: string, results: Variable): void

Variables

steamAPI

steamAPI: Client | null = null

Generated using TypeDoc