ISteamApps - adambiser/agk-steam-plugin GitHub Wiki
GetDLCDataByIndexAppID(index as integer) as integer
- index - The index. Should be between 0 and GetDLCCount() - 1.
Returns the App ID of a DLC by index.
Returns: The AppID if the index is valid; otherwise 0.
Reference:
ISteamApps#GetDLCCount
ISteamApps#BGetDLCDataByIndex
GetDLCDataByIndexAvailable(index as integer) as integer
- index - The index. Should be between 0 and GetDLCCount() - 1.
Returns whether the DLC at the given index is available.
Returns: 1 if available; otherwise 0.
Reference:
ISteamApps#GetDLCCount
ISteamApps#BGetDLCDataByIndex
GetDLCDataByIndexName(index as integer) as string
- index - The index. Should be between 0 and GetDLCCount() - 1.
Returns the name of the DLC at the given index.
Returns: The DLC name if the index is valid; otherwise and empty string.
Reference:
ISteamApps#GetDLCCount
ISteamApps#BGetDLCDataByIndex
IsAppInstalled(appID as integer) as integer
- appID - The App ID of the application to check.
Checks if a specific app is installed. This only works for base applications, not DLC. Use IsDLCInstalled for DLC instead.
Returns: 1 if the app is installed; otherwise 0.
Reference:
ISteamApps#BIsAppInstalled
IsCybercafe() as integer
Checks whether the current App ID is for Cyber Cafes.
Returns: 1 if a cyber cafe; otherwise 0.
Reference:
ISteamApps#BIsCybercafe
IsDLCInstalled(appID as integer) as integer
- appID - The App ID of the DLC to check.
Checks if the user owns a specific DLC and if the DLC is installed
Returns: 1 when the user owns a DLC and it is installed; otherwise 0.
Reference:
ISteamApps#BIsDlcInstalled
IsLowViolence() as integer
Checks if the license owned by the user provides low violence depots.
Returns: 1 if the license owned by the user provides low violence depots; otherwise 0.
Reference:
ISteamApps#BIsLowViolence
IsSubscribed() as integer
Checks if the active user is subscribed to the current App ID.
Returns: 1 if the active user owns the current AppId; otherwise 0.
Reference:
ISteamApps#BIsSubscribed
IsSubscribedApp(appID as integer) as integer
- appID - The App ID to check.
Checks if the active user is subscribed to a specified AppId. Only use this if you need to check ownership of another game related to yours, a demo for example.
Returns: 1 if the active user is subscribed to the specified App ID; otherwise 0.
Reference:
ISteamApps#BIsSubscribedApp
IsSubscribedFromFamilySharing() as integer
Check if user borrowed this game via Family Sharing, If true, call GetAppOwner() to get the lender SteamID
Returns: 1 if the active user borrowed this game via Family Sharing; otherwise 0.
Reference:
ISteamApps#BIsSubscribedFromFamilySharing
IsSubscribedFromFreeWeekend() as integer
Checks if the user is subscribed to the current App ID through a free weekend.
Returns: 1 if the active user is subscribed to the current App Id via a free weekend; otherwise 0 for any other kind of license.
Reference:
ISteamApps#BIsSubscribedFromFreeWeekend
IsVACBanned() as integer
Checks if the user has a VAC ban on their account.
Returns: 1 when the user has a VAC ban; otherwise 0.
Reference:
ISteamApps#BIsVACBanned
GetAppBuildID() as integer
Gets the buildid of this app, may change at any time based on backend updates to the game.
Returns: The App BuildID if installed; otherwise 0.
Reference:
ISteamApps#GetAppBuildId
GetAppInstallDir(appID as integer) as string
- appID - The App ID to get the install dir for.
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.
Returns: The path the app is installed, or would be installed.
Reference:
ISteamApps#GetAppInstallDir
GetAppOwner() as integer
Gets the Steam ID handle of the original owner of the current app. If it's different from the current user then it is borrowed.
Returns: A Steam ID handle.
Reference:
ISteamApps#GetAppOwner
GetAvailableGameLanguages() as string
Gets a comma separated list of the languages the current app supports.
Returns: List of languages, separated by commas.
Reference:
ISteamApps#GetAvailableGameLanguages
GetCurrentBetaName() as string
Checks if the user is running from a beta branch, and gets the name of the branch if they are.
Returns: The name of the beta branch running; otherwise an empty string if not a beta branch or the app is not installed
Reference:
ISteamApps#GetCurrentBetaName
GetCurrentGameLanguage() as string
Gets the current language that the user has set.
Returns: The current language if the app is installed; otherwise an empty string.
Reference:
ISteamApps#GetCurrentGameLanguage
GetDLCCount() as integer
Gets the number of DLC pieces for the current app.
Returns: The number of DLC pieces for the current app.
Reference:
ISteamApps#GetDLCCount
GetDLCDownloadProgressBytesDownloaded(appID as integer) as integer
- appID - The App ID of the DLC to monitor.
Gets the bytes downloaded of the download progress for DLC.
Note: Steamworks returns an unsigned 64-bit integer, but AppGameKit only supports signed 32-bit integers. Files larger than 2 GB will cause problems.
Returns: The number of bytes downloaded.
Reference:
ISteamApps#GetDlcDownloadProgress
GetDLCDownloadProgressBytesTotal(appID as integer) as integer
- appID - The App ID of the DLC to monitor.
Gets the bytes total of the download progress for DLC.
Note: Steamworks returns an unsigned 64-bit integer, but AppGameKit only supports signed 32-bit integers. Files larger than 2 GB will cause problems.
Returns: The total size of the download in bytes.
Reference:
ISteamApps#GetDlcDownloadProgress
GetEarliestPurchaseUnixTime(appID as integer) as integer
- appID - The App ID to get the purchase time for.
Gets the time of purchase of the specified app in Unix epoch format (time since Jan 1st, 1970).
Returns: A Unix epoch time.
Reference:
ISteamApps#GetEarliestPurchaseUnixTime
GetFileDetails(filename as string) as integer
- filename - The filename in the current depot.
Asynchronously retrieves metadata details about a specific file in the depot manifest.
Returns: A[call result handle](Callbacks - and-Call - Results#call - results) on success; otherwise 0.
Associated Methods:
GetFileDetailsSHA1
GetFileDetailsSize
Reference:
ISteamApps#GetFileDetails
GetFileDetailsSHA1(hCallResult as integer) as string
- hCallResult - A GetFileDetails call result handle.
Returns the SHA1 hash for the file.
This method should only be used when the call result returned by GetFileDetails has reported a GetCallResultCode of 1.
Returns: A 40 character hexidecimal string or an empty string if there was an error.
Reference:
ISteamApps#GetFileDetails
ISteamApps#FileDetailsResult_t
GetFileDetailsSize(hCallResult as integer) as integer
- hCallResult - A GetFileDetails call result handle.
Returns the size of the file.
This method should only be used when the call result returned by GetFileDetails has reported a GetCallResultCode of 1.
Returns: The file size.
Reference:
ISteamApps#GetFileDetails
ISteamApps#FileDetailsResult_t
GetInstalledDepotsJSON(appID as integer, maxDepots as integer) as string
- appID - The App to list the depots for.
- maxDepots - The maximum number of depots to obtain.
Gets a list of all installed depots for a given App ID in mount order.
Returns: A JSON string of an integer array.
Reference:
ISteamApps#GetInstalledDepots
GetLaunchCommandLine() as string
Gets the command line if game was launched via Steam URL, e.g. steam://run////.
Returns: The command line if launched via Steam URL.
Reference:
ISteamApps#GetLaunchCommandLine
GetLaunchQueryParam(key as string) as string
- key - The launch key to test for. Ex: param1
Gets the associated launch parameter if the game is run via steam://run//?param1=value1;param2=value2;param3=value3 etc.
Returns: The key value or an empty string if the key doesn't exist.
Reference:
ISteamApps#GetLaunchQueryParam
InstallDLC(appID as integer)
- appID - The App ID of the DLC you want to install.
Install a DLC. HasDLCInstalledResponse will report true when a DLC has finished installing.
Reference:
ISteamApps#InstallDLC
MarkContentCorrupt(missingFilesOnly as integer) as integer
- missingFilesOnly - Only scan for missing files, don't verify the checksum of each file.
Allows you to force verify game content on next launch.
If you detect the game is out-of-date (for example, by having the client detect a version mismatch with a server), you can call use MarkContentCorrupt to force a verify, show a message to the user, and then quit.
Returns: A boolean as 0 or 1. Steam API doesn't indicate what this means.
Reference:
ISteamApps#MarkContentCorrupt
UninstallDLC(appID as integer)
- appID - The App ID of the DLC you want to uninstall.
Uninstall a DLC.
Note: This appears to take place after exiting the app.
Reference:
ISteamApps#UninstallDLC
HasDLCInstalledResponse() as integer
Triggered after the current user gains ownership of DLC and that DLC is installed.
Returns: 1 when the callback has more responses to process; otherwise 0.
Associated Methods:
GetDLCInstalledAppID
Reference:
ISteamApps#DlcInstalled_t
GetDLCInstalledAppID() as integer
Returns the App ID for the current LobbyGameCreated_t callback response.
This method should only be used when HasDLCInstalledResponse has returned 1.
Returns: An App ID.
Reference:
ISteamApps#DlcInstalled_t
HasNewUrlLaunchParametersResponse() as integer
Posted after the user executes a steam url with query parameters while running. Once a post has been reported, this method returns 0 until another post arrives.
Returns: 1 when the user executes a steam url with query parameters while running; otherwise 0.
Reference:
ISteamApps#NewLaunchQueryParameters_t