Cette section s'adresse aux utilisateurs qui ont accès à l'API Steam pour publier votre jeu sur cette plate-forme et qui souhaitent utiliser les possibilités offertes par Steam Workshop et Community pour ajouter et générer du contenu utilisateur dans vos projets. Certaines des fonctions de cette page requièrent l'identifiant de l'application Steam pour votre projet ainsi qu'un identifiant d'utilisateur pour la personne jouant au jeu ou son nom d'utilisateur, qui peut être trouvé en utilisant les fonctions suivantes:

• steam _get_app_id
  
• steam _get_user_account_id
  
• steam _get_user_persona_name
  

Avant d'utiliser l'une des fonctions intégrées de l'API Steam UGC, vous devez avoir configuré votre jeu correctement à partir du tableau de bord Steam et avoir lu la documentation requise: Partage du contenu généré par l'utilisateur (notez que vous devez avoir votre jeu accepté pour le réseau Steam et avoir accès aux zones de développement de la documentation de l'API Steam ). Tous les articles UGC abonnés seront téléchargés automatiquement par le client Steam, et vous devriez avoir du code dans l' événement Steam Asynchronous pour attraper ceci et stocker l'ID du UGC qui a été téléchargé pour être utilisé dans les autres fonctions UGC.

Le flux de travail normal pour intégrer le CGU dans votre jeu serait le suivant:

• L'utilisateur s'abonnerait à un élément (soit à partir de votre jeu en utilisant steam_ugc_subscribe_item() ou du client / navigateur.
  
  
• Votre jeu "écoutera" les nouveaux abonnements avec le code approprié dans l'événement Steam Async.
  
  
• Lorsque vous recevez un abonnement à un événement asynchrone, vous devez ensuite vérifier si l'élément est installé (c.-à-d. Téléchargé) avec steam_ugc_get_item_install_info().
  
  
• Si l'élément n'est pas installé, vous aurez besoin d'une vérification en utilisant steam_ugc_get_item_update_info() pour suivre la progression du téléchargement.

Les sections suivantes expliquent toutes les fonctions nécessaires au fonctionnement de l'UGC dans GameMaker Studio 2:

Création et modification de contenu

Les fonctions suivantes sont essentiellement des fonctions "wrapper" pour celles fournies dans l'API Steam pour créer et télécharger du contenu sur leurs serveurs. Par conséquent, nous vous recommandons de lire la documentation Steam liée avant de les utiliser pour mieux comprendre leur fonctionnement: Création et chargement de contenu.

• steam _ugc_create_item
  
• steam _ugc_start_item_update
  
• steam _ugc_set_item_title
  
• steam _ugc_set_item_description
  
• steam _ugc_set_item_visibility
  
• steam _ugc_set_item_tags
  
• steam _ugc_set_item_content
  
• steam _ugc_set_item_preview
  
• steam _ugc_submit_item_update
  
• steam _ugc_get_item_update_progress
  

Consommer du contenu

Une fois que votre contenu utilisateur a été créé et que l'atelier peut le télécharger, les utilisateurs peuvent s'y abonner via l'application Steam ou via le portail Web. Toutefois, GameMaker Studio 2 inclut également les fonctions suivantes pour utiliser l'API Steam pour créer et annuler des abonnements, ainsi que pour obtenir des informations sur les abonnements GameMaker Studio l'utilisateur est actuellement abonné:

• steam _ugc_subscribe_item
  
• steam _ugc_unsubscribe_item
  
• steam _ugc_num_subscribed_items
  
• steam _ugc_get_subscribed_items
  
• steam _ugc_get_item_install_info
  
• steam _ugc_get_item_update_info
  
• steam _ugc_request_item_details
  

Interroger le contenu

Il existe également un grand nombre de fonctions disponibles pour interroger l'API Steam sur les éléments UGC disponibles:

• steam _ugc_create_query_user
  
• steam _ugc_create_query_user_ex
  
• steam _ugc_create_query_all
  
• steam _ugc_create_query_all_ex
  
• steam _ugc_query_set_cloud_filename_filter
  
• steam _ugc_query_set_match_any_tag
  
• steam _ugc_query_set_search_text
  
• steam _ugc_query_set_ranked_by_trend_days
  
• steam _ugc_query_add_required_tag
  
• steam _ugc_query_add_excluded_tag
  
• steam _ugc_query_set_return_long_description
  
• steam _ugc_query_set_return_total_only
  
• steam _ugc_query_set_allow_cached_response
  
• steam _ugc_send_query
  

Vous pouvez obtenir une image d'aperçu de n'importe quel élément de l'UGC de l'atelier en utilisant la fonction steam_ugc_send_query() pour obtenir le handle du fichier de prévisualisation de l'image, puis en appelant la fonction suivante:

• steam _ugc_download