steam _ugc_request_item_details

Syntaxe:

steam_ugc_request_item_details(published_file_id, max_age_seconds);


Argument La description
published_file_id L'ID de fichier unique pour l'UGC à vérifier.
max_age_seconds L '"âge" des données à vérifier (recommandé 30 - 60 secondes).


Renvoie: Async ID


La description

Cette fonction peut être utilisée pour récupérer des informations sur un ID de fichier donné. Vous donnez l'ID de fichier et fournissez un âge maximum pour la vérification (voir les documents Steam pour plus d'informations), puis la fonction renvoie une valeur d'identifiant asynchrone unique qui peut être utilisée pour vérifier les détails correctement dans l'événement Steam Async. Cet événement aura le async_load Carte DS qui sera remplie avec les paires clé / valeur suivantes:

  1. " id " - L'identifiant asynchrone renvoyé par la fonction qui a déclenché l'événement

  2. " 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.

  3. " event_type " - La chaîne " ugc_item_details "

  4. " cached_data " - Sera true si les détails retournés proviennent du cache local ou false si elles sont prises du serveur

  5. " published_file_id" "-Faites l'id unique du fichier publié pour l'article

  6. " file_type " - Le type de fichier utilisé

  7. " creator_app_id " - L'identifiant Steam du créateur de l'objet

  8. " consumer_app_id " - L'identifiant Steam du consommateur de l'article

  9. " title " - Le titre de l'article

  10. " description " - La description de l'article

  11. " steam _id_owner " - L'identifiant Steam du propriétaire de l'objet

  12. " time_created " - L'heure à laquelle l'élément a été créé

  13. " time_updated " - La dernière fois que l'élément a été mis à jour

  14. " time_added_to_user_list " - Heure à laquelle l'élément a été abonné

  15. " visibility " - La visibilité de l'article (voir steam_ugc_set_item_visibility() pour les constantes renvoyées)

  16. " banni " - Si l'objet a été banni ( true ) ou pas ( false )

  17. " accepted_for_use " - Si l'article a été accepté pour utilisation ( true ) ou pas ( false )

  18. " tags_truncated " - Version courte des tags en tant que tableau

  19. " tags " - Un tableau des tags pour l'article

  20. " handle_file " - Le handle de fichier unique pour l'élément

  21. " handle_preview_file " - Le handle unique pour l'aperçu de l'image pour l'élément (peut être utilisé comme argument avec steam_ugc_download() télécharger une image d'aperçu)

  22. " filename " - Le nom du fichier d'élément

  23. " file_size " - La taille du fichier d'article

  24. " preview_file_size " - La taille de l'image d'aperçu

  25. " url " - L'URL complète de l'élément

  26. " votes_up " - Le nombre de votes reçus

  27. " votes_down " - Le nombre de votes négatifs reçus

  28. " score " - Le score global de l'objet

  29. " account_id_owner " - L'identifiant de compte du propriétaire de l'identifiant Steam (ceci peut être utilisé dans la fonction steam_ugc_create_query_user_ex() )


Exemple étendu:

Dans cet exemple, nous envoyons une demande de détails pour un article, puis analysons le résultat async_load DS carte pour définir certaines variables. D'abord nous envoyons de la demande:

steam_details = steam_ugc_request_item_details(global.fileID, 60);

Le code ci-dessus demandera des détails sur l'élément avec l'ID de fichier stocké dans la variable globale et déclenchera un événement Steam Async avec les informations renvoyées. Dans cet événement, nous pouvons ensuite analyser la carte et stocker certaines des valeurs dans des variables qui peuvent ensuite être utilisées pour afficher les informations à l'utilisateur:

var map_id = async_load[? "id"];
var result = async_load[? "result"];
if (map_id == steam_details) && (result == ugc_result_success)
   {
   mTitle = async_load[? "title"];
   mDesc = async_load[? "description"];
   mTags = async_load[? "tags"];
   m_hPreviewFile = async_load[? "handle_preview_file"];
   m_hOwnerSteamId = async_load[? "steam_id_owner"];
   mOwnerAccountId = async_load[? "account_id_owner"];
   mPubFileId = async_load[? "published_file_id"];
   mScore = async_load[? "score"];
   }