SteamWorks.SteamApps - theace0296/steamworks-node GitHub Wiki

Interface: SteamApps

SteamWorksNamespace.SteamApps

Table of contents

Properties

Properties

BGetDLCDataByIndex

BGetDLCDataByIndex: (iDLC: number, pAppID: unknown, pbAvailable: unknown, pchName: string, cchNameBufferSize: number) => boolean

Type declaration

▸ (iDLC, pAppID, pbAvailable, pchName, cchNameBufferSize): boolean

Parameters
Name Type
iDLC number
pAppID unknown
pbAvailable unknown
pchName string
cchNameBufferSize number
Returns

boolean

Defined in

index.d.ts:2435


BIsAppInstalled

BIsAppInstalled: (appID: number) => boolean

Type declaration

▸ (appID): boolean

Parameters
Name Type
appID number
Returns

boolean

Defined in

index.d.ts:2443


BIsCybercafe

BIsCybercafe: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2426


BIsDlcInstalled

BIsDlcInstalled: (appID: number) => boolean

Type declaration

▸ (appID): boolean

Parameters
Name Type
appID number
Returns

boolean

Defined in

index.d.ts:2431


BIsLowViolence

BIsLowViolence: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2425


BIsSubscribed

BIsSubscribed: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2424


BIsSubscribedApp

BIsSubscribedApp: (appID: number) => boolean

Type declaration

▸ (appID): boolean

Parameters
Name Type
appID number
Returns

boolean

Defined in

index.d.ts:2430


BIsSubscribedFromFamilySharing

BIsSubscribedFromFamilySharing: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2451


BIsSubscribedFromFreeWeekend

BIsSubscribedFromFreeWeekend: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2433


BIsTimedTrial

BIsTimedTrial: (punSecondsAllowed: number, punSecondsPlayed: number) => boolean

Type declaration

▸ (punSecondsAllowed, punSecondsPlayed): boolean

Parameters
Name Type
punSecondsAllowed number
punSecondsPlayed number
Returns

boolean

Defined in

index.d.ts:2452


BIsVACBanned

BIsVACBanned: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2427


GetAppBuildId

GetAppBuildId: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2447


GetAppInstallDir

GetAppInstallDir: (appID: number, pchFolder: string, cchFolderBufferSize: number) => number

Type declaration

▸ (appID, pchFolder, cchFolderBufferSize): number

Parameters
Name Type
appID number
pchFolder string
cchFolderBufferSize number
Returns

number

Defined in

index.d.ts:2442


GetAppOwner

GetAppOwner: () => CSteamID

Type declaration

▸ (): CSteamID

Returns

CSteamID

Defined in

index.d.ts:2444


GetAvailableGameLanguages

GetAvailableGameLanguages: () => string

Type declaration

▸ (): string

Returns

string

Defined in

index.d.ts:2429


GetCurrentBetaName

GetCurrentBetaName: (pchName: string, cchNameBufferSize: number) => boolean

Type declaration

▸ (pchName, cchNameBufferSize): boolean

Parameters
Name Type
pchName string
cchNameBufferSize number
Returns

boolean

Defined in

index.d.ts:2439


GetCurrentGameLanguage

GetCurrentGameLanguage: () => string

Type declaration

▸ (): string

Returns

string

Defined in

index.d.ts:2428


GetDLCCount

GetDLCCount: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2434


GetDlcDownloadProgress

GetDlcDownloadProgress: (nAppID: number, punBytesDownloaded: bigint, punBytesTotal: bigint) => boolean

Type declaration

▸ (nAppID, punBytesDownloaded, punBytesTotal): boolean

Parameters
Name Type
nAppID number
punBytesDownloaded bigint
punBytesTotal bigint
Returns

boolean

Defined in

index.d.ts:2446


GetEarliestPurchaseUnixTime

GetEarliestPurchaseUnixTime: (nAppID: number) => number

Type declaration

▸ (nAppID): number

Parameters
Name Type
nAppID number
Returns

number

Defined in

index.d.ts:2432


GetFileDetails

GetFileDetails: (pszFileName: string) => Promise<{ m_FileSHA: unknown ; m_eResult: EResult ; m_ulFileSize: bigint ; m_unFlags: number }>

Type declaration

▸ (pszFileName): Promise<{ m_FileSHA: unknown ; m_eResult: EResult ; m_ulFileSize: bigint ; m_unFlags: number }>

Parameters
Name Type
pszFileName string
Returns

Promise<{ m_FileSHA: unknown ; m_eResult: EResult ; m_ulFileSize: bigint ; m_unFlags: number }>

Defined in

index.d.ts:2449


GetInstalledDepots

GetInstalledDepots: (appID: number, cMaxDepots: number) => number

Type declaration

▸ (appID, cMaxDepots): number

Parameters
Name Type
appID number
cMaxDepots number
Returns

number

Defined in

index.d.ts:2441


GetLaunchCommandLine

GetLaunchCommandLine: (pszCommandLine: string, cubCommandLine: number) => number

Type declaration

▸ (pszCommandLine, cubCommandLine): number

Parameters
Name Type
pszCommandLine string
cubCommandLine number
Returns

number

Defined in

index.d.ts:2450


GetLaunchQueryParam

GetLaunchQueryParam: (pchKey: string) => string

Type declaration

▸ (pchKey): string

Parameters
Name Type
pchKey string
Returns

string

Defined in

index.d.ts:2445


InstallDLC

InstallDLC: (nAppID: number) => undefined

Type declaration

▸ (nAppID): undefined

Parameters
Name Type
nAppID number
Returns

undefined

Defined in

index.d.ts:2436


MarkContentCorrupt

MarkContentCorrupt: (bMissingFilesOnly: boolean) => boolean

Type declaration

▸ (bMissingFilesOnly): boolean

Parameters
Name Type
bMissingFilesOnly boolean
Returns

boolean

Defined in

index.d.ts:2440


RequestAllProofOfPurchaseKeys

RequestAllProofOfPurchaseKeys: () => undefined

Type declaration

▸ (): undefined

Returns

undefined

Defined in

index.d.ts:2448


RequestAppProofOfPurchaseKey

RequestAppProofOfPurchaseKey: (nAppID: number) => undefined

Type declaration

▸ (nAppID): undefined

Parameters
Name Type
nAppID number
Returns

undefined

Defined in

index.d.ts:2438


SetDlcContext

SetDlcContext: (nAppID: number) => boolean

Type declaration

▸ (nAppID): boolean

Parameters
Name Type
nAppID number
Returns

boolean

Defined in

index.d.ts:2453


UninstallDLC

UninstallDLC: (nAppID: number) => undefined

Type declaration

▸ (nAppID): undefined

Parameters
Name Type
nAppID number
Returns

undefined

Defined in

index.d.ts:2437