Documentación de Steamworks
Interfaz ISteamUGC
Funciones para crear, consumir e interactuar con Steam Workshop.

Funciones miembro

Las funciones miembro para ISteamUGC se llaman a través de la función de acceso global SteamUGC().

AddAppDependency

SteamAPICall_t AddAppDependency( PublishedFileId_t nPublishedFileID, AppId_t nAppID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo.
nAppIDAppId_tAplicación o contenido descargable que se requiere.

Agrega una dependencia entre el artículo en cuestión y el id. de aplicación. Esta lista de dependencias se puede recuperar llamando a GetAppDependencies. Se trata de una dependencia flexible que se muestra en la web. La aplicación determina si un artículo puede usarse o no.

Devuelve: SteamAPICall_t para usar con un resultado de la llamada AddAppDependencyResult_t.

Véase también: RemoveAppDependency

AddDependency

SteamAPICall_t AddDependency( PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID );
NombreTipoDescripción
nParentPublishedFileIDPublishedFileId_tEl artículo del Workshop al que se le agrega una dependencia.
nChildPublishedFileIDPublishedFileId_tLa dependencia para agregar al origen.

Agrega un artículo del Workshop como dependencia del artículo especificado. Si el artículo nParentPublishedFileID es de tipo k_EWorkshopFileTypeCollection, entonces nChildPublishedFileID simplemente se agrega a esa colección. De lo contrario, la dependencia no es fuerte y se muestra en el sitio web, y se puede recuperar a través de la API ISteamUGC usando una combinación de la variable miembro m_unNumChildren de la estructura SteamUGCDetails_t y GetQueryUGCChildren.

Devuelve: SteamAPICall_t para usar con un resultado de la llamada AddUGCDependencyResult_t.


Véase también: RemoveDependency

AddExcludedTag

bool AddExcludedTag( UGCQueryHandle_t handle, const char *pTagName );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
pTagNameconst char *La etiqueta NO debe estar asociada al CGU para recibirlo.

Agrega la etiqueta que se excluirá en una consulta de CGU pendiente. Solo devolverá el CGU que no tenga la etiqueta especificada.

NOTA: Esto debe establecerse antes de enviar un handle de consulta CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida, si el handle o identificador de consulta CGU es de CreateQueryUGCDetailsRequest, o pTagName era NULL (nulo).

Véase también: AddRequiredTag, SetMatchAnyTag, SetItemTags

AddItemKeyValueTag

bool AddItemKeyValueTag( UGCUpdateHandle_t handle, const char *pchKey, const char *pchValue );
NombreTipoDescripción
handleUGCUpdateHandle_tHandle de la actualización para un artículo del Workshop que se va a personalizar.
pchKeyconst char *La clave para establecer en el artículo.
pchValueconst char *Un valor para asignar a la clave.

Agrega un par clave-valor como etiqueta a un artículo. Se pueden asignar varios valores distintos a cada clave (relación de uno a varios).

Los nombres de las claves solo pueden usar caracteres alfanuméricos y el carácter "_".

Ni las claves ni los valores pueden superar los 255 caracteres de longitud.

Solo es posible buscar las etiquetas clave-valor por coincidencia exacta.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de UGC usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si la actualización del handle de UGC no es válida, si pchKey o pchValue no es válido, porque bien la clave o el valor devuelven NULL o han excedido la longitud máxima o si está intentando agregar más de 100 etiquetas de valor clave en una sola actualización.

Véase también: RemoveItemKeyValueTags, SetReturnKeyValueTags, GetQueryUGCNumKeyValueTags, GetQueryUGCKeyValueTag

AddItemPreviewFile

bool AddItemPreviewFile( UGCUpdateHandle_t handle, const char *pszPreviewFile, EItemPreviewType type );
NombreTipoDescripción
handleUGCUpdateHandle_tHandle de la actualización para un artículo del Workshop que se va a personalizar.
pszPreviewFileconst char *Ruta completa a la imagen local.
tipoEItemPreviewTypeEl tipo de esta vista previa.

Agrega un archivo de vista previa adicional para el artículo.

El formato de la imagen debe ser uno que tanto la web como la aplicación (de ser necesario) puedan representar, y su tamaño debe ser inferior a 1 MB. Algunos formatos sugeridos son JPG, PNG y GIF.

NOTA: El uso de k_EItemPreviewType_YouTubeVideo o k_EItemPreviewType_Sketchfab no era compatible con esta API en el momento de publicar esta documentación. Para los videos de YouTube, debes usar AddItemPreviewVideo.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de UGC usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si la actualización del handle o identificador de UGC no es válida.

Véase también: GetQueryUGCNumAdditionalPreviews, GetQueryUGCAdditionalPreview, SetReturnAdditionalPreviews, UpdateItemPreviewFile, AddItemPreviewVideo, RemoveItemPreview

AddItemPreviewVideo

bool AddItemPreviewVideo( UGCUpdateHandle_t handle, const char *pszVideoID );
NombreTipoDescripción
handleUGCUpdateHandle_tHandle de la actualización para un artículo del Workshop que se va a personalizar.
pszVideoIDconst char *Id. de video de YouTube para agregar. (por ejemplo, "jHgZh4GV9G0")

Agrega otra vista previa del video desde YouTube para el artículo.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de UGC usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de UGC no es válido.

Véase también: GetQueryUGCNumAdditionalPreviews, GetQueryUGCAdditionalPreview, SetReturnAdditionalPreviews, UpdateItemPreviewVideo, AddItemPreviewFile, RemoveItemPreview

AddItemToFavorites

SteamAPICall_t AddItemToFavorites( AppId_t nAppId, PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nAppIdAppId_tId. de la aplicación a la que pertenece este artículo.
nPublishedFileIDPublishedFileId_tEl artículo del Workshop que se agregará a la lista de favoritos del usuario.

Agrega un artículo del Workshop a la lista de favoritos del usuario.

Devuelve: SteamAPICall_t para usar con un resultado de la llamada UserFavoriteItemsListChanged_t.


Véase también: RemoveItemFromFavorites

AddRequiredKeyValueTag

bool AddRequiredKeyValueTag( UGCQueryHandle_t handle, const char *pKey, const char *pValue );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
pKeyconst char *Clave del par clave-valor que debe estar adjunta al CGU para recibirlo.
pValueconst char *El valor clave-valor asociado con pKey que se debe adjuntar al CGU para recibirlo.

Agrega la etiqueta clave-valor que se requerirá en una consulta de CGU pendiente. Esto solo devolverá los artículos del Workshop que tienen una clave = pKey y un valor = pValue.

NOTA: Esto debe establecerse antes de enviar un handle de consulta CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida o si pKey o pValue son NULL.

AddRequiredTag

bool AddRequiredTag( UGCQueryHandle_t handle, const char *pTagName );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
pTagNameconst char *La etiqueta debe estar asociada al CGU para recibirlo.

Agrega la etiqueta que se requerirá en una consulta de CGU pendiente. Solo devolverá el CGU que tenga la etiqueta especificada.

NOTA: Esto debe establecerse antes de enviar un handle de consulta CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida, si el handle o identificador de consulta CGU es de CreateQueryUGCDetailsRequest, o pTagName era NULL (nulo).

Véase también: AddExcludedTag, SetMatchAnyTag, SetItemTags

AddRequiredTagGroup

bool AddRequiredTagGroup( UGCQueryHandle_t handle, const SteamParamStringArray_t *pTags );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
pTagsconst SteamParamStringArray_t *Un conjunto de etiquetas donde al menos una de ellas debe estar asociada al CGU.

Agrega el requisito de que los artículos devueltos de la consulta de UGC pendientes tengan al menos una de las etiquetas en el conjunto dado ("o" lógica). Para cada grupo de etiquetas que se ha agregado, al menos una de las etiquetas de cada grupo deberá estar en los artículos que coincidan.

NOTA: Esto debe establecerse antes de enviar un handle de consulta CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false Si el identificador de la consulta de CGU no es válido, viene de llamar a CreateQueryUGCDetailsRequest o pTagName es NULL.

Véase también: AddRequiredTag, AddExcludedTag

BInitWorkshopForGameServer

bool BInitWorkshopForGameServer( DepotId_t unWorkshopDepotID, const char *pszFolder );
NombreTipoDescripción
unWorkshopDepotIDDepotId_tId. de repositorio del servidor de juego.
pszFolderconst char *La ruta absoluta en donde se va a almacenar el contenido de workshop.

Permite que los servidores del juego establezcan una carpeta del Workshop específica antes de emitir ningún comando de CGU.

Resulta útil si quieres permitir varios servidores de juego ejecutándose desde la misma carpeta de instalación.

Devuelve: bool
true si se ejecuta correctamente; de lo contrario, false si el usuario que realiza la llamada no es un servidor de juego o el Workshop está actualizando el contenido en ese momento.

CreateItem

SteamAPICall_t CreateItem( AppId_t nConsumerAppId, EWorkshopFileType eFileType );
NombreTipoDescripción
nConsumerAppIdAppId_tId. de aplicación que utilizará este artículo.
eFileTypeEWorkshopFileTypeTipo de CGU que se va a crear.

Crea un nuevo artículo del Workshop que aún no tiene contenido asociado.

Devuelve: SteamAPICall_t para usar con un resultado de la llamada CreateItemResult_t.


Véase también: Crear un artículo de Workshop

CreateQueryAllUGCRequest

UGCQueryHandle_t CreateQueryAllUGCRequest( EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint32 unPage );
NombreTipoDescripción
eQueryTypeEUGCQuerySe usa para especificar el orden y los filtros de esta llamada.
eMatchingeMatchingUGCTypeFileTypeEUGCMatchingUGCTypeSe usa para especificar el tipo de CGU que se consulta.
nCreatorAppIDAppId_tDebe contener el id. de aplicación en la que se creó el artículo. Puede ser diferente de nConsumerAppID si tu herramienta de creación de artículos tiene un id. de aplicación separado.
nConsumerAppIDAppId_tDebe contener el id. de aplicación del juego o la aplicación actuales. No se debe pasar el id. de aplicación de la herramienta con que se creó el artículo del Workshop si tiene un id. distinto.
unPageuint32Número de página de los resultados que se van a recibir. Debería comenzar por 1 en la primera llamada.

Consulta todo el CGU que coincida. Se puede usar para enumerar todo el CGU disponible para la aplicación.

Esto devolverá hasta 50 resultados según lo declarado por kNumUGCResultsPerPage. Puedes realizar llamadas posteriores a esta función, aumentando unPage cada vez para obtener el siguiente conjunto de resultados.

NOTA: ¡Tanto nConsumerAppID como nCreatorAppID deben tener un AppID válido!

NOTA: Debes liberar el identificador que devuelve esta función llamando a ReleaseQueryUGCRequest cuando hayas terminado con él.

Para consultar el CGU asociado con un solo usuario, puedes usar CreateQueryUserUGCRequest en su lugar.

Devuelve: UGCQueryHandle_t
Devuelve un nuevo UGCQueryHandle_t en caso de éxito y k_UGCQueryHandleInvalid en las siguientes situaciones:
  • Tanto nCreatorAppID como nConsumerAppID no están configurados para la aplicación actualmente en ejecución.
  • unPage era menos que 1.
  • Se produjo un error interno.

Este control se puede usar para personalizar aún más la consulta antes de enviarla con SendQueryUGCRequest.

Véase también: ISteamUtils::GetAppID

CreateQueryUGCDetailsRequest

UGCQueryHandle_t CreateQueryUGCDetailsRequest( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs );
NombreTipoDescripción
pvecPublishedFileIDPublishedFileId_t *Lista de artículos del Workshop cuyos detalles se van a obtener.
unNumPublishedFileIDsuint32El número de artículos en pvecPublishedFileID.

Consulta los detalles de artículos de CGU específicos. En estos momentos, solo se puede solicitar un máximo de 1000 artículos, pero este límite podría eliminarse en un futuro.

Nota: Esta API suele utilizarse para obtener y ver metadatos del contenido generado por el usuario, por lo que es preferible que la lista de artículos sea corta para que coincida con la IU. Los artículos suscritos deberían tener información suficiente para utilizarse, disponible mediante las API siguientes:

NOTA: ¡Tanto nConsumerAppID como nCreatorAppID deben tener un AppID válido!

NOTA: Cuando hayas terminado, llama a ReleaseQueryUGCRequest para liberar el handle que devuelve esta función.

Para consultar todos los CGU de tu aplicación, puedes usar CreateQueryAllUGCRequest en su lugar.

Devuelve: UGCQueryHandle_t.
Devuelve un nuevo UGCQueryHandle_t si se ejecuta correctamente y k_UGCQueryHandleInvalid en las siguientes situaciones:
  • unNumPublishedFileIDs es menor que 1.
  • Se produjo un error interno.

Este handle se puede usar para personalizar aún más la consulta antes de enviarla con SendQueryUGCRequest.

CreateQueryUserUGCRequest

UGCQueryHandle_t CreateQueryUserUGCRequest( AccountID_t unAccountID, EUserUGCList eListType, EUGCMatchingUGCType eMatchingUGCType, EUserUGCListSortOrder eSortOrder, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint32 unPage );
NombreTipoDescripción
unAccountIDAccountID_tId. de la cuenta para la que se consulta el CGU. Puedes usar CSteamID.GetAccountID para obtener el id. de cuenta de un id. de Steam.
eListTypeEUserUGCListSe utiliza para especificar el tipo de lista que se va a obtener.
Si el usuario que ha iniciado sesión actualmente es diferente al usuario especificado en unAccountID, no se permiten algunas opciones. (k_EUserUGCList_VotedOn, k_EUserUGCList_VotedUp, k_EUserUGCList_VotedDown, k_EUserUGCList_WillVoteLater, k_EUserUGCList_Subscribed)
eMatchingUGCTypeEUGCMatchingUGCTypeSe usa para especificar el tipo de CGU que se consulta.
eSortOrderEUserUGCListSortOrderSe usa para especificar el orden que tendrá la lista.
nCreatorAppIDAppId_tDebe contener el id. de la aplicación en la que se creó el artículo. Puede ser diferente de nConsumerAppID si tu herramienta de creación de artículos tiene un id. de aplicación separado.
nConsumerAppIDAppId_tDebe contener el id. de aplicación del juego o la aplicación actuales. No se debe pasar el id. de aplicación de la herramienta con que se creó el artículo del Workshop si tiene un id. distinto.
unPageuint32Número de página de los resultados que se van a recibir. Debería comenzar por 1 en la primera llamada.

Consulta de CGU asociada a un usuario. Se puede usar, entre otras cosas, para enumerar el CGU al que está suscrito el usuario.

Devuelve un máximo de 50 resultados según lo declarado por kNumUGCResultsPerPage. Puedes realizar llamadas posteriores a esta función, aumentando unPage cada vez para obtener el siguiente conjunto de resultados.

NOTA: ¡Tanto nConsumerAppID como nCreatorAppID deben tener un AppID válido!

NOTA: Cuando hayas terminado, llama a ReleaseQueryUGCRequest para liberar el handle que devuelve esta función.

Para consultar todos los CGU de tu aplicación, puedes usar CreateQueryAllUGCRequest en su lugar.

Devuelve: UGCQueryHandle_t.
Devuelve un nuevo UGCQueryHandle_t si se ejecuta correctamente y k_UGCQueryHandleInvalid en las siguientes situaciones:
  • nCreatorAppID o nConsumerAppID no está configurado para la aplicación actualmente en ejecución.
  • unPage era menos que 1.
  • El eListType dado solo es compatible para los usuarios que solicitan los detalles.
  • Se produjo un error interno.

Este handle se puede usar para personalizar aún más la consulta antes de enviarla con SendQueryUGCRequest.

Véase también: ISteamUtils::GetAppID

DeleteItem

SteamAPICall_t DeleteItem( PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo a eliminar.

Elimina el artículo sin pedir confirmación al usuario.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada DeleteItemResult_t.

DownloadItem

bool DownloadItem( PublishedFileId_t nPublishedFileID, bool bHighPriority );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo del Workshop para descargar.
bHighPriorityboolInicia la descarga en modo de alta prioridad, para lo que pone en pausa las descargas de Steam en curso y comienza inmediatamente a descargar este artículo del Workshop.

Descarga o actualiza un artículo del Workshop.

Si el valor devuelto es true (verdadero), regístrate y espera a la función callback DownloadItemResult_t antes de llamar a GetItemInstallInfo o acceder al artículo del Workshop en el disco.

Si la suscripción del usuario no incluye el artículo (por ejemplo, si es un servidor de juego que usa inicio de sesión anónimo), el artículo del Workshop se descargará y se guardará provisionalmente en la caché.

Si el estado del artículo del Workshop es k_EItemStateNeedsUpdate, se puede llamar a esta función para iniciar la actualización. No accedas al artículo del Workshop en el disco hasta que se llame a la función callback DownloadItemResult_t.

La función callback DownloadItemResult_t contiene el id. de aplicación asociado con el artículo del Workshop. Debería compararse con el id. de la aplicación en ejecución, ya que se llamará al controlador para todas las descargas de artículos, independientemente de la aplicación que se esté ejecutando.

Devuelve: bool.
Activa una función callback DownloadItemResult_t.
true si la descarga se inició con éxito; de lo contrario, false si nPublishedFileID no es válido o el usuario no ha iniciado sesión.

GetAppDependencies

bool GetAppDependencies( PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tArtículo del Workshop cuyas dependencias de aplicación se quieren obtener.

Obtiene las dependencias de aplicaciones asociadas con el PublishedFileId_t dado. Estas dependencias son dependencias "flexibles" que se muestran en la web. La aplicación determina si un artículo puede usarse o no.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada GetAppDependenciesResult_t.

Véase también: AddAppDependency, RemoveAppDependency

GetItemDownloadInfo

bool GetItemDownloadInfo( PublishedFileId_t nPublishedFileID, uint64 *punBytesDownloaded, uint64 *punBytesTotal );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo del Workshop para el que se obtiene la información de descarga.
punBytesDownloadeduint64 *Devuelve los bytes actuales descargados.
punBytesTotaluint64 *Devuelve el total de bytes. Solo es válido después de que haya empezado la descarga.

Obtiene información sobre una descarga pendiente de un artículo del Workshop que tiene k_EItemStateNeedsUpdate configurado.

Devuelve: bool
true si la información de la descarga estaba disponible; en caso contrario, false.

GetItemInstallInfo

bool GetItemInstallInfo( PublishedFileId_t nPublishedFileID, uint64 *punSizeOnDisk, char *pchFolder, uint32 cchFolderSize, uint32 *punTimeStamp );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo del Workshop para el que se obtiene la información de instalación.
punSizeOnDiskuint64 *Devuelve el tamaño del artículo del Workshop en bytes.
pchFolderchar *Devuelve la ruta de acceso absoluta a la carpeta que aloja el contenido copiándolo.
cchFolderSizeuint32El tamaño de pchFolder en bytes.
punTimeStampuint32 *Devuelve la fecha y hora en el que el artículo del Workshop se actualizó por última vez.

Obtiene información sobre el contenido instalado actualmente en el disco para los artículos del Workshop que tienen k_EItemStateInstalled configurado.

Al realizar esta llamada, el artículo del Workshop se marca como "used" (utilizado) para el jugador actual y se agrega a su lista k_EUserUGCList_UsedOrPlayed.

Si se establece k_EItemStateLegacyItem, pchFolder contiene la ruta al archivo heredado, no una carpeta.

Devuelve: bool
true si el artículo del Workshop ya está instalado.
false en los casos siguientes:
  • cchFolderSize es 0.
  • El artículo del Workshop no tiene contenido.
  • El artículo del Workshop no está instalado.

GetItemState

uint32 GetItemState( PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo del Workshop para el que se obtiene el estado.

Obtiene el estado actual de un artículo del Workshop en este cliente.

Devuelve: uint32.
Devuelve el estado del artículo. Debe utilizarse con los indicadores EItemState para determinar el estado del artículo del Workshop.

Ejemplo:
uint32 unItemState = GetItemState( 280762427 ); if ( unItemState & k_EItemStateDownloading ) { // indica que el artículo se está descargando al cliente } else if ( ( unItemState & k_EItemStateInstalled ) && ( unItemState & k_EItemStateNeedsUpdate ) ) { // indica que el artículo está instalado pero debe actualizarse }

GetItemUpdateProgress

EItemUpdateStatus GetItemUpdateProgress( UGCUpdateHandle_t handle, uint64 *punBytesProcessed, uint64*punBytesTotal );
NombreTipoDescripción
handleUGCUpdateHandle_tIdentificador o handle de actualización para el que obtener el progreso.
punBytesProcesseduint64 *Devuelve el número actual de bytes cargados.
punBytesTotaluint64 *Devuelve el número total de bytes que se cargarán.

Obtiene el progreso de la actualización de un artículo.

Devuelve: EItemUpdateStatus.
El estado actual.

Véase también: SubmitItemUpdate

GetNumSubscribedItems

uint32 GetNumSubscribedItems();
Obtiene el número total de artículos al que el usuario actual está suscrito para el juego o la aplicación.

Devuelve: uint32
Devuelve 0 si se llama desde un servidor de juegos.

GetQueryUGCAdditionalPreview

bool GetQueryUGCAdditionalPreview( UGCQueryHandle_t handle, uint32 index, uint32 previewIndex, char *pchURLOrVideoID, uint32 cchURLSize, char *pchOriginalFileName, uint32 cchOriginalFileNameSize, EItemPreviewType *pPreviewType );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
previewIndexuint32Índice de la vista previa adicional para el que se obtiene la información.
pchURLOrVideoIDchar *Devuelve una URL o id. de video al copiarla en esta cadena.
cchURLSizeuint32El tamaño de pchURLOrVideoID en bytes.
pchOriginalFileNamechar *Devuelve el nombre del archivo original. Puede establecerse en NULL para no recibir esto.
cchOriginalFileNameSizeuint32El tamaño de pchOriginalFileName en bytes.
pPreviewTypeEItemPreviewType *El tipo de vista previa devuelto.

Recupera la información de una vista previa adicional asociada con un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU.

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esto solo debe llamarse con el identificador obtenido de un resultado de llamada SteamUGCQueryCompleted_t exitoso.

Antes de realizar esta llamada, llama a GetQueryUGCNumAdditionalPreviews para obtener el número de vistas previas adicionales.

Devuelve: bool
true después de ejecutarse correctamente, indica que se han completado pchURLOrVideoID y pPreviewType.
De lo contrario, false si el handle de la consulta de CGU no es válido, o index o previewIndex están fuera de los límites.

GetQueryUGCChildren

bool GetQueryUGCChildren( UGCQueryHandle_t handle, uint32 index, PublishedFileId_t*pvecPublishedFileID, uint32 cMaxEntries );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
pvecPublishedFileIDPublishedFileId_t *Devuelve el CGU secundario estableciendo esta matriz.
cMaxEntriesuint32La longitud de pvecPublishedFileID.

Recupera los id. de todos los artículos secundarios de un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU. Estos artículos pueden ser parte de una colección o alguna otra dependencia (consulta AddDependency).

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esto solo debe llamarse con el handle obtenido de un resultado de llamada SteamUGCQueryCompleted_t exitoso.

Debes crear pvecPublishedFileID con m_unNumChildren proporcionado en SteamUGCDetails_t después de obtener los detalles CGU con GetQueryUGCResult.

Devuelve: bool
true después de la operación exitosa, se indica que pvecPublishedFileID se ha completado.
De lo contrario, false si la consulta del handle CGU no es válida o el index está fuera de los límites.

GetQueryUGCNumTags

uint32 GetQueryUGCNumTags( UGCQueryHandle_t handle, uint32 index );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.

Disponible en el SDK versión 1.51.

Recupera el número de etiquetas para un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU.

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esto solo debe llamarse con el identificador obtenido de un resultado de llamada SteamUGCQueryCompleted_t exitoso.

Luego puedes llamar a GetQueryUGCTag para obtener el nombre de etiqueta o a GetQueryUGCTagDisplayName para obtener el texto localizado de la etiqueta (en caso de haberlo).

Devuelve: uint32
El número de etiquetas de valor clave asociadas con el artículo del Workshop especificado.
Devuelve 0 si la consulta del CGU handle no es válida o si el index está fuera de los límites.

GetQueryUGCTag

bool GetQueryUGCTag( UGCQueryHandle_t handle, uint32 index, uint32 tagIndex, char *pchValue, uint32 cchValueSize );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
tagIndexuint32El índice de la etiqueta.
pchValuechar *Devuelve el valor al copiarlo en este string.
cchValueSizeuint32El tamaño de pchValue en bytes (asigna por lo menos 64 bytes).

Disponible en el SDK versión 1.51.

Recupera la etiqueta "nth" asociada con un artículo individual del Workshop tras recibir el resultado de una llamada de consulta del CGU.

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esto solo debe llamarse con el identificador obtenido de un resultado de llamada SteamUGCQueryCompleted_t exitoso.

Antes de llamar deberías llamar a GetQueryUGCNumTags para obtener el número de etiquetas.

GetQueryUGCTagDisplayName

bool GetQueryUGCTagDisplayName( UGCQueryHandle_t handle, uint32 index, uint32 tagIndex, char *pchValue, uint32 cchValueSize );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
tagIndexuint32El índice de la etiqueta.
pchValuechar *Devuelve el valor al copiarlo en este string.
cchValueSizeuint32El tamaño de pchValue en bytes (asigna por lo menos 256 bytes).

Disponible en el SDK versión 1.51.

Recupera la etiqueta "nth" del texto de visualización (por lo general, localizado), que está asociada con un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU.

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

AVISO: Esto solo debe llamarse con el identificador obtenido de un resultado de llamada SteamUGCQueryCompleted_t exitoso.

Antes de llamarlo deberías llamar a GetQueryUGCNumTags para obtener el número de etiquetas.

GetQueryUGCKeyValueTag

bool GetQueryUGCKeyValueTag( UGCQueryHandle_t handle, uint32 index, uint32 keyValueTagIndex, char *pchKey, uint32 cchKeySize, char *pchValue, uint32 cchValueSize );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
keyValueTagIndexuint32El índice de la etiqueta para el que se obtienen los detalles.
pchKeychar *Devuelve la clave al copiarla en este string.
cchKeySizeuint32El tamaño de pchKey en bytes.
pchValuechar *Devuelve el valor al copiarlo en este string.
cchValueSizeuint32El tamaño de pchValue en bytes.

Recupera los detalles de una etiqueta clave-valor asociada con un artículo del Workshop individual tras recibir el resultado de una llamada de consulta de CGU.

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esto solo debe llamarse con el identificador obtenido de un resultado de llamada SteamUGCQueryCompleted_t exitoso.

Antes de llamar a esto, debe llamar a GetQueryUGCNumKeyValueTags para obtener un número de etiquetas.

Devuelve: bool
true cuando se ejecuta correctamente, indica que pchKey y pchValue se han completado.
De lo contrario, false si el handle de la consulta de CGU no es válido, o index o keyValueTagIndex están fuera de los límites.

GetQueryUGCContentDescriptors

uint32 GetQueryUGCContentDescriptors( UGCQueryHandle_t handle, uint32 index, EUGCContentDescriptorID *pvecDescriptors, uint32 cMaxEntries );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
pvecDescriptorsEUGCContentDescriptorIDUna matriz de EUGCContentDescriptorID para completar.
cMaxEntriesuint32Tamaño de la matriz de pvecDescriptors.

Recupera una matriz de EUGCContentDescriptorID establecido en el artículo.

NOTA: Esta llamada debe realizarse solamente con el handle obtenido en el resultado de una llamada a SteamUGCQueryCompleted_t ejecutada correctamente.

Devuelve: uint32
Devuelve el número de EUGCContentDescriptorID establecido en el artículo.

Véase también: AddContentDescriptor, RemoveContentDescriptor

GetQueryUGCMetadata

bool GetQueryUGCMetadata( UGCQueryHandle_t handle, uint32 index, char *pchMetadata, uint32 cchMetadatasize );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
pchMetadatachar *Devuelve el URL copiándolo en esta cadena.
cchMetadatasizeuint32El tamaño de pchMetadata en bytes.

Recupera los metadatos establecidos por el desarrollador de un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU.

Realiza esta llamada en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esta llamada debe realizarse solamente con el handle obtenido en el resultado de una llamada a SteamUGCQueryCompleted_t ejecutada correctamente.

Devuelve: bool
true después de ejecutarse corectamente, indica que pchMetadata se ha completado.
De lo contrario, false si la consulta del handle CGU no es válida o el index está fuera de los límites.

Véase también: SetItemMetadata

GetQueryUGCNumAdditionalPreviews

uint32 GetQueryUGCNumAdditionalPreviews( UGCQueryHandle_t handle, uint32 index );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
indexuint32Índice del artículo para el que se obtiene la información.

Recupera el número de vistas previas adicionales de un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU.

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esto solo debe llamarse con el identificador obtenido de un resultado de llamada SteamUGCQueryCompleted_t ejecutada correctamente.

Luego puedes llamar a GetQueryUGCAdditionalPreview para obtener los detalles de cada vista previa adicional.

Devuelve: uint32
El número de vistas previas adicionales asociadas con el artículo del Workshop especificado.
Devuelve 0 si la consulta del CGU handle no es válida o si el index está fuera de los límites.

GetQueryUGCNumKeyValueTags

uint32 GetQueryUGCNumKeyValueTags( UGCQueryHandle_t handle, uint32 index );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.

Recupera el número de etiquetas clave-valor de un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU.

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esta llamada debe realizarse solamente con el handle obtenido en el resultado de una llamada a SteamUGCQueryCompleted_t ejecutada correctamente.

Luego puedes llamar a GetQueryUGCKeyValueTag para obtener los detalles de cada etiqueta.

Devuelve: uint32
El número de etiquetas de valor clave asociadas con el artículo del Workshop especificado.
Devuelve 0 si el handle de la consulta del CGU no es válido o si el index está fuera de los límites.

GetQueryUGCPreviewURL

bool GetQueryUGCPreviewURL( UGCQueryHandle_t handle, uint32 index, char *pchURL, uint32 cchURLSize );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
pchURLchar *Devuelve los metadatos copiándolo en esta cadena.
cchURLSizeuint32El tamaño de pchURL en bytes.

Recupera el URL de la imagen de vista previa de un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU.

Realiza esta llamada en bucle para obtener la información de todos los artículos del Workshop devueltos.

AVISO: Esta llamada debe realizarse solamente con el handle obtenido en el resultado de una llamada a SteamUGCQueryCompleted_t ejecutada correctamente.

Puedes usar esta URL para descargar y mostrar la imagen de la vista previa en lugar de tener que descargarla utilizando m_hPreviewFile en la estructura ISteamUGC::SteamUGCDetails_t.

Devuelve: bool
true después de ejecutarse correctamente, indica que pchURL se ha completado.
De lo contrario, false si la consulta del handle CGU no es válida o el index está fuera de los límites.

GetQueryUGCResult

bool GetQueryUGCResult( UGCQueryHandle_t handle, uint32 index, SteamUGCDetails_t *pDetails );
NombreTipoDescripción
handleUGCQueryHandle_tIdentificador o handle de consulta de CGU del que se obtienen los resultados.
índiceuint32Índice del artículo para el que se obtiene la información.
pDetailsSteamUGCDetails_t *Devuelve la información del CGU.

Recupera los detalles de un artículo del Workshop individual tras recibir el resultado de una llamada de consulta de CGU.

Deberá llamarse a esta función en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esto solo debe llamarse con el identificador obtenido de un resultado de llamada SteamUGCQueryCompleted_t ejecutada correctamente.

Devuelve: bool
true después de ejecutarse correctamente, indica que pDetails se ha completado.
De lo contrario, false si la consulta del handle CGU no es válida o el index está fuera de los límites.

GetQueryUGCStatistic

bool GetQueryUGCStatistic( UGCQueryHandle_t handle, uint32 index, EItemStatistic eStatType, uint64 *pStatValue );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU del que se obtienen los resultados.
indexuint32Índice del artículo del que se obtienen la información.
eStatTypeEItemStatisticEstadística que hay que recuperar.
pStatValueuint64 *Devuelve el valor asociado con la estadística especificada.

Recupera diversas estadísticas para un artículo individual del Workshop tras recibir el resultado de una llamada de consulta de CGU.

Realiza esta llamada en bucle para obtener la información de todos los artículos del Workshop devueltos.

NOTA: Esta llamada debe realizarse solamente con el handle obtenido en el resultado de una llamada a SteamUGCQueryCompleted_t ejecutada correctamente.

Devuelve: bool
true en caso de ejecutarse correctamente, indica que pStatValue se ha completado.
De lo contrario, false si la consulta del handle CGU no es válida, el index está fuera de los límites, o eStatType no fue válido.

GetSubscribedItems

uint32 GetSubscribedItems( PublishedFileId_t*pvecPublishedFileID, uint32 cMaxEntries );
NombreTipoDescripción
pvecPublishedFileIDPublishedFileId_t *La matriz en la que se copiarán los identificadores de los artículos.
cMaxEntriesuint32El número máximo de artículos a devolver. Normalmente debería ser el mismo que GetNumSubscribedItems y del mismo tamaño que pvecPublishedFileID.

Obtiene una lista de todos los artículos a los que el usuario actual está suscrito en el juego actual.

Antes de realizar esta llamada, se crea una matriz con el tamaño proporcionado por GetNumSubscribedItems.

Devuelve: uint32.
La cantidad de artículos del Workshop suscritos que se agregaron a pvecPublishedFileID.
Devuelve 0 si se llama desde un servidor de juegos.

GetUserItemVote

SteamAPICall_t GetUserItemVote( PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl id. del artículo del Workshop para que los usuarios voten.

Obtiene el estado del voto del usuario en un artículo del Workshop.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada GetUserItemVoteResult_t.


Véase también: SetUserItemVote

ReleaseQueryUGCRequest

bool ReleaseQueryUGCRequest( UGCQueryHandle_t handle );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU que se va a liberar.

Libera el handle de una consulta de CGU al terminar de utilizarlo para liberar espacio en la memoria.

Devuelve: bool.
Siempre devuelve true.

RemoveAppDependency

SteamAPICall_t RemoveAppDependency( PublishedFileId_t nPublishedFileID, AppId_t nAppID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo.
nAppIDAppId_tLa aplicación o el DLC.

Elimina la dependencia entre el artículo en cuestión y el id. de aplicación. Esta lista de dependencias se puede recuperar llamando a GetAppDependencies.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada RemoveAppDependencyResult_t.

Véase también: AddAppDependency

RemoveDependency

SteamAPICall_t RemoveDependency( PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID );
NombreTipoDescripción
nParentPublishedFileIDPublishedFileId_tEl artículo del Workshop para el que se elimina una dependencia.
nChildPublishedFileIDPublishedFileId_tLa dependencia a eliminar del artículo principal.

Elimina un artículo del Workshop como dependencia del artículo especificado.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a RemoveUGCDependencyResult_t.


Véase también: AddDependency

RemoveItemFromFavorites

SteamAPICall_t RemoveItemFromFavorites( AppId_t nAppId, PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nAppIdAppId_tEl id. de aplicación al que pertenece este artículo.
nPublishedFileIDPublishedFileId_tEl artículo del workshop a eliminar de la lista de favoritos del usuario.

Elimina un artículo del workshop de la lista de favoritos del usuario.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a UserFavoriteItemsListChanged_t.


Véase también: AddItemToFavorites

RemoveItemKeyValueTags

bool RemoveItemKeyValueTags( UGCUpdateHandle_t handle, const char *pchKey );
NombreTipoDescripción
handleUGCUpdateHandle_tEl handle de actualización del artículo del Workshop que se va a personalizar.
pchKeyconst char *La clave que se eliminará del artículo.

Elimina una etiqueta clave-valor existente de un artículo.

Solo puede llamarse a esta función 100 veces por cada actualización de artículo. Si necesitas eliminar más etiquetas de las que necesitas, tendrás que realizar actualizaciones subsecuentes del artículo.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido o si intentas eliminar más de 100 etiquetas clave-valor en una sola actualización.

Véase también: AddItemKeyValueTag

RemoveItemPreview

bool RemoveItemPreview( UGCUpdateHandle_t handle, uint32 index );
NombreTipoDescripción
handleUGCUpdateHandle_t
indexuint32

Devuelve: bool

AddContentDescriptor

bool AddContentDescriptor( UGCUpdateHandle_t handle, EUGCContentDescriptorID descid );
NombreTipoDescripción
handleUGCUpdateHandle_t
descidEUGCContentDescriptorID

Establece el EUGCContentDescriptorID dado en el artículo.

Devuelve: bool

Véase también: GetQueryUGCContentDescriptors, RemoveContentDescriptor

RemoveContentDescriptor

bool RemoveContentDescriptor( UGCUpdateHandle_t handle, EUGCContentDescriptorID descid );
NombreTipoDescripción
handleUGCUpdateHandle_t
descidEUGCContentDescriptorID

Elimina el EUGCContentDescriptorID dado del artículo.

Devuelve: bool

Véase también: GetQueryUGCContentDescriptors, AddContentDescriptor

RequestUGCDetails

SteamAPICall_t RequestUGCDetails( PublishedFileId_t nPublishedFileID, uint32 unMaxAgeSeconds );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_t¡Obsoleto!
unMaxAgeSecondsuint32¡Obsoleto!

OBSOLETO! Usa CreateQueryUGCDetailsRequest en su lugar.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada SteamUGCRequestUGCDetailsResult_t.

SendQueryUGCRequest

SteamAPICall_t SendQueryUGCRequest( UGCQueryHandle_t handle );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU que se envía.

Envía una consulta de CGU a Steam.

Esta llamada debe realizarse solamente con el handle obtenido en el resultado de una llamada a CreateQueryUserUGCRequest, CreateQueryAllUGCRequest o CreateQueryUGCDetailsRequest para enviar la solicitud a Steam. Antes de realizar esta llamada, utiliza una o varias de las API siguientes para personalizar la consulta:
AddRequiredTag, AddExcludedTag, SetReturnOnlyIDs, SetReturnKeyValueTags, SetReturnLongDescription, SetReturnMetadata, SetReturnChildren, SetReturnAdditionalPreviews, SetReturnTotalOnly, SetLanguage, SetAllowCachedResponse, SetCloudFileNameFilter, SetMatchAnyTag, SetSearchText, SetRankedByTrendDays, AddRequiredKeyValueTag

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada SteamUGCQueryCompleted_t.
Devuelve k_uAPICallInvalid si el handle de la consulta de CGU no es válido.

SetAllowCachedResponse

bool SetAllowCachedResponse( UGCQueryHandle_t handle, uint32 unMaxAgeSeconds );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU que se va a personalizar.
unMaxAgeSecondsuint32Tiempo máximo que se puede tardar en devolver un artículo sin una invalidación de la memoria caché.

Establece si los resultados se devolverán desde la memoria caché para el período de tiempo específico de una consulta de CGU pendiente.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida.

SetCloudFileNameFilter

bool SetCloudFileNameFilter( UGCQueryHandle_t handle, const char *pMatchCloudFileName );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU que se va a personalizar.
pMatchCloudFileNameconst char *El nombre de archivo que debe coincidir.

Se establece para que devuelva únicamente los artículos que tengan un nombre de archivo específico en una consulta de CGU pendiente.

NOTA: Solo se puede usar con CreateQueryUserUGCRequest.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de consulta de CGU no es válido o no proviene de CreateQueryUserUGCRequest, o si pMatchCloudFileName es NULL.

SetItemContent

bool SetItemContent( UGCUpdateHandle_t handle, const char *pszContentFolder );
NombreTipoDescripción
handleUGCUpdateHandle_tHandle de la actualización para un artículo del Workshop que se va a personalizar.
pszContentFolderconst char *Ruta absoluta a una carpeta local con el contenido para el artículo.

Establece la carpeta que se almacenará como contenido para un artículo.

Para una carga y descarga eficientes, los archivos no deben estar combinados o comprimidos en un solo archivo (p. ej., archivos zip).

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido.

SetItemDescription

bool SetItemDescription( UGCUpdateHandle_t handle, const char *pchDescription );
NombreTipoDescripción
handleUGCUpdateHandle_tHandle de la actualización para un artículo del Workshop que se va a personalizar.
pchDescriptionconst char *La nueva descripción del artículo.

Establece una nueva descripción para un artículo.

La descripción debe limitarse a la longitud definida por k_cchPublishedDocumentDescriptionMax.

Puedes configurar el idioma para el que se usa con SetItemUpdateLanguage; si no se establece ningún idioma, "inglés" será el idioma predeterminado.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido.

Véase también: SetReturnLongDescription

SetItemMetadata

bool SetItemMetadata( UGCUpdateHandle_t handle, const char *pchMetaData );
NombreTipoDescripción
handleUGCUpdateHandle_tHandle de la actualización para un artículo del Workshop que se va a personalizar.
pchMetaDataconst char *Los nuevos metadatos para este artículo.

Establece metadatos arbitrarios para un artículo. Estos metadatos pueden devolverse mediante consultas sin tener que descargar e instalar el contenido en sí.

Los metadatos deben limitarse al tamaño definido por k_cchDeveloperMetadataMax.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido o si pchMetadata es más largo que k_cchDeveloperMetadataMax.

Véase también: SetReturnMetadata

SetItemPreview

bool SetItemPreview( UGCUpdateHandle_t handle, const char *pszPreviewFile );
NombreTipoDescripción
handleUGCUpdateHandle_tHandle de la actualización para un artículo del Workshop que se va a personalizar.
pszPreviewFileconst char *Ruta absoluta a un archivo de imagen de la vista previa local para el artículo.

Establece la imagen de vista previa principal para el artículo.

El formato debe ser compatible tanto con la web como con la aplicación (si es necesario). Algunos formatos sugeridos son JPG, PNG y GIF.

Asegúrate de que tu aplicación tenga establecidos la cuota y el número de archivos para Steam Cloud, ya que las imágenes de vista previa se guardan en la nube del usuario. Si tu aplicación no tiene valores establecidos para Steam Cloud, esta llamada fallará.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido.

SetItemTags

bool SetItemTags( UGCUpdateHandle_t updateHandle, const SteamParamStringArray_t *pTags );
NombreTipoDescripción
updateHandleUGCUpdateHandle_tHandle de la actualización para un artículo del Workshop que se va a personalizar.
pTagsconst SteamParamStringArray_t *Lista de etiquetas para establecer en este artículo.

Establece en un artículo etiquetas arbitrarias especificadas por el desarrollador.

Las etiquetas no pueden tener más de 255 caracteres. Los nombres de las etiquetas solo pueden incluir caracteres imprimibles (no se incluyen las comas). Para ver qué caracteres están permitidos, consulta http://es.cppreference.com/w/c/string/byte/isprint.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido o si alguna etiqueta no es válida por superar la longitud máxima o por ser NULL.

Véase también: AddRequiredTag, AddExcludedTag, SetMatchAnyTag

SetItemTitle

bool SetItemTitle( UGCUpdateHandle_t handle, const char *pchTitle );
NombreTipoDescripción
handleUGCUpdateHandle_tEl handle de actualización del artículo del Workshop que se va a personalizar.
pchTitleconst char *El nuevo título del artículo.

Establece un nuevo título para un artículo.

El título debe limitarse al tamaño definido por k_cchPublishedDocumentTitleMax.

Puedes configurar el idioma para el que se usa con SetItemUpdateLanguage; si no se establece ningún idioma, "inglés" será el idioma predeterminado.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido.

SetItemUpdateLanguage

bool SetItemUpdateLanguage( UGCUpdateHandle_t handle, const char *pchLanguage );
NombreTipoDescripción
handleUGCUpdateHandle_tEl handle de actualización del artículo del Workshop que se va a personalizar.
pchLanguageconst char *Idioma del título y la descripción que se establecerán en esta actualización.

Determina el idioma del título y la descripción que se establecerá en esta actualización del artículo.

Debe estar en el formato del Código de idioma de la API.

Si no se establece, "inglés" será el idioma predeterminado.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido.

Véase también: SetItemTitle, SetItemDescription, SetLanguage

SetItemVisibility

bool SetItemVisibility( UGCUpdateHandle_t handle, ERemoteStoragePublishedFileVisibility eVisibility );
NombreTipoDescripción
handleUGCUpdateHandle_tEl handle de actualización del artículo del Workshop que se va a personalizar.
eVisibilityERemoteStoragePublishedFileVisibilityLa visibilidad que se va a configurar.

Establece la visibilidad de un artículo.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido.

SetLanguage

bool SetLanguage( UGCQueryHandle_t handle, const char *pchLanguage );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
pchLanguageconst char *El idioma en que se devuelve.

Establece el idioma en el que devolver el título y la descripción de los artículos de una consulta de CGU pendiente.

Debe estar en el formato del código de idioma de la API.

Si no se establece, "inglés" será el idioma predeterminado.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida.

Véase también: SetItemUpdateLanguage

SetMatchAnyTag

bool SetMatchAnyTag( UGCQueryHandle_t handle, bool bMatchAnyTag );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
bMatchAnyTagbool¿Debería el artículo simplemente tener una etiqueta requerida (true) o todas? (false)

Establece si se devuelven artículos del Workshop con una o más etiquetas que coincidan, o si es necesario que coincidan todas las etiquetas de una consulta de CGU pendiente.

NOTA: Esto solo se puede usar con CreateQueryAllUGCRequest.

NOTA: Esto debe establecerse antes de enviar un handle de consulta CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la consulta de CGU no es válido o no proviene de CreateQueryAllUGCRequest.

Véase también: AddRequiredTag, AddExcludedTag, SetItemTags

SetRankedByTrendDays

bool SetRankedByTrendDays( UGCQueryHandle_t handle, uint32 unDays );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
unDaysuint32Establece el número de días para valorar los artículos. Los valores válidos son del 1 al 365, ambos incluidos.

Establece si el orden de los resultados se actualizará en función de la valoración de artículos a lo largo de un número de días en una consulta de CGU pendiente.

NOTA: Esto solo se puede usar con CreateQueryAllUGCRequest.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de consulta de CGU no es válido o no proviene de CreateQueryAllUGCRequest, o si el valor EUGCQuery de la consulta no es alguno de estos:
k_PublishedFileQueryType_RankedByTrend, k_PublishedFileQueryType_RankedByPlaytimeTrend, k_PublishedFileQueryType_RankedByAveragePlaytimeTrend, k_PublishedFileQueryType_RankedByVotesUp o k_PublishedFileQueryType_RankedByPlaytimeSessionsTrend

SetReturnAdditionalPreviews

bool SetReturnAdditionalPreviews( UGCQueryHandle_t handle, bool bReturnAdditionalPreviews );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
bReturnAdditionalPreviewsbool¿Devolver las previsualizaciones adicionales para los artículos?

Establece si se devuelve cualquier imagen o video adicional adjunto a los artículos en una consulta de CGU pendiente.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida.

SetReturnChildren

bool SetReturnChildren( UGCQueryHandle_t handle, bool bReturnChildren );
NombreTipoDescripción
handleUGCQueryHandle_tEl identificador de consulta CGU para personalizar.
bReturnChildrenbool¿Devolver los identificadores de secundarios de los artículos?

Establece si se devuelven los identificadores de artículos secundarios del artículo en una consulta de CGU pendiente.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida.

SetReturnKeyValueTags

bool SetReturnKeyValueTags( UGCQueryHandle_t handle, bool bReturnKeyValueTags );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta CGU para personalizar.
bReturnKeyValueTagsbool¿Devolver alguna etiqueta clave-valor para los artículos?

Establece si se devuelve cualquier etiqueta clave-valor para los artículos en una consulta de CGU pendiente.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida.

SetReturnLongDescription

bool SetReturnLongDescription( UGCQueryHandle_t handle, bool bReturnLongDescription );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta CGU para personalizar.
bReturnLongDescriptionbool¿Devolver la descripción larga para los artículos?

Establece si se devuelve la descripción completa de los artículos en una consulta de CGU pendiente.

Si no se establece este valor, únicamente se recibe el resumen, que es una descripción truncada en los 255 bytes.

NOTA: esto debe establecerse antes de enviar un handle de consulta CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida.

Véase también: SetItemDescription

SetReturnMetadata

bool SetReturnMetadata( UGCQueryHandle_t handle, bool bReturnMetadata );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta CGU para personalizar.
bReturnMetadatabool¿Devolver los metadatos para los artículos?

Establece si se devuelven los metadatos especificados por el desarrollador para los artículos en una consulta de CGU pendiente.

NOTA: esto debe establecerse antes de enviar un handle de consulta CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida.

Véase también: SetItemMetadata

SetReturnOnlyIDs

bool SetReturnOnlyIDs( UGCQueryHandle_t handle, bool bReturnOnlyIDs );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta CGU para personalizar.
bReturnOnlyIDsbool¿Devolver solo el id. de los artículos?

Establece si solo se devuelven identificadores, en vez de todos los detalles de una consulta de CGU pendiente.

Es útil cuando no se necesita toda la información (por ejemplo, si solo se quieren obtener los identificadores de los artículos que un usuario tiene en su lista de favoritos).

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la consulta de CGU no es válido o proviene de CreateQueryUGCDetailsRequest.

SetReturnPlaytimeStats

bool SetReturnPlaytimeStats( UGCQueryHandle_t handle, uint32 unDays );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU que se va a personalizar.
unDaysuint32El número de días de estadísticas de tiempo de juego que se devuelven.

Establece si se devuelven las estadísticas de tiempo de juego en una consulta de CGU pendiente.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si la consulta de CGU handle no es válida.

SetReturnTotalOnly

bool SetReturnTotalOnly( UGCQueryHandle_t handle, bool bReturnTotalOnly );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU que se va a personalizar.
bReturnTotalOnlybool¿Devolver solo el número total de artículos?

Establece si se devuelve solo el número total de artículos que coinciden en una consulta de CGU pendiente.

Cuando se llama a SteamUGCQueryCompleted_t, no se devuelven los artículos en sí.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de consulta de CGU no es válido o proviene de CreateQueryUGCDetailsRequest.

SetSearchText

bool SetSearchText( UGCQueryHandle_t handle, const char *pSearchText );
NombreTipoDescripción
handleUGCQueryHandle_tEl handle de consulta de CGU que se va a personalizar.
pSearchTextconst char *El texto que se busca.

Establece una cadena con la que los artículos deben coincidir, ya sea en el título o en la descripción, en una consulta de CGU pendiente.

NOTA: Esto solo se puede usar con CreateQueryAllUGCRequest.

NOTA: Esto debe establecerse antes de enviar un handle de consulta de CGU usando SendQueryUGCRequest.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de consulta de CGU no es válido o no proviene de CreateQueryAllUGCRequest, o si pSearchText es NULL.

SetUserItemVote

SteamAPICall_t SetUserItemVote( PublishedFileId_t nPublishedFileID, bool bVoteUp );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl id. del artículo del Workshop por el que se vota.
bVoteUpbool¿Votar arriba (true) o abajo (false)?

Permite al usuario valorar un artículo del Workshop de forma positiva o negativa.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a SetUserItemVoteResult_t.


Véase también: GetUserItemVote

StartItemUpdate

UGCUpdateHandle_t StartItemUpdate( AppId_t nConsumerAppId, PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nConsumerAppIdAppId_tId. de aplicación que utilizará este artículo.
nPublishedFileIDPublishedFileId_tEl artículo que se actualizará.

Comienza el proceso de actualización del artículo.

Te proporciona un handle que puedes usar para modificar el artículo antes de enviar finalmente la actualización al servidor con SubmitItemUpdate.

Devuelve: UGCUpdateHandle_t
Un handle que se puede usar con llamadas posteriores para modificar el artículo antes de enviar finalmente la actualización.

Véase también: Subir un artículo de Workshop, SetItemTitle, SetItemDescription, SetItemUpdateLanguage, SetItemMetadata, SetItemVisibility, SetItemTags, SetItemContent, SetItemPreview, RemoveItemKeyValueTags, AddItemKeyValueTag, AddItemPreviewFile, AddItemPreviewVideo, UpdateItemPreviewFile, UpdateItemPreviewVideo, RemoveItemPreview

StartPlaytimeTracking

SteamAPICall_t StartPlaytimeTracking( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs );
NombreTipoDescripción
pvecPublishedFileIDPublishedFileId_t *La matriz de artículos del Workshop de los que se quiere empezar a hacer seguimiento. (Máximo de 100 artículos).
unNumPublishedFileIDsuint32El número de artículos en pvecPublishedFileID.

Comienza el seguimiento del tiempo de juego de un conjunto de artículos del Workshop.

Cuando la aplicación se cierra, el seguimiento del tiempo de juego se detiene automáticamente.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada StartPlaytimeTrackingResult_t.
Devuelve k_uAPICallInvalid si pvecPublishedFileID es NULL o unNumPublishedFileIDs es menor que 1 o mayor que 100.

Véase también: StopPlaytimeTracking, StopPlaytimeTrackingForAllItems

StopPlaytimeTracking

SteamAPICall_t StopPlaytimeTracking( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs );
NombreTipoDescripción
pvecPublishedFileIDPublishedFileId_t *La matriz de artículos del Workshop de los que se quiere empezar a hacer seguimiento. (Máximo de 100 artículos).
unNumPublishedFileIDsuint32El número de artículos en pvecPublishedFileID.

Detiene el seguimiento del tiempo de juego de un conjunto de artículos del Workshop.

Cuando la aplicación se cierra, el seguimiento del tiempo de juego se detiene automáticamente.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada StopPlaytimeTrackingResult_t.

StopPlaytimeTrackingForAllItems

SteamAPICall_t StopPlaytimeTrackingForAllItems();
Detiene el seguimiento del tiempo de juego de todos los artículos del Workshop.

Cuando la aplicación se cierra, el seguimiento del tiempo de juego se detiene automáticamente.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada StopPlaytimeTrackingResult_t.
Devuelve k_uAPICallInvalid si pvecPublishedFileID es NULL o unNumPublishedFileIDs es menor que 1 o mayor que 100.

GetAppDependencies

SteamAPICall_t GetAppDependencies( PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo.

Devuelve todas las dependencias de la aplicación que estén asociadas con el artículo correspondiente.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a GetAppDependenciesResult_t.

SubmitItemUpdate

SteamAPICall_t SubmitItemUpdate( UGCUpdateHandle_t handle, const char *pchChangeNote );
NombreTipoDescripción
handleUGCUpdateHandle_tHandle de actualización que se va a enviar.
pchChangeNoteconst char *Una breve descripción de los cambios realizados. (Opcional, establecido en NULL para ninguna nota de cambio)

Carga los cambios realizados en un artículo en Steam Workshop.

Puedes seguir el progreso de la actualización de un artículo con GetItemUpdateProgress.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a SubmitItemUpdateResult_t.
Devuelve k_uAPICallInvalid si el handle no es válido.

SubscribeItem

SteamAPICall_t SubscribeItem( PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo del Workshop al que suscribirse.

Suscribe a un artículo del Workshop. Se descargará e instalará en cuanto sea posible.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a RemoteStorageSubscribePublishedFileResult_t.


Véase también: SubscribeItem

SuspendDownloads

void SuspendDownloads( bool bSuspend );
NombreTipoDescripción
bSuspendbool¿Suspender (true) o Reanudar (false) descargas del Workshop?

Suspende y reanuda todas las descargas del Workshop.

Si llamas a esto con bSuspend establecido como true, las descargas se suspenderán hasta que las reanudes estableciendo bSuspend como false o cuando el juego termina.

UnsubscribeItem

SteamAPICall_t UnsubscribeItem( PublishedFileId_t nPublishedFileID );
NombreTipoDescripción
nPublishedFileIDPublishedFileId_tEl artículo del Workshop del que se anula la suscripción.

Anula la suscripción a un artículo del Workshop. El artículo se eliminará tras salir del juego.

Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a RemoteStorageUnsubscribePublishedFileResult_t.


Véase también: UnsubscribeItem

UpdateItemPreviewFile

bool UpdateItemPreviewFile( UGCUpdateHandle_t handle, uint32 index, const char *pszPreviewFile );
NombreTipoDescripción
handleUGCUpdateHandle_tEl handle de actualización del artículo del Workshop que se va a personalizar.
indexuint32El índice del archivo de vista previa de 0 a GetQueryUGCNumAdditionalPreviews.
pszPreviewFileconst char *Ruta completa a la imagen local.

Actualiza un archivo de vista previa adicional existente para el artículo.

Si el tipo de vista previa es una imagen, el formato debe ser compatible tanto con la web como con la aplicación (si es necesario) y el tamaño debe ser inferior a 1 MB. Algunos formatos sugeridos son JPG, PNG y GIF.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente,
false si el handle de la actualización de CGU no es válido.

Véase también: AddItemPreviewFile

UpdateItemPreviewVideo

bool UpdateItemPreviewVideo( UGCUpdateHandle_t handle, uint32 index, const char *pszVideoID );
NombreTipoDescripción
handleUGCUpdateHandle_tEl handle de actualización del artículo del Workshop que se va a personalizar.
indexuint32El índice del archivo de vista previa de 0 a GetQueryUGCNumAdditionalPreviews.
pszVideoIDconst char *El video de YouTube que se va a agregar. (por ejemplo, "jHgZh4GV9G0").

Actualiza otra vista previa del video desde YouTube para el artículo.

NOTA: Esto debe establecerse antes de enviar el handle de actualización de CGU usando SubmitItemUpdate.

Devuelve: bool
true si se ejecuta correctamente.
false si el handle de la actualización de CGU no es válido.

Véase también: AddItemPreviewVideo

ShowWorkshopEULA

bool ShowWorkshopEULA();

Muestra a los usuarios el ALUF del Workshop más reciente de la aplicación en una ventana superpuesta, en la que pueden aceptarlo o no.

Devuelve: bool
true si se ejecuta correctamente,
false si no se puede mostrar la ventana superpuesta.

Véase también: GetWorkshopEULAStatus

GetWorkshopEULAStatus

SteamAPICall_t GetWorkshopEULAStatus();

Obtiene datos de forma asíncrona sobre la aceptación del ALUF del Workshop por parte del usuario para la aplicación actual.

Devuelve: SteamAPICall_t

Véase también: WorkshopEULAStatus_t, ShowWorkshopEULA

Callbacks

Estas son funciones callback que pueden activarse llamando a SteamAPI_RunCallbacks. Muchas de estas se activarán directamente en respuesta a las funciones miembro de ISteamUGC.

AddAppDependencyResult_t

El resultado de una llamada a AddAppDependency.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_tArtículo principal del Workshop al que se agregó la dependencia.
m_nAppIDAppId_tLa aplicación o el DLC.

Funciones asociadas: AddAppDependency

AddUGCDependencyResult_t

El resultado de una llamada a AddDependency.

NombreTipoDescripción
m_eResultEResultEl resultado de la operación.
m_nPublishedFileIdPublishedFileId_tArtículo principal del Workshop al que se agregó la dependencia.
m_nChildPublishedFileIdPublishedFileId_tEl artículo secundario del Workshop que se agregó como dependencia al artículo principal.

Funciones asociadas: AddDependency

CreateItemResult_t

Se llama cuando se ha creado un nuevo artículo del Workshop.

NombreTipoDescripción
m_eResultEResultResultado de la operación. Algunos de los posibles valores devueltos son:
  • k_EResultOK: la operación se completó con éxito.
  • k_EResultInsufficientPrivilege: el usuario actualmente no puede cargar contenido debido a un bloqueo en los puntos de encuentro, un bloqueo de la cuenta o un bloqueo de la comunidad. Necesitan contactar con el Soporte de Steam.
  • k_EResultBanned - El usuario no tiene permiso para cargar contenido en este punto de encuentro porque tiene un VAC activo o un bloqueo en el juego.
  • k_EResultTimeout: la operación duró más tiempo de lo esperado. Pídele al usuario que vuelva a intentar el proceso de creación.
  • k_EResultNotLoggedOn: el usuario no ha iniciado sesión actualmente en Steam.
  • k_EResultServiceUnavailable: el servidor del Workshop que aloja el contenido tiene problemas. Pídele al usuario que vuelva a intentarlo.
  • k_EResultInvalidParam: uno de los campos de envío contiene algo que no está siendo aceptado por ese campo.
  • k_EResultAccessDenied: hubo un problema al intentar guardar el título y la descripción. Acceso denegado.
  • k_EResultLimitExceeded: el usuario ha excedido su cuota en Steam Cloud. Pídele que quite algunos artículos y lo intente de nuevo.
  • k_EResultFileNotFound: no se ha podido encontrar el archivo cargado.
  • k_EResultDuplicateRequest: el archivo ya se cargó correctamente. El usuario solo necesita actualizar.
  • k_EResultDuplicateName: el usuario ya tiene un artículo en el Workshop de Steam con ese nombre.
  • k_EResultServiceReadOnly: debido a un cambio reciente de contraseña o de correo electrónico, el usuario no tiene permiso para cargar contenido nuevo. Por lo general, esta restricción expirará en 5 días, pero puede durar hasta 30 días si la cuenta ha estado inactiva recientemente.
m_nPublishedFileIdPublishedFileId_tId. único del nuevo artículo.
m_bUserNeedsToAcceptWorkshopLegalAgreementbool¿El usuario debe aceptar el acuerdo legal de Steam Workshop (true) o no (false)? Consulta Acuerdo legal del Workshop para obtener más información.

Funciones asociadas: CreateItem

DownloadItemResult_t

Se realiza esta llamada cuando se ha descargado un artículo del Workshop.

NOTA: Esta función callback se dirige a todas las aplicaciones abiertas, así que hay que asegurarse de que el id. de aplicación asociado con el artículo es el que se espera.

NombreTipoDescripción
m_unAppIDAppId_tId. de aplicación asociado a este artículo del Workshop.
m_nPublishedFileIdPublishedFileId_tArtículo del Workshop que se ha terminado de descargar.
m_eResultEResultResultado de la operación.

Funciones asociadas: DownloadItem

GetAppDependenciesResult_t

Se realiza esta llamada al obtener las dependencias de aplicación para un artículo.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_tArtículo del Workshop cuyas dependencias de aplicación se quieren obtener.
m_rgAppIDsAppId_tMatriz de dependencias de la aplicación.
m_nNumAppDependenciesuint32Número de dependencias de aplicaciones devueltas en m_rgAppIDs
m_nTotalNumAppDependenciesuint32Total de dependencias de aplicación encontradas.

Funciones asociadas: GetAppDependencies

DeleteItemResult_t

Se realiza esta llamada cuando se completa un intento de eliminar un artículo.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_tEl artículo del Workshop que estaba siendo eliminado.

Funciones asociadas: DeleteItem

GetUserItemVoteResult_t

Se realiza esta llamada al obtener el estado del voto de los usuarios para un artículo.

NombreTipoDescripción
m_nPublishedFileIdPublishedFileId_tArtículo del Workshop del que se desea obtener el estado del voto.
m_eResultEResultResultado de la operación.
m_bVotedUpbool¿Ha votado el usuario a favor del artículo?
m_bVotedDownbool¿Ha votado el usuario en contra del artículo?
m_bVoteSkippedbool¿Se ha saltado el usuario la votación de este artículo?

Funciones asociadas: GetUserItemVote

ItemInstalled_t

Se realiza esta llamada cuando se ha instalado o actualizado un artículo del Workshop.

NOTA: Esta función callback se dirige a todas las aplicaciones abiertas, así que hay que asegurarse de que el id. de aplicación asociado con el artículo es el que se espera.

NombreTipoDescripción
m_unAppIDAppId_tId. de aplicación asociado a este artículo del Workshop.
m_nPublishedFileIdPublishedFileId_tArtículo del Workshop que se ha terminado de instalar. Se puede usar con GetItemInstallInfo para acceder a la información sobre el artículo.

RemoveAppDependencyResult_t

Propósito: El resultado de una llamada a RemoveAppDependency.

NombreTipoDescripción
m_eResultEResultEl resultado de la operación.
m_nPublishedFileIdPublishedFileId_tArtículo principal del Workshop cuya dependencia se eliminó.
m_nAppIDAppId_tLa aplicación o el DLC.

Funciones asociadas: RemoveAppDependency

RemoveUGCDependencyResult_t

Propósito: El resultado de una llamada a RemoveDependency.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_tArtículo principal del Workshop cuya dependencia se eliminó.
m_nChildPublishedFileIdPublishedFileId_tArtículo secundario del Workshop que se eliminó como dependencia del artículo principal.

Funciones asociadas: RemoveDependency

SetUserItemVoteResult_t

Se realiza esta llamada cuando el usuario ha votado por un artículo.

NombreTipoDescripción
m_nPublishedFileIdPublishedFileId_tArtículo del Workshop por el que votó el usuario.
m_eResultEResultResultado de la operación.
m_bVoteUpbool¿El voto hacia arriba (true) o hacia abajo (false)?

Funciones asociadas: SetUserItemVote

StartPlaytimeTrackingResult_t

Se realiza esta llamada cuando ha comenzado el seguimiento del tiempo de juego de un artículo del Workshop.

NombreTipoDescripción
m_eResultEResultEl resultado de la operación.

Funciones asociadas: StartPlaytimeTracking

SteamUGCQueryCompleted_t

Se realiza esta llamada cuando se completa una consulta de CGU.

NombreTipoDescripción
m_handleUGCQueryHandle_tHandle de la consulta de CGU asociada con el resultado de la llamada.
m_eResultEResultResultado de la operación.
m_unNumResultsReturneduint32El número de artículos devueltos en este conjunto de resultados.
m_unTotalMatchingResultsuint32El número total de artículos que coincidieron con la consulta en la base de datos.
m_bCachedDataboolIndica si estos datos se obtuvieron de la caché del disco local.

Funciones asociadas: SendQueryUGCRequest

SteamUGCRequestUGCDetailsResult_t

OBSOLETO: Resultado anterior de una llamada a RequestUGCDetails.

NombreTipoDescripción
m_detailsSteamUGCDetails_tObsoleto.
m_bCachedDataboolObsoleto.

Funciones asociadas: RequestUGCDetails

StopPlaytimeTrackingResult_t

Se realiza esta llamada cuando se ha detenido el seguimiento del tiempo de juego de un artículo del Workshop.

NombreTipoDescripción
m_eResultEResultResultado de la operación.

Funciones asociadas: StopPlaytimeTracking, StopPlaytimeTrackingForAllItems

SubmitItemUpdateResult_t

Se realiza esta llamada cuando se ha completado la actualización de un artículo.

NombreTipoDescripción
m_eResultEResultResultado de la operación. Algunos de los posibles valores devueltos son:
m_bUserNeedsToAcceptWorkshopLegalAgreementbool¿El usuario tiene que aceptar el acuerdo legal de Steam Workshop? Consulta Acuerdo legal del Workshop para obtener más información.

Funciones asociadas: SubmitItemUpdate

UserFavoriteItemsListChanged_t

Se realiza esta llamada cuando el usuario ha agregado un artículo a su lista de favoritos o lo ha eliminado de ella.

NombreTipoDescripción
m_nPublishedFileIdPublishedFileId_tEl artículo que se agregó o eliminó.
m_eResultEResultResultado de la operación.
m_bWasAddRequestbool¿Se agregó a los favoritos del usuario (true) o se eliminó de ellos (false)?

Funciones asociadas: AddItemToFavorites, RemoveItemFromFavorites

UserSubscribedItemsListChanged_t

Se llama cuando el usuario ha agregado o eliminado un artículo de sus suscripciones para el id. de aplicación devuelto.

NombreTipoDescripción
m_nAppIDAppId_tEl id. de aplicación relacionado.

Funciones asociadas: SubscribeItem, UnsubscribeItem

WorkshopEULAStatus_t

Función callback devuelta GetWorkshopEULAStatus

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nAppIDAppId_tEl id. de aplicación relacionado.
m_unVersionuint32La versión del ALUF firmado, si es aplicable.
m_rtActionRTime32Marca de tiempo Unix del momento en el que el usuario firmó el ALUF, si corresponde.
m_bAcceptedvalor booleanoTrue si el usuario aceptó la versión proporcionada; de lo contrario, false. Ten cuenta que esto puede ser true si el usuario aceptó una versión antigua del ALUF.
m_bNeedsActionvalor booleanoTrue cuando el usuario necesita aceptar el ALUF del Workshop más reciente; de lo contrario, false.

Funciones asociadas: GetWorkshopEULAStatus

Structs

Estructuras que las funciones de ISteamUGC pueden devolver o con las que esas funciones pueden interactuar.

SteamUGCDetails_t

Detalles de un único artículo o CGU publicado. GetQueryUGCResult devuelve estos resultados.

NombreTipoDescripción
m_nPublishedFileIdPublishedFileId_tHandle exclusivo globalmente de este CGU.
m_eResultEResultResultado de la operación.
m_eFileTypeEWorkshopFileTypeEl tipo de artículo.
m_nCreatorAppIDAppId_tId. de la aplicación que creó este artículo.
m_nConsumerAppIDAppId_tId. de la aplicación que consumirá este artículo.
m_rgchTitlechar[[apitype]ISteamRemoteStorage::k_cchPublishedDocumentTitleMax[/apitype]]El título del artículo.
m_rgchDescriptionchar[[apitype]ISteamRemoteStorage::k_cchPublishedDocumentDescriptionMax[/apitype]]La descripción del artículo.
m_ulSteamIDOwneruint64Id. de Steam del usuario que creó este contenido.
m_rtimeCreateduint32Momento en que se creó el artículo publicado, expresado en formato de tiempo Unix (tiempo transcurrido desde el 1 de enero de 1970).
m_rtimeUpdateduint32Momento en que se actualizó por última vez el artículo publicado, expresado en formato de tiempo Unix (tiempo transcurrido desde el 1 de enero de 1970).
m_rtimeAddedToUserListuint32Momento en que el usuario agregó el artículo publicado a su lista (no es siempre aplicable), expresado en formato de tiempo Unix (tiempo transcurrido desde el 1.° de enero de 1970).
m_eVisibilityERemoteStoragePublishedFileVisibilityVisibilidad del artículo.
m_bBannedboolIndica si el artículo está bloqueado o no.
m_bAcceptedForUseboolIndica si el desarrollador de la aplicación ha marcado este artículo de manera específica como aceptado en el Workshop. (Consulta: Workshop supervisado)
m_bTagsTruncatedboolIndica si la lista de etiquetas era demasiado larga como para devolverla al búfer proporcionado y si se ha truncado debido a ello.
m_rgchTagschar[[apitype]ISteamRemoteStorage::k_cchTagListMax[/apitype]]Lista de todas las etiquetas asociadas con este artículo, separadas por comas.
m_hFileUGCHandle_tHandle del archivo principal.
m_hPreviewFileUGCHandle_tHandle del archivo de previsualización.
m_pchFileNamechar[[apitype]ISteamRemoteStorage::k_cchFilenameMax[/apitype]]Nombre en la nube del archivo principal.
m_nFileSizeint32El tamaño del archivo principal.
m_nPreviewFileSizeint32El tamaño del archivo de previsualización.
m_rgchURLchar[[apitype]ISteamRemoteStorage::k_cchPublishedFileURLMax[/apitype]]El URL asociado a este artículo. (Para un video o un sitio web).
m_unVotesUpuint32Número de votos positivos.
m_unVotesDownuint32Número de votos negativos.
m_flScorefloatMedia bayesiana de votos positivos / votos totales, entre 0 y 1.
m_unNumChildrenuint32Número de artículos en la colección si m_eFileType es k_EWorkshopFileTypeCollection o el número de artículos de los que dependa este artículo específico (consulta AddDependency).

Enums

Estas son las enumeraciones establecidas para usarse con ISteamUGC.

EItemPreviewType

Marcas que especifican el tipo de vista previa que tiene un artículo. Se establece con AddItemPreviewFile y se obtiene con GetQueryUGCAdditionalPreview.

NombreValorDescripción
k_EItemPreviewType_Image0Archivo de imagen estándar visible en web. Tipos de archivo compatibles: PNG, JPG y GIF.
k_EItemPreviewType_YouTubeVideo1Id. del video de YouTube. (por ejemplo, "jHgZh4GV9G0").
k_EItemPreviewType_Sketchfab2Id. de modelo de Sketchfab.
k_EItemPreviewType_EnvironmentMap_HorizontalCross3Archivo de imagen estándar que contiene un mapa de entorno de sección horizontal (véase más abajo). Tipos de archivo compatibles: PNG, JPG y GIF.
+---+---+-------+ | |Up | | +---+---+---+---+ | L | F | R | B | +---+---+---+---+ | |Dn | | +---+---+---+---+
Actualmente no se utiliza en las vistas web.
k_EItemPreviewType_EnvironmentMap_LatLong4Archivo de imagen estándar que contiene un mapa de entorno en una plantilla de LatLong. Tipos de archivo compatibles: PNG, JPG y GIF. Actualmente no se utiliza en las vistas web.
k_EItemPreviewType_ReservedMax255Reservado. Puedes especificar tus propios tipos por encima de este valor.

EItemState

Especifica el estado de un artículo. Estas marcas se pueden combinar. Devuelto por GetItemState.

NombreValorDescripción
k_EItemStateNone0En el cliente no se hace el seguimiendo de este artículo.
k_EItemStateSubscribed1El usuario actual está suscrito al artículo. No solo se almacena en la caché.
k_EItemStateLegacyItem2Este artículo se creó con las antiguas funciones del Workshop en ISteamRemoteStorage.
k_EItemStateInstalled4El artículo está instalado y se puede usar (pero podría estar desactualizado).
k_EItemStateNeedsUpdate8Es necesario actualizar el artículo. O bien porque no está instalado aún, o porque el creador ha actualizado el contenido.
k_EItemStateDownloading16La actualización del artículo se está descargando en este momento.
k_EItemStateDownloadPending32Se ha llamado a DownloadItem para este artículo, el contenido no está disponible hasta que DownloadItemResult_t se active.

EItemStatistic

Se utiliza para recuperar estadísticas de artículos con GetQueryUGCStatistic.

NombreValorDescripción
k_EItemStatistic_NumSubscriptions0Obtiene el número de suscripciones.
k_EItemStatistic_NumFavorites1Obtiene el número de veces que el artículo se ha agregado a favoritos.
k_EItemStatistic_NumFollowers2Obtiene el número de seguidores.
k_EItemStatistic_NumUniqueSubscriptions3Obtiene el número de suscripciones únicas.
k_EItemStatistic_NumUniqueFavorites4Obtiene el número de veces que el artículo se ha agregado a favoritos únicos.
k_EItemStatistic_NumUniqueFollowers5Obtiene el número de seguidores únicos.
k_EItemStatistic_NumUniqueWebsiteViews6Obtiene el número de visualizaciones únicas que tiene el artículo en su página de Steam Workshop.
k_EItemStatistic_ReportScore7Obtiene el número de veces que alguien ha denunciado el artículo.
k_EItemStatistic_NumSecondsPlayed8Obtiene el tiempo total de uso del artículo entre todos los usuarios (en segundos).
k_EItemStatistic_NumPlaytimeSessions9Obtiene el número total de sesiones de juego en las que se ha utilizado el artículo.
k_EItemStatistic_NumComments10Obtiene el número total de comentarios sobre el artículo en su página de Steam Workshop.
k_EItemStatistic_NumSecondsPlayedDuringTimePeriod11Obtiene el tiempo total de uso del artículo a lo largo del periodo especificado (en segundos).
k_EItemStatistic_NumPlaytimeSessionsDuringTimePeriod12Obtiene el número de sesiones en las que se ha utilizado el artículo a lo largo del periodo especificado.

EItemUpdateStatus

Especifica el estado de UGCUpdateHandle_t después de una llamada a GetItemUpdateProgress, devuelto por GetItemUpdateProgress.

NombreValorDescripción
k_EItemUpdateStatusInvalid0El handle de actualización del artículo no era válido; es posible que la tarea haya finalizado. La llamada a SubmitItemUpdateResult_t debería haber devuelto algún resultado.
k_EItemUpdateStatusPreparingConfig1La actualización del artículo está procesando datos de configuración.
k_EItemUpdateStatusPreparingContent2La actualización del artículo está leyendo y procesando archivos de contenido.
k_EItemUpdateStatusUploadingContent3La actualización del artículo está cargando a Steam cambios de contenido.
k_EItemUpdateStatusUploadingPreviewFile4La actualización del artículo está cargando una nueva imagen del archivo de previsualización.
k_EItemUpdateStatusCommittingChanges5La actualización del artículo está confirmando todos los cambios.

EUGCMatchingUGCType

Especifica los tipos de CGU que se obtendrán de una llamada a CreateQueryUserUGCRequest o a CreateQueryAllUGCRequest.

NombreValorDescripción
k_EUGCMatchingUGCType_Items0Artículos de microtransacciones y artículos listos para usar.
k_EUGCMatchingUGCType_Items_Mtx1Artículos de microtransacciones. (consulta: Mentores del Workshop).
k_EUGCMatchingUGCType_Items_ReadyToUse2Habitual en artículos de juegos cargados por los jugadores (consulta: Listo para usar en el Workshop).
k_EUGCMatchingUGCType_Collections3Colecciones compartidas de CGU.
k_EUGCMatchingUGCType_Artwork4Material gráfico compartido.
k_EUGCMatchingUGCType_Videos5Videos compartidos.
k_EUGCMatchingUGCType_Screenshots6Capturas de pantalla compartidas.
k_EUGCMatchingUGCType_AllGuides7Guías web y guías integradas.
k_EUGCMatchingUGCType_WebGuides8Guías disponibles solo para la comunidad de Steam.
k_EUGCMatchingUGCType_IntegratedGuides9Guías que se pueden usar dentro del juego (como las guías de personajes de Dota 2).
k_EUGCMatchingUGCType_UsableInGame10Guías integradas y artículos listos para usarse.
k_EUGCMatchingUGCType_ControllerBindings11Asignaciones de controles que se han compartido.
k_EUGCMatchingUGCType_GameManagedItems12Artículos gestionados por el juego (no por los usuarios).
k_EUGCMatchingUGCType_All~0Lo devuelve todo.

EUGCQuery

Se usa con CreateQueryAllUGCRequest para especificar el orden y los filtros de las consultas en todo el CGU disponible.

NombreValorDescripción
k_EUGCQuery_RankedByVote0Ordenar por número de votos (total acumulado).
k_EUGCQuery_RankedByPublicationDate1Ordenar por fecha de publicación, en orden descendente.
k_EUGCQuery_AcceptedForGameRankedByAcceptanceDate2Ordenar por fecha de aceptación (para artículos mtx)
k_EUGCQuery_RankedByTrend3Ordenar por número de votos dentro del periodo de "tendencia" determinado (establecer en SetRankedByTrendDays).
k_EUGCQuery_FavoritedByFriendsRankedByPublicationDate4Filtrar por artículos favoritos de los amigos del usuario, ordenados por fecha descendente de publicación.
k_EUGCQuery_CreatedByFriendsRankedByPublicationDate5Filtrar por artículos creados por amigos (ordenados por fecha de publicación descendente).
k_EUGCQuery_RankedByNumTimesReported6Ordenar por cantidad de denuncias, en orden descendente.
k_EUGCQuery_CreatedByFollowedUsersRankedByPublicationDate7Filtrar por artículos de los usuarios que el usuario actual ha seguido, ordenado por fecha de publicación descendente.
k_EUGCQuery_NotYetRated8Filtrado a la cola de votación del usuario.
k_EUGCQuery_RankedByTotalVotesAsc9Ordenar por el número total de votos (ascendente), (usado internamente para crear la cola de votación del usuario)
k_EUGCQuery_RankedByVotesUp10Ordenar por número de votos positivos, en orden descendente. Utilizará el período de "tendencia" si se especifica (establecido en SetRankedByTrendDays).
k_EUGCQuery_RankedByTextSearch11Ordenar por relevancia de las palabras claves de la búsqueda.
k_EUGCQuery_RankedByTotalUniqueSubscriptions12Ordenar por número total acumulado de suscriptores únicos, en orden descendente.
k_EUGCQuery_RankedByPlaytimeTrend13Ordenar de forma descendente por tiempo total de juego en el período de "tendencia" (establecido con SetRankedByTrendDays).
k_EUGCQuery_RankedByTotalPlaytime14Ordenar por tiempo de juego total acumulado, en orden descendente.
k_EUGCQuery_RankedByAveragePlaytimeTrend15Ordenar de forma descendente por tiempo medio de juego en el período de "tendencia" (establecido en SetRankedByTrendDays).
k_EUGCQuery_RankedByLifetimeAveragePlaytime16Ordenar por tiempo de juego medio a lo largo de su duración en orden descendente.
k_EUGCQuery_RankedByPlaytimeSessionsTrend17Ordenar de forma descendente por número de sesiones de juego en el período de "tendencia" (establecido en SetRankedByTrendDays).
k_EUGCQuery_RankedByLifetimePlaytimeSessions18Ordenar por número de sesiones de juego a lo largo de su duración en orden descendente.
k_EUGCQuery_RankedByLastUpdatedDate19Ordenar por la fecha de la última actualización.

EUserUGCList

Se usa con CreateQueryUserUGCRequest para obtener diferentes listas de CGU publicado por un usuario.

NombreValorDescripción
k_EUserUGCList_Published0Lista de archivos que el usuario ha publicado (equivalente a http://steamcommunity.com/my/myworkshopfiles/?browsesort=myfiles).
k_EUserUGCList_VotedOn1Lista de archivos con votos del usuario. Incluye votos positivos (VotedUp) y negativos (VotedDown).
k_EUserUGCList_VotedUp2Lista de archivos con votos positivos del usuario (restringida al usuario actual).
k_EUserUGCList_VotedDown3Lista de archivos con votos negativos del usuario (restringida al usuario actual).
k_EUserUGCList_WillVoteLater4Obsoleto. ¡No lo utilices! (Restringida al usuario actual).
k_EUserUGCList_Favorited5Lista de archivos que el usuario ha agregado a favoritos. (equivalente a http://steamcommunity.com/my/myworkshopfiles/?browsesort=myfavorites).
k_EUserUGCList_Subscribed6Lista de archivos a los que se ha suscrito el usuario. (restringida al usuario actual). Es equivalente a http://steamcommunity.com/my/myworkshopfiles/?browsesort=mysubscriptions.
k_EUserUGCList_UsedOrPlayed7Lista de archivos con los que el usuario ha pasado tiempo en el juego. Es equivalente a http://steamcommunity.com/my/myworkshopfiles/?browsesort=myplayedfiles.
k_EUserUGCList_Followed8Lista de archivos cuyas actualizaciones sigue el usuario.

EUserUGCListSortOrder

Se usa con CreateQueryUserUGCRequest para especificar el criterio de clasificación de las listas de CGU publicadas por el usuario. De forma predeterminada, se organiza por orden de creación descendente.

NombreValorDescripción
k_EUserUGCListSortOrder_CreationOrderDesc0Devuelve los artículos por fecha de creación. Descendente: primero los más recientes. (Se corresponde con "sortmethod=newestfirst" en la página del Workshop).
k_EUserUGCListSortOrder_CreationOrderAsc1Devuelve los artículos por fecha de creación. Ascendente: primero los más antiguos. (Se corresponde con "sortmethod=oldestfirst" en la página del Workshop).
k_EUserUGCListSortOrder_TitleAsc2Devuelve los artículos por nombre. (Se corresponde con "sortmethod=alpha" en la página del Workshop).
k_EUserUGCListSortOrder_LastUpdatedDesc3Devuelve los artículos actualizados más recientemente primero. (Se corresponde con "sortmethod=lastupdated" en la página del Workshop).
k_EUserUGCListSortOrder_SubscriptionDateDesc4Devuelve los artículos que han recibido suscripciones más recientemente primero. (Corresponde a "sortmethod=subscriptiondate" en la página del Workshop).
k_EUserUGCListSortOrder_VoteScoreDesc5Devuelve los artículos cuya valoración se ha actualizado más recientemente primero. (Corresponde a "sortmethod=score" en la página del Workshop).
k_EUserUGCListSortOrder_ForModeration6Devuelve los artículos denunciados a los moderadores. (Se corresponde con "sortmethod=formoderation" en la página del Workshop).

EUGCContentDescriptorID

Los usuarios pueden controlar qué contenido generado por los usuarios quieren ver en la sección Filtrado del contenido para adultos de sus preferencias. Este filtrado lo realizan los servidores de Steam automáticamente, pero antes debe etiquetarse adecuadamente el contenido generado por el usuario. Los desarrolladores pueden llamar a AddContentDescriptor y RemoveContentDescriptor para gestionar los descriptores de contenido que tiene cada artículo del CGU. Esos descriptores se pueden obtener al realizar la consulta de GetQueryUGCContentDescriptors.

NombreValorDescripción
k_EUGCContentDescriptor_NudityOrSexualContent1Algún desnudo o contenido sexual:
Incluye contenido con algún desnudo o temas sexuales, sin ser el enfoque principal.
k_EUGCContentDescriptor_FrequentViolenceOrGore2Violencia o gore frecuentes:
Incluye contenido que muestra violencia extrema o gore.
k_EUGCContentDescriptor_AdultOnlySexualContent3Contenido sexual solo para adultos:
Incluye contenido sexual explícito o gráfico y está destinado únicamente a un público adulto. Los usuarios deben afirmar que tienen al menos dieciocho años antes de poder ver el contenido con este descriptor.
k_EUGCContentDescriptor_GratuitousSexualContent4Contenido sexual o desnudos frecuentes:
Incluye contenido que muestra principalmente desnudos y temas sexuales. Los usuarios deben afirmar que tienen al menos dieciocho años antes de poder ver el contenido con este descriptor.
k_EUGCContentDescriptor_AnyMatureContent5Contenido general para adultos:
Incluye temas para adultos que pueden no ser aptos para todos los públicos.

Typedefs

Estas son definiciones de tipo establecidas para usarse con ISteamUGC.

NombreTipo de baseDescripción
UGCQueryHandle_tuint64Un handle único para una consulta de CGU. Se usa al solicitar listas de artículos al Workshop.
UGCUpdateHandle_tuint64Un handle único para una actualización de un artículo. Se usa al subir un artículo al Workshop o actualizarlo.

Constantes

Estas son constantes que se definen para usarse con ISteamUGC.

NombreTipoValorDescripción
kNumUGCResultsPerPageuint3250Número máximo de resultados que se pueden recibir para una consulta.
k_cchDeveloperMetadataMaxuint325000La cantidad máxima de bytes que puedes establecer con SetItemMetadata.
k_UGCQueryHandleInvalidUGCQueryHandle_t0xffffffffffffffffullSe utiliza para especificar un handle de consulta no válido. Se suele devolver con frecuencia cuando falla una llamada.
k_UGCUpdateHandleInvalidUGCUpdateHandle_t0xffffffffffffffffullSe utiliza para especificar un handle de actualización de un artículo que no es válido. Se suele devolver con frecuencia cuando falla una llamada.
STEAMUGC_INTERFACE_VERSIONconst char *"STEAMUGC_INTERFACE_VERSION015"