Funciones para crear, consumir e interactuar con el
Workshop de Steam.
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 );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El artículo. |
nAppID | AppId_t | Aplicación o contenido descargable que se requiere. |
Añade 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, que se usa con un resultado de la llamada a
AddAppDependencyResult_t.
Véase también: RemoveAppDependencyAddDependency
SteamAPICall_t AddDependency( PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID );
Nombre | Tipo | Descripción |
nParentPublishedFileID | PublishedFileId_t | El artículo del Workshop al que se le agrega una dependencia. |
nChildPublishedFileID | PublishedFileId_t | La dependencia que se agrega al artículo principal. |
Añade un artículo del Workshop como dependencia del artículo especificado. Si el elemento
nParentPublishedFileID
es de tipo
k_EWorkshopFileTypeCollection
, entonces
nChildPublishedFileID
simplemente se agrega a esa colección. De lo contrario, es una
dependencia flexible que se muestra en la 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, que se usa con un resultado de la llamada a
AddUGCDependencyResult_t.
Véase también: RemoveDependencyAddExcludedTag
bool AddExcludedTag( UGCQueryHandle_t handle, const char *pTagName );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
pTagName | const char * | La etiqueta NO debe estar asociada al CGU para recibirlo. |
Añade 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 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, o si
pTagName
era
NULL.
Véase también: AddRequiredTag,
SetMatchAnyTag,
SetItemTagsAddItemKeyValueTag
bool AddItemKeyValueTag( UGCUpdateHandle_t handle, const char *pchKey, const char *pchValue );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | Handle de actualización del artículo del Workshop que se va a personalizar. |
pchKey | const char * | La clave a establecer en el artículo. |
pchValue | const char * | Un valor para asignar a la clave. |
Añade 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 CGU usando
SubmitItemUpdate.
Devuelve: bool
true si se ejecuta correctamente.
false si el
handle
de la actualización de CGU no es válido, si
pchKey
o
pchValue
no son válidos porque tienen un valor de
NULL o superan la longitud máxima, o si intentas añadir más de 100 etiquetas clave-valor en una sola actualización.
Véase también: RemoveItemKeyValueTags,
SetReturnKeyValueTags,
GetQueryUGCNumKeyValueTags,
GetQueryUGCKeyValueTagAddItemPreviewFile
bool AddItemPreviewFile( UGCUpdateHandle_t handle, const char *pszPreviewFile, EItemPreviewType type );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | Handle de actualización del artículo del Workshop que se va a personalizar. |
pszPreviewFile | const char * | Ruta completa a la imagen local. |
type | EItemPreviewType | El tipo de esta vista previa. |
Añade 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 es compatible con esta API en estos momentos. Para los vídeos de YouTube, debes usar
AddItemPreviewVideo.
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: GetQueryUGCNumAdditionalPreviews,
GetQueryUGCAdditionalPreview,
SetReturnAdditionalPreviews,
UpdateItemPreviewFile,
AddItemPreviewVideo,
RemoveItemPreviewAddItemPreviewVideo
bool AddItemPreviewVideo( UGCUpdateHandle_t handle, const char *pszVideoID );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | Handle de actualización del artículo del Workshop que se va a personalizar. |
pszVideoID | const char * | Id. del vídeo de YouTube que se va a añadir (por ejemplo, «jHgZh4GV9G0»). |
Añade otra vista previa del vídeo 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: GetQueryUGCNumAdditionalPreviews,
GetQueryUGCAdditionalPreview,
SetReturnAdditionalPreviews,
UpdateItemPreviewVideo,
AddItemPreviewFile,
RemoveItemPreviewAddItemToFavorites
SteamAPICall_t AddItemToFavorites( AppId_t nAppId, PublishedFileId_t nPublishedFileID );
Nombre | Tipo | Descripción |
nAppId | AppId_t | Id. de la aplicación a la que pertenece este artículo. |
nPublishedFileID | PublishedFileId_t | El artículo del Workshop que se añadirá a la lista de favoritos del usuario. |
Añade un artículo del Workshop a 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: RemoveItemFromFavoritesAddRequiredKeyValueTag
bool AddRequiredKeyValueTag( UGCQueryHandle_t handle, const char *pKey, const char *pValue );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
pKey | const char * | Clave del par clave-valor que debe estar adjunta al CGU para recibirlo. |
pValue | const char * | El valor clave-valor asociado con pKey que se debe estar asociado al CGU para recibirlo. |
Añade la etiqueta clave-valor que se requerirá en una consulta de CGU pendiente. 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 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 si
pKey
o
pValue
son
NULL.
AddRequiredTag
bool AddRequiredTag( UGCQueryHandle_t handle, const char *pTagName );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
pTagName | const char * | La etiqueta debe estar asociada al CGU para recibirlo. |
Añade 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 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, o si
pTagName
era
NULL.
Véase también: AddExcludedTag,
SetMatchAnyTag,
SetItemTagsAddRequiredTagGroup
bool AddRequiredTagGroup( UGCQueryHandle_t handle, const SteamParamStringArray_t *pTags );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
pTags | const SteamParamStringArray_t * | Un conjunto de etiquetas donde al menos una de ellas debe estar asociada al CGU. |
Añade el requisito de que los objetos devueltos de la consulta de CGU pendiente tengan al menos una de las etiquetas en el conjunto específico («o» lógica). Para cada grupo de etiquetas que se ha añadido, al menos una de las etiquetas de cada grupo deberá estar en los objetos que coincidan.
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, o si
pTagName
era
NULL.
Véase también: AddRequiredTag,
AddExcludedTagBInitWorkshopForGameServer
bool BInitWorkshopForGameServer( DepotId_t unWorkshopDepotID, const char *pszFolder );
Nombre | Tipo | Descripción |
unWorkshopDepotID | DepotId_t | Id. de repositorio del servidor de juego. |
pszFolder | const char * | La ruta absoluta en donde se va a almacenar el contenido del 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 );
Nombre | Tipo | Descripción |
nConsumerAppId | AppId_t | Id. de aplicación que utilizará este artículo. |
eFileType | EWorkshopFileType | Tipo de CGU que se va a crear. |
Crea un nuevo artículo del Workshop que aún no tiene contenido asociado.
Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a
CreateItemResult_t.
Véase también: Crear un artículo de WorkshopCreateQueryAllUGCRequest
UGCQueryHandle_t CreateQueryAllUGCRequest( EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint32 unPage );
Nombre | Tipo | Descripción |
eQueryType | EUGCQuery | Se usa para especificar el orden y los filtros de esta llamada. |
eMatchingeMatchingUGCTypeFileType | EUGCMatchingUGCType | Se usa para especificar el tipo de CGU que se consulta. |
nCreatorAppID | AppId_t | Debe 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. |
nConsumerAppID | AppId_t | Debe 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. |
unPage | uint32 | Nú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 handle que devuelve esta función llamando a
ReleaseQueryUGCRequest cuando termines.
Para consultar el CGU asociado con un solo usuario, puedes usar
CreateQueryUserUGCRequest en su lugar.
Devuelve: UGCQueryHandle_t.
Devuelve un nuevo
UGCQueryHandle_t si se ejecuta correctamente 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 ha producido 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::GetAppIDCreateQueryUGCDetailsRequest
UGCQueryHandle_t CreateQueryUGCDetailsRequest( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs );
Nombre | Tipo | Descripción |
pvecPublishedFileID | PublishedFileId_t * | Lista de artículos del Workshop cuyos detalles se van a obtener. |
unNumPublishedFileIDs | uint32 | El 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 id. de aplicación 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 ha producido 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 );
Nombre | Tipo | Descripción |
unAccountID | AccountID_t | Id. 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. |
eListType | EUserUGCList | Se 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) |
eMatchingUGCType | EUGCMatchingUGCType | Se usa para especificar el tipo de CGU que se consulta. |
eSortOrder | EUserUGCListSortOrder | Se usa para especificar el orden que tendrá la lista. |
nCreatorAppID | AppId_t | Debe 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. |
nConsumerAppID | AppId_t | Debe 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. |
unPage | uint32 | Nú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 id. de aplicación 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án configurados con la aplicación que está en ejecución actualmente.
-
unPage
era inferior a 1.
- El
eListType
dado solo es compatible para los usuarios que solicitan los detalles.
- Se ha producido 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::GetAppIDDeleteItem
SteamAPICall_t DeleteItem( PublishedFileId_t nPublishedFileID );
Elimina el artículo sin pedir confirmación al usuario.
Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a
DeleteItemResult_t.
DownloadItem
bool DownloadItem( PublishedFileId_t nPublishedFileID, bool bHighPriority );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El artículo del Workshop que se va a descargar. |
bHighPriority | bool | Inicia 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 );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | Artí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 a
GetAppDependenciesResult_t.
Véase también: AddAppDependency,
RemoveAppDependencyGetItemDownloadInfo
bool GetItemDownloadInfo( PublishedFileId_t nPublishedFileID, uint64 *punBytesDownloaded, uint64 *punBytesTotal );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El artículo del Workshop para el que obtener la información de descarga. |
punBytesDownloaded | uint64 * | Devuelve los bytes actuales descargados. |
punBytesTotal | uint64 * | 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 );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El artículo del Workshop para el que se obtiene la información de instalación. |
punSizeOnDisk | uint64 * | Devuelve el tamaño del artículo del Workshop en bytes. |
pchFolder | char * | Devuelve la ruta de acceso absoluta a la carpeta que aloja el contenido copiándolo. |
cchFolderSize | uint32 | El tamaño de pchFolder en bytes. |
punTimeStamp | uint32 * | Devuelve la fecha y hora en 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 añade 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 );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El 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.
Por 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 );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | El handle de actualización para el que obtener el progreso. |
punBytesProcessed | uint64 * | Devuelve el número actual de bytes cargados. |
punBytesTotal | uint64 * | 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: SubmitItemUpdateGetNumSubscribedItems
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 );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
previewIndex | uint32 | Índice de la vista previa adicional cuya información se va a obtener. |
pchURLOrVideoID | char * | Devuelve un URL o el id. del vídeo copiándolo en esta cadena. |
cchURLSize | uint32 | El tamaño de pchURLOrVideoID en bytes. |
pchOriginalFileName | char * | Devuelve el nombre del archivo original. Puede establecerse en NULL para no recibir esto. |
cchOriginalFileNameSize | uint32 | El tamaño de pchOriginalFileName en bytes. |
pPreviewType | EItemPreviewType * | 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.
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.
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 );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
pvecPublishedFileID | PublishedFileId_t * | Devuelve el CGU secundario estableciendo esta matriz. |
cMaxEntries | uint32 | La longitud de pvecPublishedFileID . |
Recupera los ids. 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).
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.
Debes crear
pvecPublishedFileID
con el valor
m_unNumChildren
proporcionado en
SteamUGCDetails_t después de obtener los detalles de CGU con
GetQueryUGCResult.
Devuelve: bool
true cuando se ejecuta correctamente, indica que
pvecPublishedFileID
se ha completado.
De lo contrario,
false si el
handle
de consulta de CGU no es válido o
index
está fuera del límite.
GetQueryUGCNumTags
uint32 GetQueryUGCNumTags( UGCQueryHandle_t handle, uint32 index );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener 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.
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.
Luego puedes llamar a
GetQueryUGCTag para obtener el nombre de etiqueta o a
GetQueryUGCTagDisplayName para obtener el texto localizado de la etiqueta (si existe).
Devuelve: uint32.
El número de etiquetas clave-valor asociadas con el artículo del Workshop especificado.
Devuelve
0 si el
handle
de consulta de CGU no es válido o si el
index
está fuera de los límites.
GetQueryUGCTag
bool GetQueryUGCTag( UGCQueryHandle_t handle, uint32 index, uint32 tagIndex, char *pchValue, uint32 cchValueSize );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
tagIndex | uint32 | El índice de la etiqueta. |
pchValue | char * | Devuelve el valor copiándolo en esta cadena. |
cchValueSize | uint32 | El 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 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.
Antes de realizar esta llamada, llama a
GetQueryUGCNumTags para obtener el número de etiquetas.
GetQueryUGCTagDisplayName
bool GetQueryUGCTagDisplayName( UGCQueryHandle_t handle, uint32 index, uint32 tagIndex, char *pchValue, uint32 cchValueSize );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
tagIndex | uint32 | El índice de la etiqueta. |
pchValue | char * | Devuelve el valor copiándolo en esta cadena. |
cchValueSize | uint32 | El tamaño de pchValue en bytes (asigna por lo menos 256 bytes). |
Disponible en el SDK versión 1.51.
Recupera la cadena «nth» que se muestra (normalmente localizada) para una etiqueta, la cual está asociada con un artículo del Workshop individual 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.
Antes de realizar esta llamada, llama 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 );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
keyValueTagIndex | uint32 | El índice de la etiqueta cuya información se va a obtener. |
pchKey | char * | Devuelve la clave copiándola en esta cadena. |
cchKeySize | uint32 | El tamaño de pchKey en bytes. |
pchValue | char * | Devuelve el valor copiándolo en esta cadena. |
cchValueSize | uint32 | El 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.
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.
Antes de realizar esta llamada, llama a
GetQueryUGCNumKeyValueTags para obtener el 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 );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
pvecDescriptors | EUGCContentDescriptorID | Una matriz de EUGCContentDescriptorID para completar. |
cMaxEntries | uint32 | Tamañ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,
RemoveContentDescriptorGetQueryUGCMetadata
bool GetQueryUGCMetadata( UGCQueryHandle_t handle, uint32 index, char *pchMetadata, uint32 cchMetadatasize );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
pchMetadata | char * | Devuelve el URL copiándolo en esta cadena. |
cchMetadatasize | uint32 | El 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 si se ejecuta correctamente, indica que
pchMetadata
se ha completado.
De lo contrario,
false si el
handle
de consulta de CGU no es válido o el
index
está fuera de los límites.
Véase también: SetItemMetadataGetQueryUGCNumAdditionalPreviews
uint32 GetQueryUGCNumAdditionalPreviews( UGCQueryHandle_t handle, uint32 index );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener 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.
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.
Luego puedes llamar a
GetQueryUGCAdditionalPreview para obtener los detalles de cada vista previa adicional.
Devuelve: uint32El número de vistas previas adicionales asociadas con el artículo del Workshop especificado.
Devuelve
0 si el
handle
de consulta de CGU no es válido o si el
index
está fuera de los límites.
GetQueryUGCNumKeyValueTags
uint32 GetQueryUGCNumKeyValueTags( UGCQueryHandle_t handle, uint32 index );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener 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.
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.
Luego puedes llamar a
GetQueryUGCKeyValueTag para obtener los detalles de cada etiqueta.
Devuelve: uint32El número de etiquetas de clave-valor asociadas con el artículo del Workshop especificado.
Devuelve
0 si el
handle
de consulta de 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 );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
pchURL | char * | Devuelve los metadatos copiándolo en esta cadena. |
cchURLSize | uint32 | El 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.
NOTA: Esta llamada debe realizarse solamente con el handle obtenido en el resultado de una llamada a
SteamUGCQueryCompleted_t ejecutada correctamente.
Puedes usar este 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 si se ejecuta correctamente, indica que
pchURL
se ha completado.
De lo contrario,
false si el
handle
de consulta de CGU no es válido o el
index
está fuera de los límites.
GetQueryUGCResult
bool GetQueryUGCResult( UGCQueryHandle_t handle, uint32 index, SteamUGCDetails_t *pDetails );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo para el que obtener la información. |
pDetails | SteamUGCDetails_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.
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 si se ejecuta correctamente, indica que
pDetails
se ha completado.
De lo contrario,
false si el
handle
de consulta de CGU no es válido o el
index
está fuera de los límites.
GetQueryUGCStatistic
bool GetQueryUGCStatistic( UGCQueryHandle_t handle, uint32 index, EItemStatistic eStatType, uint64 *pStatValue );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU del que obtener los resultados. |
index | uint32 | Índice del artículo del que obtener la información. |
eStatType | EItemStatistic | Estadística que hay que recuperar. |
pStatValue | uint64 * | 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 si se ejecuta correctamente, indica que
pStatValue
se ha completado.
De lo contrario,
false si el
handle
de la consulta de CGU no es válido, el
index
está fuera de los límites, o
eStatType
no fue válido.
GetSubscribedItems
uint32 GetSubscribedItems( PublishedFileId_t*pvecPublishedFileID, uint32 cMaxEntries );
Nombre | Tipo | Descripción |
pvecPublishedFileID | PublishedFileId_t * | La matriz en la que se copiarán los identificadores de los artículos. |
cMaxEntries | uint32 | El 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 añadieron a
pvecPublishedFileID
.
Devuelve
0 si se llama desde un servidor de juegos.
GetUserItemVote
SteamAPICall_t GetUserItemVote( PublishedFileId_t nPublishedFileID );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El 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 a
GetUserItemVoteResult_t.
Véase también: SetUserItemVoteReleaseQueryUGCRequest
bool ReleaseQueryUGCRequest( UGCQueryHandle_t handle );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El 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 );
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 a
RemoveAppDependencyResult_t.
Véase también: AddAppDependencyRemoveDependency
SteamAPICall_t RemoveDependency( PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID );
Nombre | Tipo | Descripción |
nParentPublishedFileID | PublishedFileId_t | El artículo del Workshop para el que eliminar una dependencia. |
nChildPublishedFileID | PublishedFileId_t | La 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: AddDependencyRemoveItemFromFavorites
SteamAPICall_t RemoveItemFromFavorites( AppId_t nAppId, PublishedFileId_t nPublishedFileID );
Nombre | Tipo | Descripción |
nAppId | AppId_t | El id. de aplicación al que pertenece este artículo. |
nPublishedFileID | PublishedFileId_t | El artículo del Workshop que se 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: AddItemToFavoritesRemoveItemKeyValueTags
bool RemoveItemKeyValueTags( UGCUpdateHandle_t handle, const char *pchKey );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | El handle de actualización del artículo del Workshop que se va a personalizar. |
pchKey | const 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, tendrás que realizar actualizaciones adicionales 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: AddItemKeyValueTagRemoveItemPreview
bool RemoveItemPreview( UGCUpdateHandle_t handle, uint32 index );
Devuelve: bool
AddContentDescriptor
bool AddContentDescriptor( UGCUpdateHandle_t handle, EUGCContentDescriptorID descid );
Establece el
EUGCContentDescriptorID dado en el artículo.
Devuelve: bool
Véase también: GetQueryUGCContentDescriptors,
RemoveContentDescriptorRemoveContentDescriptor
bool RemoveContentDescriptor( UGCUpdateHandle_t handle, EUGCContentDescriptorID descid );
Elimina el
EUGCContentDescriptorID dado del artículo.
Devuelve: bool
Véase también: GetQueryUGCContentDescriptors,
AddContentDescriptorRequestUGCDetails
SteamAPICall_t RequestUGCDetails( PublishedFileId_t nPublishedFileID, uint32 unMaxAgeSeconds );
OBSOLETO! Usa
CreateQueryUGCDetailsRequest en su lugar.
Devuelve: SteamAPICall_t, que se usa con un resultado de la llamada a
SteamUGCRequestUGCDetailsResult_t.
SendQueryUGCRequest
SteamAPICall_t SendQueryUGCRequest( UGCQueryHandle_t handle );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El 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,
AddRequiredKeyValueTagDevuelve: SteamAPICall_t, que se usa con un resultado de la llamada a
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 );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
unMaxAgeSeconds | uint32 | Tiempo 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 el
handle
de la consulta de CGU no es válido.
SetCloudFileNameFilter
bool SetCloudFileNameFilter( UGCQueryHandle_t handle, const char *pMatchCloudFileName );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
pMatchCloudFileName | const 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 );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | Handle de actualización del artículo del Workshop que se va a personalizar. |
pszContentFolder | const 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 );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | El handle de actualización del artículo del Workshop que se va a personalizar. |
pchDescription | const 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: SetReturnLongDescriptionSetItemMetadata
bool SetItemMetadata( UGCUpdateHandle_t handle, const char *pchMetaData );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | El handle de actualización del artículo del Workshop que se va a personalizar. |
pchMetaData | const 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: SetReturnMetadataSetItemPreview
bool SetItemPreview( UGCUpdateHandle_t handle, const char *pszPreviewFile );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | El handle de actualización del artículo del Workshop que se va a personalizar. |
pszPreviewFile | const 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.
Cerció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 );
Nombre | Tipo | Descripción |
updateHandle | UGCUpdateHandle_t | El handle de actualización del artículo del Workshop que se va a personalizar. |
pTags | const 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,
SetMatchAnyTagSetItemTitle
bool SetItemTitle( UGCUpdateHandle_t handle, const char *pchTitle );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | El handle de actualización del artículo del Workshop que se va a personalizar. |
pchTitle | const 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 consulta de CGU no es válido.
SetItemUpdateLanguage
bool SetItemUpdateLanguage( UGCUpdateHandle_t handle, const char *pchLanguage );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | El handle de actualización del artículo del Workshop que se va a personalizar. |
pchLanguage | const 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 consulta de CGU no es válido.
Véase también: SetItemTitle,
SetItemDescription,
SetLanguageSetItemVisibility
bool SetItemVisibility( UGCUpdateHandle_t handle, ERemoteStoragePublishedFileVisibility eVisibility );
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 consulta de CGU no es válido.
SetLanguage
bool SetLanguage( UGCQueryHandle_t handle, const char *pchLanguage );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
pchLanguage | const 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 el
handle
de la consulta de CGU no es válido.
Véase también: SetItemUpdateLanguageSetMatchAnyTag
bool SetMatchAnyTag( UGCQueryHandle_t handle, bool bMatchAnyTag );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
bMatchAnyTag | bool | ¿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 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.
Véase también: AddRequiredTag,
AddExcludedTag,
SetItemTagsSetRankedByTrendDays
bool SetRankedByTrendDays( UGCQueryHandle_t handle, uint32 unDays );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
unDays | uint32 | Establece 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 );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
bReturnAdditionalPreviews | bool | ¿Devolver las previsualizaciones adicionales para los artículos? |
Establece si se devuelve cualquier imagen o vídeo 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 el
handle
de la consulta de CGU no es válido.
SetReturnChildren
bool SetReturnChildren( UGCQueryHandle_t handle, bool bReturnChildren );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
bReturnChildren | bool | ¿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 el
handle
de la consulta de CGU no es válido.
SetReturnKeyValueTags
bool SetReturnKeyValueTags( UGCQueryHandle_t handle, bool bReturnKeyValueTags );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
bReturnKeyValueTags | bool | ¿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 el
handle
de la consulta de CGU no es válido.
SetReturnLongDescription
bool SetReturnLongDescription( UGCQueryHandle_t handle, bool bReturnLongDescription );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
bReturnLongDescription | bool | ¿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 de CGU usando
SendQueryUGCRequest.
Devuelve: bool
true si se ejecuta correctamente.
false si el
handle
de la consulta de CGU no es válido.
Véase también: SetItemDescriptionSetReturnMetadata
bool SetReturnMetadata( UGCQueryHandle_t handle, bool bReturnMetadata );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
bReturnMetadata | bool | ¿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 de CGU usando
SendQueryUGCRequest.
Devuelve: bool
true si se ejecuta correctamente.
false si el
handle
de la consulta de CGU no es válido.
Véase también: SetItemMetadataSetReturnOnlyIDs
bool SetReturnOnlyIDs( UGCQueryHandle_t handle, bool bReturnOnlyIDs );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
bReturnOnlyIDs | bool | ¿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 consulta de CGU no es válido o proviene de
CreateQueryUGCDetailsRequest.
SetReturnPlaytimeStats
bool SetReturnPlaytimeStats( UGCQueryHandle_t handle, uint32 unDays );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
unDays | uint32 | El 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 el
handle
de la consulta de CGU no es válido.
SetReturnTotalOnly
bool SetReturnTotalOnly( UGCQueryHandle_t handle, bool bReturnTotalOnly );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
bReturnTotalOnly | bool | ¿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 );
Nombre | Tipo | Descripción |
handle | UGCQueryHandle_t | El handle de consulta de CGU que se va a personalizar. |
pSearchText | const 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 );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El id. del artículo de Workshop por el que se vota. |
bVoteUp | bool | ¿Votar a favor (true) o en contra (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: GetUserItemVoteStartItemUpdate
UGCUpdateHandle_t StartItemUpdate( AppId_t nConsumerAppId, PublishedFileId_t nPublishedFileID );
Nombre | Tipo | Descripción |
nConsumerAppId | AppId_t | El id. de aplicación que utilizará este artículo. |
nPublishedFileID | PublishedFileId_t | El 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 utilizar 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,
RemoveItemPreviewStartPlaytimeTracking
SteamAPICall_t StartPlaytimeTracking( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs );
Nombre | Tipo | Descripción |
pvecPublishedFileID | PublishedFileId_t * | La matriz de artículos del Workshop de los que se quiere empezar a hacer seguimiento. (Máximo de 100 artículos). |
unNumPublishedFileIDs | uint32 | El número de elementos 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 a
StartPlaytimeTrackingResult_t.
Devuelve
k_uAPICallInvalid si
pvecPublishedFileID
es
NULL o
unNumPublishedFileIDs
es menor que
1 o mayor que
100.
Véase también: StopPlaytimeTracking,
StopPlaytimeTrackingForAllItemsStopPlaytimeTracking
SteamAPICall_t StopPlaytimeTracking( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs );
Nombre | Tipo | Descripción |
pvecPublishedFileID | PublishedFileId_t * | La matriz de artículos del Workshop de los que se quiere empezar a hacer seguimiento. (Máximo de 100 artículos). |
unNumPublishedFileIDs | uint32 | El número de elementos 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 a
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 a
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 );
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 );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | Handle de actualización que se va a enviar. |
pchChangeNote | const 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 );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El 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: SubscribeItemSuspendDownloads
void SuspendDownloads( bool bSuspend );
Nombre | Tipo | Descripción |
bSuspend | bool | ¿Suspender (true) o Reanudar (false) descargas del Workshop? |
Suspende y reanuda todas las descargas del Workshop.
Si realizas esta llamada con
bSuspend
establecido como
true, las descargas se suspenderán hasta que las reanudes estableciendo
bSuspend
como
false o cuando la partida termine.
UnsubscribeItem
SteamAPICall_t UnsubscribeItem( PublishedFileId_t nPublishedFileID );
Nombre | Tipo | Descripción |
nPublishedFileID | PublishedFileId_t | El artículo de Workshop del que darse de baja. |
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: UnsubscribeItemUpdateItemPreviewFile
bool UpdateItemPreviewFile( UGCUpdateHandle_t handle, uint32 index, const char *pszPreviewFile );
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 consulta de CGU no es válido.
Véase también: AddItemPreviewFileUpdateItemPreviewVideo
bool UpdateItemPreviewVideo( UGCUpdateHandle_t handle, uint32 index, const char *pszVideoID );
Nombre | Tipo | Descripción |
handle | UGCUpdateHandle_t | El handle de actualización del artículo del Workshop que se va a personalizar. |
index | uint32 | El índice del archivo de vista previa de 0 a GetQueryUGCNumAdditionalPreviews. |
pszVideoID | const char * | El vídeo de YouTube que se va a añadir (por ejemplo, «jHgZh4GV9G0»). |
Actualiza otra vista previa del vídeo 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 consulta de CGU no es válido.
Véase también: AddItemPreviewVideoShowWorkshopEULA
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: GetWorkshopEULAStatusGetWorkshopEULAStatus
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_tVéase también: WorkshopEULAStatus_t,
ShowWorkshopEULAFunciones callback
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.
Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado de la operación. |
m_nPublishedFileId | PublishedFileId_t | Artículo principal del Workshop al que se añadió la dependencia. |
m_nAppID | AppId_t | La aplicación o el DLC. |
Funciones asociadas: AddAppDependencyAddUGCDependencyResult_t
El resultado de una llamada a
AddDependency.
Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado de la operación. |
m_nPublishedFileId | PublishedFileId_t | Artículo principal del Workshop al que se añadió la dependencia. |
m_nChildPublishedFileId | PublishedFileId_t | El artículo secundario del Workshop que se añadió como dependencia al artículo principal. |
Funciones asociadas: AddDependencyCreateItemResult_t
Se llama cuando se ha creado un nuevo artículo del Workshop.
Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado 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 bloqueo por VAC o un bloqueo de desarrollador activo.
- 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 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 elemento 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_nPublishedFileId | PublishedFileId_t | Id. único del nuevo artículo. |
m_bUserNeedsToAcceptWorkshopLegalAgreement | bool | ¿El usuario debe aceptar el acuerdo legal de Steam Workshop (true) o no (false)? Consulta Acuerdo legal de Workshop para obtener más información. |
Funciones asociadas: CreateItemDownloadItemResult_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.
Nombre | Tipo | Descripción |
m_unAppID | AppId_t | Id. de aplicación asociado a este artículo del Workshop. |
m_nPublishedFileId | PublishedFileId_t | Artículo del Workshop que se ha terminado de descargar. |
m_eResult | EResult | Resultado de la operación. |
Funciones asociadas: DownloadItemGetAppDependenciesResult_t
Se realiza esta llamada al obtener las dependencias de aplicación para un artículo.
Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado de la operación. |
m_nPublishedFileId | PublishedFileId_t | Artículo del Workshop cuyas dependencias de aplicación se quieren obtener. |
m_rgAppIDs | AppId_t | Matriz de dependencias de la aplicación. |
m_nNumAppDependencies | uint32 | Número de dependencias de aplicaciones devueltas en m_rgAppIDs |
m_nTotalNumAppDependencies | uint32 | Total de dependencias de aplicación encontradas. |
Funciones asociadas: GetAppDependenciesDeleteItemResult_t
Se realiza esta llamada cuando se completa un intento de eliminar un elemento.
Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado de la operación. |
m_nPublishedFileId | PublishedFileId_t | El artículo del Workshop que estaba siendo eliminado. |
Funciones asociadas: DeleteItemGetUserItemVoteResult_t
Se realiza esta llamada al obtener el estado del voto de los usuarios para un artículo.
Nombre | Tipo | Descripción |
m_nPublishedFileId | PublishedFileId_t | Artículo del Workshop del que se desea obtener el estado del voto. |
m_eResult | EResult | Resultado de la operación. |
m_bVotedUp | bool | ¿Ha votado el usuario a favor del artículo? |
m_bVotedDown | bool | ¿Ha votado el usuario en contra del artículo? |
m_bVoteSkipped | bool | ¿Se ha saltado el usuario la votación de este artículo? |
Funciones asociadas: GetUserItemVoteItemInstalled_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.
Nombre | Tipo | Descripción |
m_unAppID | AppId_t | Id. de aplicación asociado a este artículo del Workshop. |
m_nPublishedFileId | PublishedFileId_t | Artí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.
Nombre | Tipo | Descripción |
m_eResult | EResult | El resultado de la operación. |
m_nPublishedFileId | PublishedFileId_t | Artículo principal del Workshop cuya dependencia se eliminó. |
m_nAppID | AppId_t | La aplicación o el DLC. |
Funciones asociadas: RemoveAppDependencyRemoveUGCDependencyResult_t
Propósito: El resultado de una llamada a
RemoveDependency.
Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado de la operación. |
m_nPublishedFileId | PublishedFileId_t | Artículo principal del Workshop cuya dependencia se eliminó. |
m_nChildPublishedFileId | PublishedFileId_t | Artículo secundario del Workshop que se eliminó como dependencia del artículo principal. |
Funciones asociadas: RemoveDependencySetUserItemVoteResult_t
Se realiza esta llamada cuando el usuario ha votado por un artículo.
Nombre | Tipo | Descripción |
m_nPublishedFileId | PublishedFileId_t | Artículo del Workshop por el que votó el usuario. |
m_eResult | EResult | Resultado de la operación. |
m_bVoteUp | bool | ¿Fue el voto a favor (true) o en contra (false)? |
Funciones asociadas: SetUserItemVoteStartPlaytimeTrackingResult_t
Se realiza esta llamada cuando ha comenzado el seguimiento del tiempo de juego de un artículo del Workshop.
Nombre | Tipo | Descripción |
m_eResult | EResult | El resultado de la operación. |
Funciones asociadas: StartPlaytimeTrackingSteamUGCQueryCompleted_t
Se realiza esta llamada cuando se completa una consulta de CGU.
Nombre | Tipo | Descripción |
m_handle | UGCQueryHandle_t | Handle de la consulta de CGU asociada con el resultado de la llamada. |
m_eResult | EResult | Resultado de la operación. |
m_unNumResultsReturned | uint32 | El número de artículos devueltos en este conjunto de resultados. |
m_unTotalMatchingResults | uint32 | El número total de artículos que coincidieron con la consulta en la base de datos. |
m_bCachedData | bool | Indica si estos datos se obtuvieron de la caché del disco local. |
Funciones asociadas: SendQueryUGCRequestSteamUGCRequestUGCDetailsResult_t
OBSOLETO: Resultado anterior de una llamada a
RequestUGCDetails.
Funciones asociadas: RequestUGCDetailsStopPlaytimeTrackingResult_t
Se realiza esta llamada cuando se ha detenido el seguimiento del tiempo de juego de un artículo del Workshop.
Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado de la operación. |
Funciones asociadas: StopPlaytimeTracking,
StopPlaytimeTrackingForAllItemsSubmitItemUpdateResult_t
Se realiza esta llamada cuando se ha completado la actualización de un artículo.
Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado de la operación. Algunos de los posibles valores devueltos son:
- k_EResultOK: la operación se completó con éxito.
- k_EResultFail: fallo genérico.
- k_EResultInvalidParam: el id. de aplicación proporcionado no es válido o no coincide con el id. de aplicación del consumidor del artículo o no has habilitado ISteamUGC para el id. de aplicación proporcionado en la página de administración de la aplicación Configuración de Steam Workshop
El archivo de vista previa tiene un tamaño inferior a 16 bytes. - k_EResultAccessDenied: el usuario no posee una licencia para el id. de aplicación proporcionado.
- k_EResultFileNotFound: no se pudo obtener la información del Workshop para el artículo o no se pudo leer el archivo de vista previa.
- k_EResultLockingFailed: no se pudo obtener el bloqueo de CGU.
- k_EResultFileNotFound: la carpeta de contenido provista no es válida.
- k_EResultLimitExceeded: la imagen de la vista previa es demasiado grande (debe tener un tamaño inferior a 1 megabyte) o no hay suficiente espacio disponible para el usuario en Steam Cloud.
|
m_bUserNeedsToAcceptWorkshopLegalAgreement | bool | ¿El usuario debe aceptar el acuerdo legal de Steam Workshop? Consulta Acuerdo legal de Workshop para obtener más información. |
Funciones asociadas: SubmitItemUpdateUserFavoriteItemsListChanged_t
Se realiza esta llamada cuando el usuario ha añadido un artículo a su lista de favoritos o lo ha eliminado de ella.
Nombre | Tipo | Descripción |
m_nPublishedFileId | PublishedFileId_t | El artículo que se añadió o eliminó. |
m_eResult | EResult | Resultado de la operación. |
m_bWasAddRequest | bool | ¿Se añadió a los favoritos del usuario (true) o se eliminó de ellos (false)? |
Funciones asociadas: AddItemToFavorites,
RemoveItemFromFavoritesUserSubscribedItemsListChanged_t
Se llama cuando el usuario ha añadido o eliminado un artículo de sus suscripciones para el id. de aplicación devuelto.
Nombre | Tipo | Descripción |
m_nAppID | AppId_t | El id. de aplicación relacionado. |
Funciones asociadas: SubscribeItem,
UnsubscribeItemWorkshopEULAStatus_t
Función callback devuelta
GetWorkshopEULAStatus Nombre | Tipo | Descripción |
m_eResult | EResult | Resultado de la operación. |
m_nAppID | AppId_t | El id. de aplicación relacionado. |
m_unVersion | uint32 | La versión del ALUF firmado, si es aplicable. |
m_rtAction | RTime32 | Marca de tiempo Unix del momento en el que el usuario firmó el ALUF, si corresponde. |
m_bAccepted | valor booleano | True 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_bNeedsAction | valor booleano | True cuando el usuario necesita aceptar el ALUF del Workshop más reciente; de lo contrario, false. |
Funciones asociadas: GetWorkshopEULAStatusStructs
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.
Nombre | Tipo | Descripción |
m_nPublishedFileId | PublishedFileId_t | Handle exclusivo globalmente de este CGU. |
m_eResult | EResult | Resultado de la operación. |
m_eFileType | EWorkshopFileType | El tipo de artículo. |
m_nCreatorAppID | AppId_t | Id. de la aplicación que creó este artículo. |
m_nConsumerAppID | AppId_t | Id. de la aplicación que consumirá este artículo. |
m_rgchTitle | char[[apitype]ISteamRemoteStorage::k_cchPublishedDocumentTitleMax[/apitype]] | El título del artículo. |
m_rgchDescription | char[[apitype]ISteamRemoteStorage::k_cchPublishedDocumentDescriptionMax[/apitype]] | La descripción del artículo. |
m_ulSteamIDOwner | uint64 | Id. de Steam del usuario que creó este contenido. |
m_rtimeCreated | uint32 | Momento en que se creó el artículo publicado, expresado en formato de tiempo Unix (tiempo transcurrido desde el 1 de enero de 1970). |
m_rtimeUpdated | uint32 | Momento 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_rtimeAddedToUserList | uint32 | Momento en que el usuario añadió 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_eVisibility | ERemoteStoragePublishedFileVisibility | Visibilidad del artículo. |
m_bBanned | bool | Indica si el artículo está bloqueado o no. |
m_bAcceptedForUse | bool | Indica 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_bTagsTruncated | bool | Indica si la lista de etiquetas era demasiado larga como para devolverla al búfer proporcionado y si se ha truncado debido a ello. |
m_rgchTags | char[[apitype]ISteamRemoteStorage::k_cchTagListMax[/apitype]] | Lista de todas las etiquetas asociadas con este artículo, separadas por comas. |
m_hFile | UGCHandle_t | Handle del archivo principal. |
m_hPreviewFile | UGCHandle_t | Handle del archivo de previsualización. |
m_pchFileName | char[[apitype]ISteamRemoteStorage::k_cchFilenameMax[/apitype]] | Nombre en la nube del archivo principal. |
m_nFileSize | int32 | El tamaño del archivo principal. |
m_nPreviewFileSize | int32 | El tamaño del archivo de previsualización. |
m_rgchURL | char[[apitype]ISteamRemoteStorage::k_cchPublishedFileURLMax[/apitype]] | El URL asociado a este artículo. (Para un vídeo o un sitio web). |
m_unVotesUp | uint32 | Número de votos positivos. |
m_unVotesDown | uint32 | Número de votos negativos. |
m_flScore | float | Media bayesiana de votos positivos / votos totales, entre 0 y 1. |
m_unNumChildren | uint32 | Nú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.
Nombre | Valor | Descripción |
k_EItemPreviewType_Image | 0 | Archivo de imagen estándar visible en web. Tipos de archivo compatibles: PNG, JPG y GIF. |
k_EItemPreviewType_YouTubeVideo | 1 | Id. del vídeo de YouTube (por ejemplo, «jHgZh4GV9G0»). |
k_EItemPreviewType_Sketchfab | 2 | Id. de modelo de Sketchfab. |
k_EItemPreviewType_EnvironmentMap_HorizontalCross | 3 | Archivo 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_LatLong | 4 | Archivo 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_ReservedMax | 255 | Reservado. 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.
Nombre | Valor | Descripción |
k_EItemStateNone | 0 | En el cliente no se hace el seguimiendo de este artículo. |
k_EItemStateSubscribed | 1 | El usuario actual está suscrito al artículo. No solo se almacena en la caché. |
k_EItemStateLegacyItem | 2 | Este artículo se creó con las antiguas funciones del Workshop en ISteamRemoteStorage. |
k_EItemStateInstalled | 4 | El artículo está instalado y se puede usar (pero podría estar desactualizado). |
k_EItemStateNeedsUpdate | 8 | Es necesario actualizar el artículo. El artículo aún no está instalado o el creador ha actualizado el contenido. |
k_EItemStateDownloading | 16 | La actualización del artículo se está descargando en este momento. |
k_EItemStateDownloadPending | 32 | Se 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.
Nombre | Valor | Descripción |
k_EItemStatistic_NumSubscriptions | 0 | Obtiene el número de suscripciones. |
k_EItemStatistic_NumFavorites | 1 | Obtiene el número de veces que el artículo se ha añadido a favoritos. |
k_EItemStatistic_NumFollowers | 2 | Obtiene el número de seguidores. |
k_EItemStatistic_NumUniqueSubscriptions | 3 | Obtiene el número de suscripciones únicas. |
k_EItemStatistic_NumUniqueFavorites | 4 | Obtiene el número de veces que el artículo se ha añadido a favoritos únicos. |
k_EItemStatistic_NumUniqueFollowers | 5 | Obtiene el número de seguidores únicos. |
k_EItemStatistic_NumUniqueWebsiteViews | 6 | Obtiene el número de visualizaciones únicas que tiene el artículo en su página de Steam Workshop. |
k_EItemStatistic_ReportScore | 7 | Obtiene el número de veces que alguien ha denunciado el artículo. |
k_EItemStatistic_NumSecondsPlayed | 8 | Obtiene el tiempo total de uso del artículo entre todos los usuarios (en segundos). |
k_EItemStatistic_NumPlaytimeSessions | 9 | Obtiene el número total de sesiones de juego en las que se ha utilizado el artículo. |
k_EItemStatistic_NumSecondsPlayedDuringTimePeriod | 11 | Obtiene el tiempo total de uso del artículo a lo largo del período especificado (en segundos). |
k_EItemStatistic_NumPlaytimeSessionsDuringTimePeriod | 12 | Obtiene el número de sesiones en las que se ha utilizado el artículo a lo largo del período especificado. |
EItemUpdateStatus
Especifica el estado de
UGCUpdateHandle_t después de una llamada a
GetItemUpdateProgress, devuelto por
GetItemUpdateProgress.
Nombre | Valor | Descripción |
k_EItemUpdateStatusInvalid | 0 | El 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_EItemUpdateStatusPreparingConfig | 1 | La actualización del artículo está procesando datos de configuración. |
k_EItemUpdateStatusPreparingContent | 2 | La actualización del artículo está leyendo y procesando archivos de contenido. |
k_EItemUpdateStatusUploadingContent | 3 | La actualización del artículo está cargando a Steam cambios de contenido. |
k_EItemUpdateStatusUploadingPreviewFile | 4 | La actualización del artículo está cargando una nueva imagen del archivo de previsualización. |
k_EItemUpdateStatusCommittingChanges | 5 | La 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.
Nombre | Valor | Descripción |
k_EUGCMatchingUGCType_Items | 0 | Artículos de microtransacciones y artículos listos para usar. |
k_EUGCMatchingUGCType_Items_Mtx | 1 | Artículos de microtransacciones (consulta: Mentores del Workshop). |
k_EUGCMatchingUGCType_Items_ReadyToUse | 2 | Habitual en artículos de juegos cargados por los jugadores (consulta: Listo para usar en el Workshop). |
k_EUGCMatchingUGCType_Collections | 3 | Colecciones compartidas de CGU. |
k_EUGCMatchingUGCType_Artwork | 4 | Material gráfico compartido. |
k_EUGCMatchingUGCType_Videos | 5 | Videos compartidos. |
k_EUGCMatchingUGCType_Screenshots | 6 | Capturas de pantalla compartidas. |
k_EUGCMatchingUGCType_AllGuides | 7 | Guías web y guías integradas. |
k_EUGCMatchingUGCType_WebGuides | 8 | Guías disponibles solo para la comunidad de Steam. |
k_EUGCMatchingUGCType_IntegratedGuides | 9 | Guías que se pueden usar dentro del juego (como las guías de personajes de Dota 2). |
k_EUGCMatchingUGCType_UsableInGame | 10 | Guías integradas y artículos listos para usarse. |
k_EUGCMatchingUGCType_ControllerBindings | 11 | Asignaciones de mandos que se han compartido. |
k_EUGCMatchingUGCType_GameManagedItems | 12 | Artículos gestionados por el juego (no por los usuarios). |
k_EUGCMatchingUGCType_All | ~0 | Lo devuelve todo. |
EUGCQuery
Se usa con
CreateQueryAllUGCRequest para especificar el orden y los filtros de las consultas en todo el CGU disponible.
Nombre | Valor | Descripción |
k_EUGCQuery_RankedByVote | 0 | Ordenar por número de votos (total acumulado). |
k_EUGCQuery_RankedByPublicationDate | 1 | Ordenar por fecha de publicación, en orden descendente. |
k_EUGCQuery_AcceptedForGameRankedByAcceptanceDate | 2 | Ordenar por fecha de aceptación (para artículos mtx). |
k_EUGCQuery_RankedByTrend | 3 | Ordenar por número de votos dentro del período de «tendencia» determinado (establecer en SetRankedByTrendDays). |
k_EUGCQuery_FavoritedByFriendsRankedByPublicationDate | 4 | Filtrar por artículos favoritos de los amigos del usuario, ordenados por fecha descendente de publicación. |
k_EUGCQuery_CreatedByFriendsRankedByPublicationDate | 5 | Filtrar por artículos creados por amigos (ordenados por fecha de publicación descendente). |
k_EUGCQuery_RankedByNumTimesReported | 6 | Ordenar por cantidad de denuncias, en orden descendente. |
k_EUGCQuery_CreatedByFollowedUsersRankedByPublicationDate | 7 | Filtrar por artículos de los usuarios que el usuario actual ha seguido, ordenado por fecha de publicación descendente. |
k_EUGCQuery_NotYetRated | 8 | Filtrado a la cola de votación del usuario. |
k_EUGCQuery_RankedByTotalVotesAsc | 9 | Ordenar por número total de votos de forma ascendente (usado internamente para crear la cola de votación del usuario). |
k_EUGCQuery_RankedByVotesUp | 10 | Ordenar por número de votos positivos, en orden descendente. Utilizará el período de «tendencia» si se especifica (establecido en SetRankedByTrendDays). |
k_EUGCQuery_RankedByTextSearch | 11 | Ordenar por relevancia de las palabras claves de la búsqueda. |
k_EUGCQuery_RankedByTotalUniqueSubscriptions | 12 | Ordenar por número total acumulado de suscriptores únicos, en orden descendente. |
k_EUGCQuery_RankedByPlaytimeTrend | 13 | Ordenar de forma descendente por tiempo total de juego en el período de «tendencia» (establecido con SetRankedByTrendDays). |
k_EUGCQuery_RankedByTotalPlaytime | 14 | Ordenar por tiempo de juego total acumulado, en orden descendente. |
k_EUGCQuery_RankedByAveragePlaytimeTrend | 15 | Ordenar de forma descendente por tiempo medio de juego en el período de «tendencia» (establecido en SetRankedByTrendDays). |
k_EUGCQuery_RankedByLifetimeAveragePlaytime | 16 | Ordenar por tiempo de juego medio a lo largo de su duración en orden descendente. |
k_EUGCQuery_RankedByPlaytimeSessionsTrend | 17 | Ordenar de forma descendente por número de sesiones de juego en el período de «tendencia» (establecido en SetRankedByTrendDays). |
k_EUGCQuery_RankedByLifetimePlaytimeSessions | 18 | Ordenar por número de sesiones de juego a lo largo de su duración en orden descendente. |
k_EUGCQuery_RankedByLastUpdatedDate | 19 | Ordenar por la fecha de la última actualización. |
EUserUGCList
Se usa con
CreateQueryUserUGCRequest para obtener diferentes listas de CGU publicado por un usuario.
EUserUGCListSortOrder
Se usa con
CreateQueryUserUGCRequest para especificar el criterio de ordenación de las listas de CGU publicadas por el usuario. De forma predeterminada, se organiza por orden de creación descendente.
Nombre | Valor | Descripción |
k_EUserUGCListSortOrder_CreationOrderDesc | 0 | Devuelve 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_CreationOrderAsc | 1 | Devuelve 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_TitleAsc | 2 | Devuelve los artículos por nombre. (Se corresponde con «sortmethod=alpha» en la página del Workshop). |
k_EUserUGCListSortOrder_LastUpdatedDesc | 3 | Devuelve los artículos actualizados más recientemente primero. (Se corresponde con «sortmethod=lastupdated» en la página del Workshop). |
k_EUserUGCListSortOrder_SubscriptionDateDesc | 4 | Devuelve los artículos que han recibido suscripciones más recientemente primero. (Se corresponde con «sortmethod=subscriptiondate» en la página del Workshop). |
k_EUserUGCListSortOrder_VoteScoreDesc | 5 | Devuelve los artículos cuya valoración se ha actualizado más recientemente primero. (Se corresponde con «sortmethod=score» en la página del Workshop). |
k_EUserUGCListSortOrder_ForModeration | 6 | Devuelve 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.
Nombre | Valor | Descripción |
k_EUGCContentDescriptor_NudityOrSexualContent | 1 | Algún desnudo o contenido sexual: Incluye contenido con algún desnudo o temas sexuales, sin ser el enfoque principal. |
k_EUGCContentDescriptor_FrequentViolenceOrGore | 2 | Violencia o gore frecuentes: Incluye contenido que muestra violencia extrema o gore. |
k_EUGCContentDescriptor_AdultOnlySexualContent | 3 | Contenido 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_GratuitousSexualContent | 4 | Contenido 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_AnyMatureContent | 5 | Contenido 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.
Nombre | Tipo de base | Descripción |
UGCQueryHandle_t | uint64 | Un handle único para una consulta de CGU. Se usa al solicitar listas de artículos al Workshop. |
UGCUpdateHandle_t | uint64 | Un 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.
Nombre | Tipo | Valor | Descripción |
kNumUGCResultsPerPage | uint32 | 50 | Número máximo de resultados que se pueden recibir para una consulta. |
k_cchDeveloperMetadataMax | uint32 | 5000 | La cantidad máxima de bytes que puedes establecer con SetItemMetadata. |
k_UGCQueryHandleInvalid | UGCQueryHandle_t | 0xffffffffffffffffull | Se utiliza para especificar un handle de consulta no válido. Se suele devolver con frecuencia cuando falla una llamada. |
k_UGCUpdateHandleInvalid | UGCUpdateHandle_t | 0xffffffffffffffffull | Se 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_VERSION | const char * | «STEAMUGC_INTERFACE_VERSION015» | |