SteamWorks.SteamApps - theace0296/steamworks-node GitHub Wiki
Interface: SteamApps
SteamWorksNamespace.SteamApps
Table of contents
Properties
- BGetDLCDataByIndex
- BIsAppInstalled
- BIsCybercafe
- BIsDlcInstalled
- BIsLowViolence
- BIsSubscribed
- BIsSubscribedApp
- BIsSubscribedFromFamilySharing
- BIsSubscribedFromFreeWeekend
- BIsTimedTrial
- BIsVACBanned
- GetAppBuildId
- GetAppInstallDir
- GetAppOwner
- GetAvailableGameLanguages
- GetCurrentBetaName
- GetCurrentGameLanguage
- GetDLCCount
- GetDlcDownloadProgress
- GetEarliestPurchaseUnixTime
- GetFileDetails
- GetInstalledDepots
- GetLaunchCommandLine
- GetLaunchQueryParam
- InstallDLC
- MarkContentCorrupt
- RequestAllProofOfPurchaseKeys
- RequestAppProofOfPurchaseKey
- SetDlcContext
- UninstallDLC
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
BIsAppInstalled
• BIsAppInstalled: (appID: number) => boolean
Type declaration
▸ (appID): boolean
Parameters
| Name | Type |
|---|---|
appID |
number |
Returns
boolean
Defined in
BIsCybercafe
• BIsCybercafe: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
BIsDlcInstalled
• BIsDlcInstalled: (appID: number) => boolean
Type declaration
▸ (appID): boolean
Parameters
| Name | Type |
|---|---|
appID |
number |
Returns
boolean
Defined in
BIsLowViolence
• BIsLowViolence: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
BIsSubscribed
• BIsSubscribed: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
BIsSubscribedApp
• BIsSubscribedApp: (appID: number) => boolean
Type declaration
▸ (appID): boolean
Parameters
| Name | Type |
|---|---|
appID |
number |
Returns
boolean
Defined in
BIsSubscribedFromFamilySharing
• BIsSubscribedFromFamilySharing: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
BIsSubscribedFromFreeWeekend
• BIsSubscribedFromFreeWeekend: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
BIsTimedTrial
• BIsTimedTrial: (punSecondsAllowed: number, punSecondsPlayed: number) => boolean
Type declaration
▸ (punSecondsAllowed, punSecondsPlayed): boolean
Parameters
| Name | Type |
|---|---|
punSecondsAllowed |
number |
punSecondsPlayed |
number |
Returns
boolean
Defined in
BIsVACBanned
• BIsVACBanned: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
GetAppBuildId
• GetAppBuildId: () => number
Type declaration
▸ (): number
Returns
number
Defined in
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
GetAppOwner
• GetAppOwner: () => CSteamID
Type declaration
▸ (): CSteamID
Returns
Defined in
GetAvailableGameLanguages
• GetAvailableGameLanguages: () => string
Type declaration
▸ (): string
Returns
string
Defined in
GetCurrentBetaName
• GetCurrentBetaName: (pchName: string, cchNameBufferSize: number) => boolean
Type declaration
▸ (pchName, cchNameBufferSize): boolean
Parameters
| Name | Type |
|---|---|
pchName |
string |
cchNameBufferSize |
number |
Returns
boolean
Defined in
GetCurrentGameLanguage
• GetCurrentGameLanguage: () => string
Type declaration
▸ (): string
Returns
string
Defined in
GetDLCCount
• GetDLCCount: () => number
Type declaration
▸ (): number
Returns
number
Defined in
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
GetEarliestPurchaseUnixTime
• GetEarliestPurchaseUnixTime: (nAppID: number) => number
Type declaration
▸ (nAppID): number
Parameters
| Name | Type |
|---|---|
nAppID |
number |
Returns
number
Defined in
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
GetInstalledDepots
• GetInstalledDepots: (appID: number, cMaxDepots: number) => number
Type declaration
▸ (appID, cMaxDepots): number
Parameters
| Name | Type |
|---|---|
appID |
number |
cMaxDepots |
number |
Returns
number
Defined in
GetLaunchCommandLine
• GetLaunchCommandLine: (pszCommandLine: string, cubCommandLine: number) => number
Type declaration
▸ (pszCommandLine, cubCommandLine): number
Parameters
| Name | Type |
|---|---|
pszCommandLine |
string |
cubCommandLine |
number |
Returns
number
Defined in
GetLaunchQueryParam
• GetLaunchQueryParam: (pchKey: string) => string
Type declaration
▸ (pchKey): string
Parameters
| Name | Type |
|---|---|
pchKey |
string |
Returns
string
Defined in
InstallDLC
• InstallDLC: (nAppID: number) => undefined
Type declaration
▸ (nAppID): undefined
Parameters
| Name | Type |
|---|---|
nAppID |
number |
Returns
undefined
Defined in
MarkContentCorrupt
• MarkContentCorrupt: (bMissingFilesOnly: boolean) => boolean
Type declaration
▸ (bMissingFilesOnly): boolean
Parameters
| Name | Type |
|---|---|
bMissingFilesOnly |
boolean |
Returns
boolean
Defined in
RequestAllProofOfPurchaseKeys
• RequestAllProofOfPurchaseKeys: () => undefined
Type declaration
▸ (): undefined
Returns
undefined
Defined in
RequestAppProofOfPurchaseKey
• RequestAppProofOfPurchaseKey: (nAppID: number) => undefined
Type declaration
▸ (nAppID): undefined
Parameters
| Name | Type |
|---|---|
nAppID |
number |
Returns
undefined
Defined in
SetDlcContext
• SetDlcContext: (nAppID: number) => boolean
Type declaration
▸ (nAppID): boolean
Parameters
| Name | Type |
|---|---|
nAppID |
number |
Returns
boolean
Defined in
UninstallDLC
• UninstallDLC: (nAppID: number) => undefined
Type declaration
▸ (nAppID): undefined
Parameters
| Name | Type |
|---|---|
nAppID |
number |
Returns
undefined