steam _ugc_send_query

Syntaxe:

steam_ugc_send_query(ugc_query_handle);


Argument La description
ugc_query_handle Le handle de requête à envoyer.


Renvoie: Boolean


La description

Cette fonction peut être utilisée pour envoyer une requête. Vous définissez d'abord la requête en utilisant le steam_ugc_create_query_*() fonctions qui retourneront un "handle de requête". Cette poignée est ensuite utilisée pour définir les filtres etc.... avant d'être utilisée dans cette fonction pour envoyer la requête. La fonction renvoie une valeur d'ID asynchrone unique qui peut être utilisée pour vérifier correctement les détails 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_query "

  4. " num_results " - Le nombre de résultats renvoyés (max 50)

  5. " total_matching " - Le nombre total de résultats correspondants

  6. " cached_data " - Indique si ces données ont été extraites du cache local sur le disque ou non (seront soit true ou false )

  7. " results_list " - Index d'index de liste DS, où chaque entrée de liste est un index de DS Map contenant les détails de l'élément particulier

Lorsque vous obtenez le type d'événement asynchrone "ugc_query", vous pouvez ensuite analyser la liste des résultats et extraire les informations suivantes de chacune des cartes DS (une carte par élément dans la liste):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  15. " tags " - Une chaîne contenant les tags de l'article, séparés par une virgule

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

  17. " 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)

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

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

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

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

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

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

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

  25. " 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:

var query_handle = steam_ugc_create_query_all(ugc_query_RankedByTrend, ugc_match_Items, 1);
steam_ugc_query_add_required_tag(query_handle, "RPG");
steam_ugc_query_set_return_long_description(query_handle, true);
steam_ugc_query_set_allow_cached_response(query_handle, true);
query_ID = steam_ugc_send_query(query_handle);

Le code ci-dessus crée une demande de requête et stocke son handle dans une variable locale pour une utilisation future dans le reste des fonctions qui définissent davantage la requête de requête avant d'envoyer la requête.