Expose un large éventail d'informations et d'actions pour les applications et les contenus téléchargeables (DLC).

Fonctions membres

Les fonctions membres d'ISteamApps sont appelées par le biais de la fonction d'accesseur global SteamApps().

BGetDLCDataByIndex

Nom	Type	Description
iDLC	int	Index du DLC à obtenir entre 0 et GetDLCCount.
pAppID	AppId_t *	Renvoie l'AppID du DLC.
pbAvailable	bool *	Renvoie une valeur indiquant si le DLC est actuellement disponible ou non dans le magasin Steam. La valeur sera définie sur false si le DLC n'a pas de page du magasin visible.
pchName	char *	Renvoie le nom du DLC en le copiant dans ce tampon.
cchNameBufferSize	int	Taille du tampon pchName.

Renvoie les métadonnées pour un DLC par index.

Éléments renvoyés : bool
true si l'AppID actuel possède des DLC qui lui sont associés et que iDLC se trouve dans l'intervalle de 0 à GetDLCCount. Autrement, renvoie false.

Exemple

BIsAppInstalled

Nom	Type	Description
AppID	AppId_t	AppID de l'application à vérifier.

Vérifie si une application spécifique est installée.

Il est possible que le compte actuel ne possède pas l'application si celle-ci avait été obtenue pour une durée limitée, comme lors d'un weekend gratuit.

Cela ne fonctionne que pour les applications de base, et non pour les DLC. Pour les DLC, utilisez plutôt BIsDlcInstalled.

Éléments renvoyés : bool
true si l'AppID spécifié est installé. Autrement, renvoie false.

BIsCybercafe

Vérifie si l'AppID actuel est pour les cybercafés.

Éléments renvoyés : bool
true si la licence est pour les cybercafés. Autrement, renvoie false.
Obsolète : cette fonction n'est plus utilisée.

BIsDlcInstalled

Nom	Type	Description
AppID	AppId_t	AppID du DLC à vérifier.

Vérifie si le compte actuel possède un DLC spécifique et si le DLC est installé.

Éléments renvoyés : bool
true si le compte possède le DLC et qu'il est installé. Autrement, renvoie false.

Remarque : à n'utiliser que pour des vérifications simples du côté client, et non pour distribuer des items en jeu.

BIsLowViolence

Vérifie si la licence que la personne possède prévoit des dépôts où la violence est censurée.

Les dépôts où la violence est censurée sont utiles pour les copies vendues dans les pays imposant des restrictions de contenu.

Éléments renvoyés : bool
true si la licence que la personne possède prévoit des dépôts où la violence est censurée. Autrement, renvoie false.

Consultez également la page de la documentation sur les règles de montage des dépôts.

BIsSubscribed

Vérifie si le compte actif est abonné à l'AppID actuel.

REMARQUE : renverra toujours true si vous utilisez un DRM Steam ou que vous appelez SteamAPI_RestartAppIfNecessary.

Éléments renvoyés : bool
true si le compte actif possède l'AppID actuel. Autrement, renvoie false.

BIsSubscribedApp

Nom	Type	Description
AppID	AppId_t	AppID à vérifier.

Vérifie si le compte actif est abonné à un AppID défini.

N'utilisez cette fonction que si vous devez vérifier que le compte possède un autre jeu lié au vôtre, comme une démo.

Éléments renvoyés : bool
true si le compte actif est abonné à l'AppID défini. Autrement, renvoie false.

BIsSubscribedFromFamilySharing

Vérifie si le compte actif accède à l'AppID actuel depuis une licence de partage familial temporaire dont un autre compte est propriétaire.

Si vous devez déterminer le SteamID du compte propriétaire de la licence, utilisez GetAppOwner.

Éléments renvoyés : bool
true si le compte actif accède à l'AppID actuel depuis un partage familial. Autrement, renvoie false.

BIsSubscribedFromFreeWeekend

Vérifie si le compte est abonné à l'AppID actuel via un weekend gratuit.

Avant d'utiliser cette fonction, veuillez contacter l'équipe technique Valve responsable de la gestion des comptes via le forum de discussion de Steamworks pour bien préparer et sécuriser votre weekend gratuit.

Éléments renvoyés : bool
true si le compte actif est abonné à l'AppID actuel via un weekend gratuit. Renvoie false pour n'importe quel autre type de licence.

BIsTimedTrial

Nom	Type	Description
punSecondsAllowed	uint32 *	Renvoie la durée totale de l'essai en secondes.
punSecondsPlayed	uint32 *	Renvoie le temps de jeu du compte en secondes.

Vérifie si le compte est abonné à l'AppID actuel via un essai à durée limitée. Si c'est le cas, renvoie true et indique la durée totale de l'essai à durée limitée, ainsi que la durée actuelle du temps de jeu du compte associé.

Éléments renvoyés : bool
true si le compte actif est abonné à l'AppID actuel via un essai à durée limitée. Renvoie false pour n'importe quel autre type de licence.

Consultez également TimedTrialStatus_t.

BIsVACBanned

Vérifie si le compte a reçu un bannissement VAC.

Éléments renvoyés : bool
true si la personne a reçu un bannissement VAC sur son compte. Autrement, renvoie false.

GetAppBuildId

Obtient l'ID du build de cette application. Il peut être modifié à tout moment en fonction des mises à jour du jeu sur le serveur principal.

Éléments renvoyés : int
L'ID du build actuel de cette application. Par défaut, cette fonction renverra 0 si vous n'utilisez pas un build téléchargé depuis Steam.

GetAppInstallDir

Nom	Type	Description
appID	AppId_t	AppID pour lequel il faut obtenir le répertoire d'installation.
pchFolder	char *	Tampon de chaine dans lequel le chemin du dossier sera copié.
cchFolderBufferSize	uint32	Taille en octets du tampon pchFolder.

Obtient le dossier d'installation pour un AppID spécifique.

Cela fonctionne même si l'application n'est pas installée, en fonction de l'emplacement par défaut où serait installé le jeu dans la bibliothèque Steam.

Éléments renvoyés : uint32
Renvoie le chemin du répertoire d'installation sous forme de chaine dans le tampon fourni par pchFolder ainsi que le nombre d'octets copiés dans ce tampon.

GetAppOwner

Obtient le SteamID de la personne véritablement propriétaire de l'application actuelle. Il est différent de la personne qui joue si l'accès à cette application a été réalisé via le partage familial.

Éléments renvoyés : CSteamID
Le compte propriétaire d'origine de l'application actuelle.

GetAvailableGameLanguages

Obtient une liste séparée par des virgules des langues prises en charge par l'application actuelle.

Pour la liste complète des langues qui peuvent être renvoyées, consultez l'article sur la traduction et les langues.

Éléments renvoyés : const char *
Renvoie une liste de langues séparées par des virgules.

Consultez également : GetCurrentGameLanguage, ISteamUtils::GetSteamUILanguage

GetCurrentBetaName

Nom	Type	Description
pchName	char *	Tampon dans lequel le nom de la bêta sera copié.
cchNameBufferSize	int	Taille totale du tampon pchName.

Vérifie si la personne exécute le logiciel depuis une version bêta et obtient le nom de la version le cas échéant.

Éléments renvoyés : bool
true si la personne utilise une version bêta. Autrement, renvoie false.

GetCurrentGameLanguage

Obtient la langue actuellement définie pour le compte.

Si la personne n'a pas choisi explicitement une langue pour le titre, c'est la langue de l'interface Steam qui sera utilisée.

Pour obtenir la liste complète des langues prises en charge, consultez cet article.

Éléments renvoyés : const char *


Consultez également GetAvailableGameLanguages et ISteamUtils::GetSteamUILanguage.

GetDLCCount

Obtient le nombre de DLC pour l'application actuelle.

Sert typiquement à effectuer une boucle sur chaque DLC pour récupérer les informations sur chacun d'eux à l'aide de BGetDLCDataByIndex.

Éléments renvoyés : int
Le nombre de DLC pour l'application actuelle. Remarque : cette valeur peut être limitée à 64, selon le nombre de DLC non possédés par la personne. Si votre application possède de nombreux DLC, établissez votre propre liste interne de DLC afin d'effectuer une vérification.

Exemple

GetDlcDownloadProgress

Nom	Type	Description
nAppID	AppId_t	AppID du DLC à surveiller.
punBytesDownloaded	uint64 *	Renvoie le nombre d'octets téléchargés.
punBytesTotal	uint64 *	Renvoie la taille totale du téléchargement en octets.

Obtient la progression du téléchargement pour le DLC facultatif.

Éléments renvoyés : bool
true si le DLC spécifié existe et est en cours de téléchargement. Autrement, renvoie false.

GetEarliestPurchaseUnixTime

Nom	Type	Description
nAppID	AppId_t	AppID pour lequel la date d'achat doit être obtenue.

Obtient la date d'achat de l'application spécifiée au format horaire Unix (nombre de secondes écoulées depuis le 1ᵉʳ janvier 1970).

Cette fonction est utile pour récompenser vos fans en fonction de la date de leur achat initial.

Éléments renvoyés : uint32
La date d'achat la plus ancienne au format horaire Unix (nombre de secondes écoulées depuis le 1ᵉʳ janvier 1970).

GetFileDetails

Nom	Type	Description
pszFileName	const char*	Chemin absolu et nom du fichier.

Récupère de manière asynchrone les détails des métadonnées concernant un fichier spécifique dans le manifeste du dépôt.

Fournit actuellement :
la taille du fichier en octets ;
le hachage SHA1 du fichier ;
les indicateurs du fichier.

Éléments renvoyés : SteamAPICall_t, à utiliser avec un résultat d'appel FileDetailsResult_t.

GetInstalledDepots

Nom	Type	Description
appID	AppId_t	Application pour laquelle les dépôts doivent être listés.
pvecDepots	DepotId_t *	Tableau préalloué qui sera rempli avec les listes des dépôts.
cMaxDepots	uint32	Nombre maximum de dépôts à obtenir, généralement la taille de pvecDepots.

Obtient une liste de tous les dépôts installés pour un AppID dans l'ordre de montage.

Éléments renvoyés : uint32
Le nombre de dépôts renvoyés.

GetLaunchCommandLine

Nom	Type	Description
pszCommandLine	char *	Tampon de chaine dans lequel la ligne de commande sera copiée.
cubCommandLine	int	Taille en octets du tampon pszCommandLine.

Obtient la ligne de commande si le jeu a été lancé depuis une URL Steam, comme steam://run/<appid>//<command line>/. Cette méthode est préférable au lancement avec une ligne de commande depuis le système d'exploitation, qui peut comporter des risques. Pour s'assurer que les liens de présence enrichie passent par cette méthode et non pas par la ligne de commande du système d'exploitation, vous devez activer l'option correspondante. Pour ce faire, depuis la page d'accueil de votre application sur Steamworks, cliquez sur Modifier les paramètres Steamworks → Installation → Installation générale, puis cochez « Activer l'utilisation de ISteamApps::GetLaunchCommandLine() ».

Éléments renvoyés : int
Renvoie la ligne de commande sous forme de chaine dans le tampon fourni par pszCommandLine ainsi que le nombre d'octets copiés dans ce tampon.

Consultez également NewUrlLaunchParameters_t.

GetLaunchQueryParam

Nom	Type	Description
pchKey	const char *	Clé de lancement à tester. P. ex. : param1

Obtient le paramètre de lancement associé si le jeu est lancé via steam://run/<appid>/?param1=valeur1;param2=valeur2;param3=valeur3, etc.

Les noms de paramètres commençant par une arobase « @ » sont réservés à un usage interne et renverront toujours une chaine vide.
Les noms de paramètres commençant par un tiret bas « _ » sont réservés aux fonctions de Steam. Ils peuvent être demandés par le jeu, mais il est conseillé de ne pas paramétrer de noms commençant par un tiret bas pour vos propres fonctions.

Éléments renvoyés : const char *
La valeur associée à la clé fournie. Renvoie une chaine vide ("") si la clé spécifiée n'existe pas.

Consultez également : NewLaunchQueryParameters_t.

InstallDLC

Nom	Type	Description
nAppID	AppId_t	DLC que vous voulez installer.

Vous permet d'installer un DLC facultatif.

Éléments renvoyés : void

Déclenche un rappel DlcInstalled_t.

MarkContentCorrupt

Nom	Type	Description
bMissingFilesOnly	bool	Recherche uniquement les fichiers manquants, sans vérifier la somme de contrôle de chaque fichier.

Vous permet de forcer la vérification du contenu du jeu lors du lancement suivant.

Si vous détectez que le jeu n'est pas à jour (par exemple, en faisant en sorte que le client détecte que la version et le serveur ne correspondent pas),
vous pouvez appeler MarkContentCorrupt pour forcer une vérification, afficher un message à la personne, puis fermer le jeu.

Éléments renvoyés : bool

RequestAllProofOfPurchaseKeys

Obsolète.

RequestAppProofOfPurchaseKey

Nom	Type	Description
nAppID	AppId_t

Obsolète.

UninstallDLC

Nom	Type	Description
nAppID	AppId_t	DLC que vous voulez désinstaller.

Vous permet de désinstaller un DLC facultatif.

Rappels

Voici les rappels qui peuvent être activés en appelant SteamAPI_RunCallbacks. La plupart seront activés directement en réponse aux fonctions membres d'ISteamApps.

AppProofOfPurchaseKeyResponse_t

Utilisé uniquement en interne dans Steam.

Nom	Type	Description
m_eResult	EResult
m_nAppID	uint32
m_cchKeyLength	uint32
m_rgchKey	char［k_cubAppProofOfPurchaseKeyMax］

DlcInstalled_t

Déclenché une fois que le compte actuel devient propriétaire du DLC et que ce DLC est installé.

Nom	Type	Description
m_nAppID	AppId_t	AppID du DLC qui a été installé.

Fonctions associées : InstallDLC.

FileDetailsResult_t

Appelé après avoir demandé les détails d'un fichier spécifique.

Nom	Type	Description
m_eResult	EResult	L'appel a-t-il réussi ? k_EResultOK si c'est le cas. Autrement, renvoie k_EResultFileNotFound si le fichier n'a pas été trouvé. Aucun des autres champs ne sera rempli si l'appel n'a pas réussi.
m_ulFileSize	uint64	Taille originale du fichier en octets.
m_FileSHA	uint8［20］	Hachage SHA1 du fichier original.
m_unFlags	uint32

Fonctions associées : GetFileDetails.

NewUrlLaunchParameters_t

Envoyé quand une personne exécute une URL Steam avec une ligne de commande ou des paramètres de requête tels que steam://run/<appid>//?param1=valeur1;param2=valeur2;param3=valeur3; alors que le jeu est déjà en cours d'exécution. Les nouveaux paramètres peuvent être demandés à l'aide de GetLaunchCommandLine et GetLaunchQueryParam.

Ce rappel n'a pas de champ.

NewLaunchQueryParameters_t

Envoyé quand une personne exécute une URL Steam avec des paramètres de requête tels que steam://run/<appid>//?param1=valeur1;param2=valeur2;param3=valeur3; alors que le jeu est en cours d'exécution. Les nouveaux paramètres peuvent être demandés à l'aide de GetLaunchQueryParam.

Ce rappel n'a pas de champ.

RegisterActivationCodeResponse_t

Utilisé uniquement en interne dans Steam.

Nom	Type	Description
m_eResult	ERegisterActivationCodeResult
m_unPackageRegistered	uint32

TimedTrialStatus_t

Envoyé chaque minute lorsqu'un appID est détenu dans le cadre d'un essai à durée limitée.

Nom	Type	Description
m_unAppID	AppId_t	AppID détenu dans le cadre d'un essai à durée limitée.
m_bIsOffline	bool	Si la valeur est true, cela signifie que la personne est actuellement hors ligne. Le temps de jeu autorisé (m_unSecondsAllowed) ou passé en jeu (m_unSecondsPlayed) qui est renvoyé fait référence au temps de jeu en mode hors ligne, et non au temps de jeu total.
m_unSecondsAllowed	uint32	Temps de jeu autorisé au total en secondes.
m_unSecondsPlayed	uint32	Temps de jeu en secondes.

Consultez également BIsTimedTrial.

Énumérations

Voici les énumérations destinées à être utilisées avec ISteamApps.

ERegisterActivationCodeResult

Utilisée uniquement en interne dans Steam.

Nom	Valeur	Description
k_ERegisterActivationCodeResultOK	0
k_ERegisterActivationCodeResultFail	1
k_ERegisterActivationCodeResultAlreadyRegistered	2
k_ERegisterActivationCodeResultTimeout	3
k_ERegisterActivationCodeAlreadyOwned	4

Constantes

Voici les constantes destinées à être utilisées avec ISteamApps.

Nom	Type	Valeur	Description
k_cubAppProofOfPurchaseKeyMax	int	240	Utilisée uniquement en interne dans Steam.
STEAMAPPS_INTERFACE_VERSION	const char *	"STEAMAPPS_INTERFACE_VERSION008"