Syntaxe:

steam_ugc_download(ugc_handle, dest_filename);

Renvoie: Async ID

La description

Avec cette fonction, vous pouvez télécharger une image d'aperçu pour n'importe quel objet UGC. le ugc_handle est la valeur d'identification unique pour l'image (que vous pouvez obtenir en utilisant la fonction steam_ugc_send_query() ), et le nom de fichier de destination est le nom (et le chemin local dans le sandbox Steam ) que vous souhaitez donner au fichier image lorsque le téléchargement est terminé.

Lors de l'utilisation de cette fonction, un événement Steam Asynchronous est déclenché pour signaler les détails du fichier image demandé contenant les paires clé / valeur suivantes async_load ds_map:

1. " id " - L'identifiant asynchrone renvoyé par la fonction d'appel
2. 
   
3. " résultat " - Le résultat de l'opération (une valeur réelle). Ce sera soit la constante GML ugc_result_success ou un autre nombre réel. Vous devriez donc vérifier cette constante pour vous assurer que l'appel a réussi et, dans le cas contraire, que quelque chose n'a pas fonctionné correctement. Le reste des valeurs possibles renvoyées sont affichées comme le résultat de la valeur Steam "EResult" et vous devriez voir steamclientpublic.h dans les en-têtes SDK pour toutes les 89 valeurs possibles.
4. 
   
5. " event_type " - Cette clé contiendra la valeur " ugc_download "
6. 
   
7. " original_filename " - Cette clé contient le nom d'origine du fichier image sur le serveur (une chaîne)
8. 
   
9. " dest_filename " - Cette clé contient le nom du fichier d'image que vous avez passé (une chaîne)
10. 
    
11. " ugc_handle " - Cette clé contient le ugc_handle valeur que vous avez passé à la fonction d'appel

Exemple étendu:

Dans cet exemple, nous appelons d'abord la fonction et stockons la valeur de l'identifiant asynchrone dans une variable:

steam_get = steam_ugc_download(steam_handle, "\UGC\Preview_file.png");

Cela enverrait alors une demande de fichier à l'API Steam, générant un événement asynchrone que nous traiterions comme suit:

var event_id = async_load[? "id"];
if event_id == steam_get
   {
   var type = async_load[? "event_type"];
   if type == "ugc_download"
      {
      sprite_delete(preview_sprite);       preview_sprite = sprite_add(async_load[? "dest_filename"], 0, false, false, 0, 0);
      }
   }

Le code ci-dessus vérifie le type d'événement, puis crée un sprite à partir de l'image téléchargée.