Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Static Public Member Functions | List of all members
Steamworks.SteamApps Class Reference

Static Public Member Functions

static bool BGetDLCDataByIndex (int iDLC, out AppId_t pAppID, out bool pbAvailable, out string pchName, int cchNameBufferSize)
 
static bool BIsAppInstalled (AppId_t appID)
 
static bool BIsCybercafe ()
 
static bool BIsDlcInstalled (AppId_t appID)
 
static bool BIsLowViolence ()
 
static bool BIsSubscribed ()
 
static bool BIsSubscribedApp (AppId_t appID)
 
static bool BIsSubscribedFromFreeWeekend ()
 
static bool BIsVACBanned ()
 
static int GetAppBuildId ()
 
static uint GetAppInstallDir (AppId_t appID, out string pchFolder, uint cchFolderBufferSize)
 
static CSteamID GetAppOwner ()
 
static string GetAvailableGameLanguages ()
 
static bool GetCurrentBetaName (out string pchName, int cchNameBufferSize)
 
static string GetCurrentGameLanguage ()
 
static int GetDLCCount ()
 
static bool GetDlcDownloadProgress (AppId_t nAppID, out ulong punBytesDownloaded, out ulong punBytesTotal)
 
static uint GetEarliestPurchaseUnixTime (AppId_t nAppID)
 
static SteamAPICall_t GetFileDetails (string pszFileName)
 
static uint GetInstalledDepots (AppId_t appID, DepotId_t[] pvecDepots, uint cMaxDepots)
 
static string GetLaunchQueryParam (string pchKey)
 
static void InstallDLC (AppId_t nAppID)
 
static bool MarkContentCorrupt (bool bMissingFilesOnly)
 
static void RequestAllProofOfPurchaseKeys ()
 
static void RequestAppProofOfPurchaseKey (AppId_t nAppID)
 
static void UninstallDLC (AppId_t nAppID)
 

Member Function Documentation

static bool Steamworks.SteamApps.BGetDLCDataByIndex ( int  iDLC,
out AppId_t  pAppID,
out bool  pbAvailable,
out string  pchName,
int  cchNameBufferSize 
)
inlinestatic

Returns metadata for DLC by index, of range [0, GetDLCCount()]

static bool Steamworks.SteamApps.BIsAppInstalled ( AppId_t  appID)
inlinestatic

returns true if that app is installed (not necessarily owned)

static bool Steamworks.SteamApps.BIsCybercafe ( )
inlinestatic
static bool Steamworks.SteamApps.BIsDlcInstalled ( AppId_t  appID)
inlinestatic

Takes AppID of DLC and checks if the user owns the DLC & if the DLC is installed

static bool Steamworks.SteamApps.BIsLowViolence ( )
inlinestatic
static bool Steamworks.SteamApps.BIsSubscribed ( )
inlinestatic
static bool Steamworks.SteamApps.BIsSubscribedApp ( AppId_t  appID)
inlinestatic

only use this member if you need to check ownership of another game related to yours, a demo for example

static bool Steamworks.SteamApps.BIsSubscribedFromFreeWeekend ( )
inlinestatic

Checks if the user is subscribed to the current app through a free weekend

This function will return false for users who have a retail or other type of license

Before using, please ask your Valve technical contact how to package and secure your free weekened

static bool Steamworks.SteamApps.BIsVACBanned ( )
inlinestatic
static int Steamworks.SteamApps.GetAppBuildId ( )
inlinestatic

return the buildid of this app, may change at any time based on backend updates to the game

static uint Steamworks.SteamApps.GetAppInstallDir ( AppId_t  appID,
out string  pchFolder,
uint  cchFolderBufferSize 
)
inlinestatic

returns current app install folder for AppID, returns folder name length

static CSteamID Steamworks.SteamApps.GetAppOwner ( )
inlinestatic

returns the SteamID of the original owner. If different from current user, it's borrowed

static string Steamworks.SteamApps.GetAvailableGameLanguages ( )
inlinestatic
static bool Steamworks.SteamApps.GetCurrentBetaName ( out string  pchName,
int  cchNameBufferSize 
)
inlinestatic

returns current beta branch name, 'public' is the default branch

static string Steamworks.SteamApps.GetCurrentGameLanguage ( )
inlinestatic
static int Steamworks.SteamApps.GetDLCCount ( )
inlinestatic

Returns the number of DLC pieces for the running app

static bool Steamworks.SteamApps.GetDlcDownloadProgress ( AppId_t  nAppID,
out ulong  punBytesDownloaded,
out ulong  punBytesTotal 
)
inlinestatic

get download progress for optional DLC

static uint Steamworks.SteamApps.GetEarliestPurchaseUnixTime ( AppId_t  nAppID)
inlinestatic

returns the Unix time of the purchase of the app

static SteamAPICall_t Steamworks.SteamApps.GetFileDetails ( string  pszFileName)
inlinestatic
static uint Steamworks.SteamApps.GetInstalledDepots ( AppId_t  appID,
DepotId_t[]  pvecDepots,
uint  cMaxDepots 
)
inlinestatic

return installed depots in mount order

static string Steamworks.SteamApps.GetLaunchQueryParam ( string  pchKey)
inlinestatic

Returns the associated launch param if the game is run via steam://run/<appid>//?param1=value1;param2=value2;param3=value3 etc.

Parameter names starting with the character '@' are reserved for internal use and will always return and empty string.

Parameter names starting with an underscore '_' are reserved for steam features – they can be queried by the game,

but it is advised that you not param names beginning with an underscore for your own features.

static void Steamworks.SteamApps.InstallDLC ( AppId_t  nAppID)
inlinestatic

Install/Uninstall control for optional DLC

static bool Steamworks.SteamApps.MarkContentCorrupt ( bool  bMissingFilesOnly)
inlinestatic

signal Steam that game files seems corrupt or missing

static void Steamworks.SteamApps.RequestAllProofOfPurchaseKeys ( )
inlinestatic

Request all proof of purchase keys for the calling appid and asociated DLC.

A series of AppProofOfPurchaseKeyResponse_t callbacks will be sent with

appropriate appid values, ending with a final callback where the m_nAppId

member is k_uAppIdInvalid (zero).

static void Steamworks.SteamApps.RequestAppProofOfPurchaseKey ( AppId_t  nAppID)
inlinestatic

Request legacy cd-key for yourself or owned DLC. If you are interested in this

data then make sure you provide us with a list of valid keys to be distributed

to users when they purchase the game, before the game ships.

You'll receive an AppProofOfPurchaseKeyResponse_t callback when

the key is available (which may be immediately).

static void Steamworks.SteamApps.UninstallDLC ( AppId_t  nAppID)
inlinestatic

The documentation for this class was generated from the following file: