Documentación de Steamworks
Interfaz ISteamRemoteStorage
Aporta funciones de lectura, escritura y acceso a archivos que pueden almacenarse de forma remota en Steam Cloud.

Visita Steam Cloud para obtener más información.

Funciones miembro

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

BeginFileWriteBatch

bool BeginFileWriteBatch( );

Utiliza esta función junto con EndFileWriteBatch para encapsular un conjunto de escrituras o eliminaciones de archivos que deban considerarse parte de un solo cambio de estado. Por ejemplo, si para guardar el progreso en la partida es necesario actualizar tanto savegame1.dat como maxprogress.dat, encapsula estas operaciones con llamadas a BeginFileWriteBatch y EndFileWriteBatch.

Estas funciones aportan datos a Steam que facilitan la gestión de los archivos de la aplicación en Cloud. El uso de estas funciones es optativo, pero mejora la confiabilidad.

Recuerda que las funciones pueden utilizarse tanto si los cambios se realizan con la API ISteamRemoteStorage como directamente en el disco local (mediante Auto-Cloud).

Devuelve: bool
True si se inició el lote de escritura y false si había un lote ya en curso.

CommitPublishedFileUpdate

SteamAPICall_t CommitPublishedFileUpdate( PublishedFileUpdateHandle_t updateHandle );
NombreTipoDescripción
updateHandlePublishedFileUpdateHandle_t

Obsoleta: solo se utiliza con la API de Workshop basada en RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageUpdatePublishedFileResult_t.

CreatePublishedFileUpdateRequest

PublishedFileUpdateHandle_t CreatePublishedFileUpdateRequest( PublishedFileId_t unPublishedFileId );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t

Obsoleta: solo se utiliza con la API de Workshop basada en RemoteStorage.

Devuelve: PublishedFileUpdateHandle_t

DeletePublishedFile

SteamAPICall_t DeletePublishedFile( PublishedFileId_t unPublishedFileId );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t

Obsoleta: solo se utiliza con la API de Workshop basada en RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageDeletePublishedFileResult_t.

EndFileWriteBatch

bool EndFileWriteBatch( );

Utiliza esta función junto con BeginFileWriteBatch (consulta la documentación para obtener más información).

Devuelve: bool
true si se finalizó el lote de escritura y false si no había ningún lote en curso.

EnumeratePublishedFilesByUserAction

SteamAPICall_t EnumeratePublishedFilesByUserAction( EWorkshopFileAction eAction, uint32 unStartIndex );
NombreTipoDescripción
eActionEWorkshopFileAction
unStartIndexuint32

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageEnumeratePublishedFilesByUserActionResult_t.

EnumeratePublishedWorkshopFiles

SteamAPICall_t EnumeratePublishedWorkshopFiles( EWorkshopEnumerationType eEnumerationType, uint32 unStartIndex, uint32 unCount, uint32 unDays, SteamParamStringArray_t *pTags, SteamParamStringArray_t *pUserTags );
NombreTipoDescripción
eEnumerationTypeEWorkshopEnumerationType
unStartIndexuint32
unCountuint32
unDaysuint32
pTagsSteamParamStringArray_t *
pUserTagsSteamParamStringArray_t *

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

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

EnumerateUserPublishedFiles

SteamAPICall_t EnumerateUserPublishedFiles( uint32 unStartIndex );
NombreTipoDescripción
unStartIndexuint32

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para ser usado con un resultado de llamada RemoteStorageEnumerateUserPublishedFilesResult_t.

EnumerateUserSharedWorkshopFiles

SteamAPICall_t EnumerateUserSharedWorkshopFiles( CSteamID steamId, uint32 unStartIndex, SteamParamStringArray_t *pRequiredTags, SteamParamStringArray_t *pExcludedTags );
NombreTipoDescripción
steamIdCSteamID
unStartIndexuint32
pRequiredTagsSteamParamStringArray_t *
pExcludedTagsSteamParamStringArray_t *

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para ser usado con un resultado de llamada RemoteStorageEnumerateUserPublishedFilesResult_t.

EnumerateUserSubscribedFiles

SteamAPICall_t EnumerateUserSubscribedFiles( uint32 unStartIndex );
NombreTipoDescripción
unStartIndexuint32

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para ser usado con un resultado de llamada RemoteStorageEnumerateUserSubscribedFilesResult_t.

FileDelete

bool FileDelete( const char *pchFile );
NombreTipoDescripción
pchFileconst char *El nombre del archivo que será eliminado.

Borra un archivo del disco local y propaga esa eliminación a la nube.

Está pensada para usarse cuando un usuario borra un archivo de forma activa. Usa FileForget si deseas eliminar un archivo de Steam Cloud pero conservarlo en el disco local de los usuarios.

Cuando se ha eliminado un archivo, se puede volver a escribirlo con FileWrite para volver a cargarlo en Steam Cloud.

Devuelve: bool
true si el archivo existe y ha sido eliminado exitosamente; de lo contrario, false si el archivo no existía.

FileExists

bool FileExists( const char *pchFile );
NombreTipoDescripción
pchFileconst char *El nombre del archivo.

Comprueba si existe el archivo especificado.

Devuelve: bool
true si el archivo existe; de lo contrario, false.

FileFetch

bool FileFetch( const char *pchFile );
NombreTipoDescripción
pchFileconst char *

Obsoleta: solo para PS3.

Devuelve: bool

FileForget

bool FileForget( const char *pchFile );
NombreTipoDescripción
pchFileconst char *El nombre del archivo que será olvidado.

Borra el archivo del almacenamiento remoto, pero lo deja en el disco local y permanece accesible desde la API.

Cuando se acaba el espacio en la nube, puede usarse esta función para permitir llamadas a FileWrite para seguir trabajando sin necesidad de obligar al usuario a borrar archivos.

Elegir qué archivos hay que olvidar es decisión propia. Podría ser una mera cola de los menos usados recientemente (o LRU) o algo más complicado.

Aunque es posible exigir al usuario que gestione sus archivos en la nube para un juego, nunca se recomienda. Por ejemplo, "¿Qué archivo deseas borrar para almacenar el nuevo?" elimina una ventaja significativa propia del uso de la nube: su transparencia.

Una vez que se haya eliminado u olvidado un archivo, llamar a FileWrite lo volverá a sincronizar en la nube. La única forma de que un archivo olvidado vuelva a ser persistente es volviéndolo a escribir.

Devuelve: bool
true si el archivo existe y se ha olvidado correctamente; de lo contrario, false.

FilePersist

bool FilePersist( const char *pchFile );
NombreTipoDescripción
pchFileconst char *

Obsoleta: solo para PS3.

Devuelve: bool

FilePersisted

bool FilePersisted( const char *pchFile );
NombreTipoDescripción
pchFileconst char *El nombre del archivo.

Comprueba si un archivo específico persiste en Steam Cloud.

Devuelve: bool
true si el archivo existe y persiste en Steam Cloud.
false si se llamó FileForget y solo está disponible localmente.

FileRead

int32 FileRead( const char *pchFile, void *pvData, int32 cubDataToRead );
NombreTipoDescripción
pchFileconst char *El nombre del archivo para leer.
pvDatavoid *El búfer en el que se leerá el archivo. Este búfer debe tener al menos el mismo tamaño proporcionado a cubDataToRead.
cubDataToReadint32La cantidad de bytes para leer. Generalmente se obtiene de GetFileSize o de GetFileTimestamp.

Abre un archivo binario, lee el contenido en una matriz de bytes y, después, lo cierra.

NOTA: Esta es una llamada síncrona y, como tal, bloqueará el subproceso de llamada en la E/S del disco, así como SteamAPI, lo que puede hacer que otros subprocesos de la aplicación se bloqueen. Para evitar "hitching" debido a un disco ocupado en la máquina cliente usando FileReadAsync, se recomienda la versión asíncrona de esta API.

Devuelve: int32
El número de bytes leídos.

Devuelve 0 si el archivo no existe o la lectura falla.

FileReadAsync

SteamAPICall_t FileReadAsync( const char *pchFile, uint32 nOffset, uint32 cubToRead );
NombreTipoDescripción
pchFileconst char *El nombre del archivo para leer.
nOffsetuint32Desplazamiento en bytes dentro del archivo donde se iniciará la lectura. 0 si estás leyendo el archivo completo en un trozo.
cubToReaduint32La cantidad de bytes para leer comenzando desde nOffset.

Comienza una lectura asíncrona desde un archivo.

La compensación y la cantidad a leer deben ser válidas para el tamaño del archivo, según lo indicado por GetFileSize o por GetFileTimestamp.

Devuelve: SteamAPICall_t para usar con un resultado de llamada RemoteStorageFileReadAsyncComplete_t.
Devuelve k_uAPICallInvalid en las siguientes condiciones:
  • Se ha intentado leer de una ruta o nombre de archivo no válidos. Como Steam Cloud es multiplataforma, los archivos deben tener nombres válidos en todos los sistemas operativos y sistemas de archivos compatibles. Consulta la documentación de Microsoft en Nombrar archivos, rutas y espacios de nombres.
  • El archivo no existe.
  • cubDataToRead is <= 0 bytes. ¡Tiene que haber algo que leer!
  • La combinación de pvData y cubDataToRead se leerá más allá del final del archivo.
  • Ya tienes una llamada asíncrona en curso para este archivo.

Al completar la solicitud de lectura, recibirá el resultado de la llamada, si el valor de m_eResult dentro del resultado de la llamada es k_EResultOK, puedes llamar a FileReadAsyncComplete para leer los datos solicitados en tu búfer. El parámetro hReadCall debe coincidir con el valor de retorno de esta función y la cantidad a leer generalmente debe ser igual a la cantidad solicitada según lo indicado por m_nOffset y m_cubRead.

FileReadAsyncComplete

bool FileReadAsyncComplete( SteamAPICall_t hReadCall, void *pvBuffer, uint32 cubToRead );
NombreTipoDescripción
hReadCallSteamAPICall_tEl identificador del resultado de la llamada obtenido de RemoteStorageFileReadAsyncComplete_t.
pvBuffervoid *El búfer en el que se leerá el archivo.
cubToReaduint32Número de bytes por copiar. Por lo general, este debería ser el valor m_cubRead de RemoteStorageFileReadAsyncComplete_t

Copia los bytes de un archivo que se leyó de forma asíncrona con FileReadAsync en una matriz de bytes.

Esto nunca debe llamarse fuera del contexto de un resultado de llamada RemoteStorageFileReadAsyncComplete_t.

Devuelve: bool
true si el archivo se leyó correctamente.

De lo contrario, false bajo las siguientes condiciones:
  • El identificador pasado a hReadCall no es válido.
  • La lectura falló como lo indica m_eResult en RemoteStorageFileReadAsyncComplete_t, no deberías haber llamado a esto.
  • El búfer proporcionado a pvBuffer no es lo suficientemente grande.

FileShare

SteamAPICall_t FileShare( const char *pchFile );
NombreTipoDescripción
pchFileconst char *

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageFileShareResult_t.

FileWrite

bool FileWrite( const char *pchFile, const void *pvData, int32 cubData );
NombreTipoDescripción
pchFileconst char *El nombre del archivo en el que se va a escribir.
pvDataconst void *Los bytes para escribir en el archivo.
cubDataint32Número de bytes que hay que escribir en el archivo. Normalmente, el tamaño total de pvData.

Crea un nuevo archivo, escribe los bytes en dicho archivo y luego lo cierra. Si el archivo de destino ya existe, se sobrescribe.

NOTA: Esta es una llamada síncrona y, como tal, bloqueará el subproceso de llamada en la E/S del disco, así como SteamAPI, lo que puede hacer que otros subprocesos de la aplicación se bloqueen. Para evitar "hitching" debido a un disco ocupado en la máquina cliente usando FileWriteAsync, se recomienda la versión asíncrona de esta API.

Devuelve: bool
true si se escribió correctamente.

De lo contrario, false bajo las siguientes condiciones:
  • El archivo que estás intentando escribir es mayor que 100MiB como lo define k_unMaxCloudFileChunkSize.
  • cubData es menor que 0.
  • pvData es NULL.
  • Se intentó escribir en una ruta o un nombre de archivo no válidos. Como Steam Cloud es multiplataforma, los archivos deben tener nombres válidos en todos los sistemas operativos y sistemas de archivos compatibles. Consulta la documentación de Microsoft en Asignar nombres a archivos, rutas de acceso y espacios de nombres.
  • Se ha excedido la cuota de almacenamiento en Steam Cloud del usuario actual. Puede haberse quedado sin espacio o tener demasiados archivos.
  • Steam no pudo escribir en el disco; la ubicación podría ser de solo lectura.

FileWriteAsync

SteamAPICall_t FileWriteAsync( const char *pchFile, const void *pvData, uint32 cubData );
NombreTipoDescripción
pchFileconst char *El nombre del archivo en el que se va a escribir.
pvDataconst void *Los bytes para escribir en el archivo.
cubDatauint32Número de bytes que hay que escribir en el archivo. Normalmente, el tamaño total de pvData.

Crea un nuevo archivo y escribe de forma asíncrona los datos de bytes sin procesar en Steam Cloud; después, cierra el archivo. Si el archivo de destino ya existe, se sobrescribe.

Devuelve: SteamAPICall_t para usar con un RemoteStorageFileWriteAsyncComplete_t resultado de la llamada.
Devuelve k_uAPICallInvalid en las siguientes condiciones:
  • El archivo que estás intentando escribir es mayor que 100MiB como lo define k_unMaxCloudFileChunkSize.
  • cubData es menor que 0.
  • pvData es NULL.
  • Se intentó escribir en una ruta o un nombre de archivo no válidos. Como Steam Cloud es multiplataforma, los archivos deben tener nombres válidos en todos los sistemas operativos y sistemas de archivos compatibles. Consulta la documentación de Microsoft en Asignar nombres a archivos, rutas de acceso y espacios de nombres.
  • Se ha excedido la cuota de almacenamiento en Steam Cloud del usuario actual. Puede haberse quedado sin espacio o tener demasiados archivos.

FileWriteStreamCancel

bool FileWriteStreamCancel( UGCFileWriteStreamHandle_t writeHandle );
NombreTipoDescripción
writeHandleUGCFileWriteStreamHandle_tLa secuencia de escritura del archivo para cancelar.

Cancela una secuencia de escritura de archivos iniciada por FileWriteStreamOpen.

Además, elimina todos los datos escritos y cierra el flujo de escritura. Solo si ya hay un archivo existente con este nombre, permanecerá inalterado.

Devuelve: bool

FileWriteStreamClose

bool FileWriteStreamClose( UGCFileWriteStreamHandle_t writeHandle );
NombreTipoDescripción
writeHandleUGCFileWriteStreamHandle_tLa secuencia de escritura del archivo para cerrar.

Cierra una secuencia de escritura de archivos iniciada por FileWriteStreamOpen.

Esto envía el flujo al disco y sobrescribe el archivo existente si lo había.

Devuelve: bool
true si el flujo de escritura del archivo se cerró correctamente y el archivo está en el disco.
False si writeHandle no es una secuencia de escritura de archivo válida.

FileWriteStreamOpen

UGCFileWriteStreamHandle_t FileWriteStreamOpen( const char *pchFile );
NombreTipoDescripción
pchFileconst char *El nombre del archivo en el que se va a escribir.

Crea un nuevo flujo de salida de archivo que permite transmitir datos a Steam Cloud en bloques. Si el archivo de destino ya existe, no se sobrescribe hasta que se haya llamado FileWriteStreamClose.

Para escribir datos en esta secuencia puedes usar FileWriteStreamWriteChunk, y luego para cerrar o cancelar usa FileWriteStreamClose y FileWriteStreamCancel respectivamente.

Devuelve: UGCFileWriteStreamHandle_t
Devuelve k_UGCFileStreamHandleInvalid en las siguientes condiciones:
  • Se intentó escribir en una ruta o un nombre de archivo no válidos. Como Steam Cloud es multiplataforma, los archivos deben tener nombres válidos en todos los sistemas operativos y sistemas de archivos compatibles. Consulta la documentación de Microsoft en Asignar nombres a archivos, rutas de acceso y espacios de nombres.
  • Se ha excedido la cuota de almacenamiento en Steam Cloud del usuario actual. Puede haberse quedado sin espacio o tener demasiados archivos.

FileWriteStreamWriteChunk

bool FileWriteStreamWriteChunk( UGCFileWriteStreamHandle_t writeHandle, const void *pvData, int32 cubData );
NombreTipoDescripción
writeHandleUGCFileWriteStreamHandle_tLa secuencia de escritura del archivo para escribir.
pvDataconst void *Los datos para escribir en la cadena.
cubDataint32El tamaño de pvData en bytes.

Escribe un "blob" de datos en el flujo de escritura de archivo.

Devuelve: bool
true si los datos se escribieron correctamente en el flujo de escritura de archivo.
false si writeHandle no es un flujo de escritura de archivo válido, cubData es negativo o mayor que k_unMaxCloudFileChunkSize o se ha excedido la cuota de almacenamiento actual del usuario Steam Cloud. Puede haberse quedado sin espacio o tener demasiados archivos.

GetCachedUGCCount

int32 GetCachedUGCCount();

Devuelve: int32

GetCachedUGCHandle

UGCHandle_t GetCachedUGCHandle( int32 iCachedContent );
NombreTipoDescripción
iCachedContentint32

Devuelve: UGCHandle_t

GetFileCount

int32 GetFileCount();
Obtiene el número total de archivos locales sincronizados por Steam Cloud.

Se usa para la enumeración con GetFileNameAndSize.

Devuelve: int32
La cantidad de archivos presentes para el usuario actual, incluidos los archivos en subcarpetas.

GetFileListFromServer

void GetFileListFromServer();
Obsoleta: solo para PS3.

GetFileNameAndSize

const char * GetFileNameAndSize( int iFile, int32 *pnFileSizeInBytes );
NombreTipoDescripción
iFileintEl índice del archivo, debe estar entre 0 y GetFileCount.
pnFileSizeInBytesint32 *Devuelve el tamaño del archivo en bytes.

Obtiene el nombre y tamaño de un archivo del índice.

NOTA: Debes llamar GetFileCount primero para obtener el número de archivos.

Devuelve: const char *
El nombre del archivo en el índice especificado, si existe. Devuelve una cadena vacía ("") si el archivo no existe.

Ejemplo:
int32 fileCount = SteamRemoteStorage()->GetFileCount(); for ( int i = 0; i < fileCount; ++i ) { int32 fileSize; const char *fileName = SteamRemoteStorage()->GetFileNameAndSize( i, &fileSize ); // Haz algo con fileSize y fileName }

GetFileSize

int32 GetFileSize( const char *pchFile );
NombreTipoDescripción
pchFileconst char *El nombre del archivo.

Obtiene el tamaño de los archivos especificados en bytes.

Devuelve: int32
El tamaño del archivo en bytes. Devuelve 0 si el archivo no existe.

GetFileTimestamp

int64 GetFileTimestamp( const char *pchFile );
NombreTipoDescripción
pchFileconst char *El nombre del archivo.

Obtiene la marca de tiempo de la última modificación del archivo especificado en formato de tiempo Unix (segundos transcurridos desde el 1.° de enero de 1970).

Devuelve: int64
La última marca de tiempo modificada en formato de época de Unix (segundos desde el 1.° de enero de 1970).

GetLocalFileChangeCount

int32 GetLocalFileChangeCount( );

Nota: Aplicable solo a las aplicaciones marcadas como compatibles con la sincronización dinámica con Steam Cloud.

Si tu aplicación recibe una función callback RemoteStorageLocalFileChange_t, utiliza este método para obtener el número de cambios (archivos actualizados y eliminados) realizados. Puedes iterar los cambios con GetLocalFileChange.

Devuelve: int32
El número de cambios que se hicieron en archivos locales.

GetLocalFileChange

const char *GetLocalFileChange( int iFile, ERemoteStorageLocalFileChange *pEChangeType, ERemoteStorageFilePathType *pEFilePathType );

Nota: Aplicable solo a las aplicaciones marcadas como compatibles con la sincronización dinámica con Steam Cloud.

Después de llamar a GetLocalFileChangeCount, utiliza este método para iterar los cambios. Los cambios descritos ya se han realizado en los archivos locales. La aplicación debería realizar las acciones oportunas para volver a cargar el estado a partir del disco y, probablemente, notificar al usuario.

Ejemplo: Mientras el sistema local estaba suspendido, el usuario jugó en otra parte y subió los cambios a Steam Cloud. Al reanudar el sistema, Steam descarga los cambios al sistema local antes de reanudar la aplicación. La aplicación recibe la función callback RemoteStorageLocalFileChange_t, y utiliza GetLocalFileChangeCount y GetLocalFileChange para iterar los cambios. Dependiendo de la estructura de la aplicación y la naturaleza de los cambios, la aplicación puede:

  • volver a cargar el progreso en la partida para reanudarla en el punto exacto en el que se encontraba el usuario cuando salió del juego en el otro dispositivo;
  • notificar al usuario sobre los cambios sincronizados que no requieren una recarga,
  • etc.


NombreTipoDescripción
iFileint32Índice de base cero del cambio.
pEChangeTypeERemoteStorageLocalFileChange¿Qué ha sucedido con este archivo?
pEFilePathTypeERemoteStorageFilePathTypeTipo de ruta para el archivo devuelto

Devuelve: const char *
Nombre del archivo o ruta completa del archivo afectado por este cambio. Ver arriba los comentarios sobre pEFilePathType para obtener más detalles.

GetPublishedFileDetails

SteamAPICall_t GetPublishedFileDetails( PublishedFileId_t unPublishedFileId, uint32 unMaxSecondsOld );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t
unMaxSecondsOlduint32

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageGetPublishedFileDetailsResult_t.

GetPublishedItemVoteDetails

SteamAPICall_t GetPublishedItemVoteDetails( PublishedFileId_t unPublishedFileId );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageGetPublishedItemVoteDetailsResult_t.

GetQuota

bool GetQuota( uint64 *pnTotalBytes, uint64 *puAvailableBytes );
NombreTipoDescripción
pnTotalBytesuint64 *Devuelve la cantidad total de bytes a los que el usuario tiene acceso.
puAvailableBytesuint64 *Devuelve el número de bytes disponibles.

Obtiene el número de bytes disponibles y utilizados en el almacenamiento de Steam Cloud de los usuarios.

Devuelve: bool
Siempre devuelve true.

GetSyncPlatforms

ERemoteStoragePlatform GetSyncPlatforms( const char *pchFile );
NombreTipoDescripción
pchFileconst char *El nombre del archivo.

Obtiene las plataformas con que se sincronizará el archivo especificado.

Devuelve: ERemoteStoragePlatform
Campo de bits que contiene las plataformas en las que se estableció el archivo con SetSyncPlatforms.

GetUGCDetails

bool GetUGCDetails( UGCHandle_t hContent, AppId_t *pnAppID, char **ppchName, int32 *pnFileSizeInBytes, CSteamID *pSteamIDOwner );
NombreTipoDescripción
hContentUGCHandle_t
pnAppIDAppId_t *
ppchNamechar **
pnFileSizeInBytesint32 *
pSteamIDOwnerCSteamID *

Devuelve: bool

GetUGCDownloadProgress

bool GetUGCDownloadProgress( UGCHandle_t hContent, int32 *pnBytesDownloaded, int32 *pnBytesExpected );
NombreTipoDescripción
hContentUGCHandle_t
pnBytesDownloadedint32 *
pnBytesExpectedint32 *

Devuelve: bool

GetUserPublishedItemVoteDetails

SteamAPICall_t GetUserPublishedItemVoteDetails( PublishedFileId_t unPublishedFileId );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageGetPublishedItemVoteDetailsResult_t.

IsCloudEnabledForAccount

bool IsCloudEnabledForAccount();
Comprueba si la configuración de Steam Cloud para la cuenta está habilitada para este usuario, o si se deshabilitó en el cuadro de diálogo Configuración y Cloud.

Asegúrate de que también esté verificando IsCloudEnabledForApp, ya que estas dos opciones se excluyen mutuamente.

Devuelve: bool
true si Steam Cloud está habilitado para esta cuenta; de lo contrario, false.

IsCloudEnabledForApp

bool IsCloudEnabledForApp();
Comprueba si la configuración de Steam Cloud por juego está habilitada para este usuario, o si se deshabilitó en el cuadro de diálogo Propiedades del juego y Actualización.

Asegúrate de que también esté verificando IsCloudEnabledForAccount, ya que estas dos opciones se excluyen mutuamente.

Por lo general, se recomienda que se permita que el usuario pueda activar o desactivar este ajuste dentro de las opciones del juego. Puede hacerse con SetCloudEnabledForApp.

Devuelve: bool
true si Steam Cloud está habilitado para esta aplicación; de lo contrario, false.

PublishVideo

SteamAPICall_t PublishVideo( EWorkshopVideoProvider eVideoProvider, const char *pchVideoAccount, const char *pchVideoIdentifier, const char *pchPreviewFile, AppId_t nConsumerAppId, const char *pchTitle, const char *pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, SteamParamStringArray_t *pTags );
NombreTipoDescripción
eVideoProviderEWorkshopVideoProvider
pchVideoAccountconst char *
pchVideoIdentifierconst char *
pchPreviewFileconst char *
nConsumerAppIdAppId_t
pchTitleconst char *
pchDescriptionconst char *
eVisibilityERemoteStoragePublishedFileVisibility
pTagsSteamParamStringArray_t *

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStoragePublishFileProgress_t.

PublishWorkshopFile

SteamAPICall_t PublishWorkshopFile( const char *pchFile, const char *pchPreviewFile, AppId_t nConsumerAppId, const char *pchTitle, const char *pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, SteamParamStringArray_t *pTags, EWorkshopFileType eWorkshopFileType );
NombreTipoDescripción
pchFileconst char *
pchPreviewFileconst char *
nConsumerAppIdAppId_t
pchTitleconst char *
pchDescriptionconst char *
eVisibilityERemoteStoragePublishedFileVisibility
pTagsSteamParamStringArray_t *
eWorkshopFileTypeEWorkshopFileType

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStoragePublishFileProgress_t.

ResetFileRequestState

bool ResetFileRequestState();
Obsoleta: solo para PS3.

Devuelve: bool

SetCloudEnabledForApp

void SetCloudEnabledForApp( bool bEnabled );
NombreTipoDescripción
bEnabledbool¿Activar (true) o desactivar (false) Steam Cloud para esta aplicación?

Activa o desactiva Steam Cloud para la aplicación.

Esta configuración se puede consultar con IsCloudEnabledForApp.

NOTA: Debe utilizarse únicamente como resultado directo de que el usuario solicite explícitamente que se active o se desactive. Suele ofrecerse mediante una marca de verificación dentro de las opciones del juego.

SetSyncPlatforms

bool SetSyncPlatforms( const char *pchFile, ERemoteStoragePlatform eRemoteStoragePlatform );
NombreTipoDescripción
pchFileconst char *El nombre del archivo.
eRemoteStoragePlatformERemoteStoragePlatformLas plataformas con las que se sincronizará el archivo.

Permite especificar con qué sistemas operativos se sincronizará un archivo.

Se utiliza en el caso de un juego multiplataforma, pero con datos incompatibles entre plataformas.

Los archivos predeterminados en k_ERemoteStoragePlatformAll cuando se crean por primera vez. Puedes utilizar el operador OR a nivel de bit, "|" para especificar multiples plataformas.

Devuelve: bool
true si el archivo existe, de lo contrario "false".

SetUserPublishedFileAction

SteamAPICall_t SetUserPublishedFileAction( PublishedFileId_t unPublishedFileId, EWorkshopFileAction eAction );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t
eActionEWorkshopFileAction

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageSetUserPublishedFileActionResult_t.

SubscribePublishedFile

SteamAPICall_t SubscribePublishedFile( PublishedFileId_t unPublishedFileId );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada RemoteStorageSubscribePublishedFileResult_t.

UGCDownload

SteamAPICall_t UGCDownload( UGCHandle_t hContent, uint32 unPriority );
NombreTipoDescripción
hContentUGCHandle_t
unPriorityuint32

Devuelve: SteamAPICall_t para usar con un resultado de llamada RemoteStorageDownloadUGCResult_t.

UGCDownloadToLocation

SteamAPICall_t UGCDownloadToLocation( UGCHandle_t hContent, const char *pchLocation, uint32 unPriority );
NombreTipoDescripción
hContentUGCHandle_t
pchLocationconst char *
unPriorityuint32

Devuelve: SteamAPICall_t para usar con un resultado de llamada RemoteStorageDownloadUGCResult_t.

UGCRead

int32 UGCRead( UGCHandle_t hContent, void *pvData, int32 cubDataToRead, uint32 cOffset, EUGCReadAction eAction );
NombreTipoDescripción
hContentUGCHandle_t
pvDatavoid *
cubDataToReadint32
cOffsetuint32
eActionEUGCReadAction

Devuelve: int32

UnsubscribePublishedFile

SteamAPICall_t UnsubscribePublishedFile( PublishedFileId_t unPublishedFileId );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t

Obsoleta: solo se utiliza con la API de Workshop basada en RemoteStorage.

Devuelve: SteamAPICall_t para usar con un resultado de llamada RemoteStorageUnsubscribePublishedFileResult_t.

UpdatePublishedFileDescription

bool UpdatePublishedFileDescription( PublishedFileUpdateHandle_t updateHandle, const char *pchDescription );
NombreTipoDescripción
updateHandlePublishedFileUpdateHandle_t
pchDescriptionconst char *

Obsoleta: solo se utiliza con la API de Workshop basada en RemoteStorage.

Devuelve: bool

UpdatePublishedFileFile

bool UpdatePublishedFileFile( PublishedFileUpdateHandle_t updateHandle, const char *pchFile );
NombreTipoDescripción
updateHandlePublishedFileUpdateHandle_t
pchFileconst char *

Obsoleta: solo se utiliza con la API de Workshop basada en RemoteStorage.

Devuelve: bool

UpdatePublishedFilePreviewFile

bool UpdatePublishedFilePreviewFile( PublishedFileUpdateHandle_t updateHandle, const char *pchPreviewFile );
NombreTipoDescripción
updateHandlePublishedFileUpdateHandle_t
pchPreviewFileconst char *

Obsoleta: solo se utiliza con la API de Workshop basada en RemoteStorage.

Devuelve: bool

UpdatePublishedFileSetChangeDescription

bool UpdatePublishedFileSetChangeDescription( PublishedFileUpdateHandle_t updateHandle, const char *pchChangeDescription );
NombreTipoDescripción
updateHandlePublishedFileUpdateHandle_t
pchChangeDescriptionconst char *

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: bool

UpdatePublishedFileTags

bool UpdatePublishedFileTags( PublishedFileUpdateHandle_t updateHandle, SteamParamStringArray_t *pTags );
NombreTipoDescripción
updateHandlePublishedFileUpdateHandle_t
pTagsSteamParamStringArray_t *

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: bool

UpdatePublishedFileTitle

bool UpdatePublishedFileTitle( PublishedFileUpdateHandle_t updateHandle, const char *pchTitle );
NombreTipoDescripción
updateHandlePublishedFileUpdateHandle_t
pchTitleconst char *

Obsoleta: solo se utiliza con la API de Workshop basada en RemoteStorage.

Devuelve: bool

UpdatePublishedFileVisibility

bool UpdatePublishedFileVisibility( PublishedFileUpdateHandle_t updateHandle, ERemoteStoragePublishedFileVisibility eVisibility );
NombreTipoDescripción
updateHandlePublishedFileUpdateHandle_t
eVisibilityERemoteStoragePublishedFileVisibility

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: bool

UpdateUserPublishedItemVote

SteamAPICall_t UpdateUserPublishedItemVote( PublishedFileId_t unPublishedFileId, bool bVoteUp );
NombreTipoDescripción
unPublishedFileIdPublishedFileId_t
bVoteUpbool

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

Devuelve: SteamAPICall_t para usar con un resultado de llamada RemoteStorageUpdateUserPublishedItemVoteResult_t.

Funciones 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 ISteamRemoteStorage.

RemoteStorageAppSyncedClient_t

Obsoleta: solo para PS3.

NombreTipoDescripción
m_nAppIDAppId_t
m_eResultEResult
m_unNumDownloadsint

RemoteStorageAppSyncedServer_t

Obsoleta: solo para PS3.

NombreTipoDescripción
m_nAppIDAppId_t
m_eResultEResult
m_unNumUploadsint

RemoteStorageAppSyncProgress_t

Obsoleta: solo para PS3.

NombreTipoDescripción
m_rgchCurrentFilechar[k_cchFilenameMaxArchivo actual que está siendo transferido.
m_nAppIDAppId_tAplicación a la que se refiere la información.
m_uBytesTransferredThisChunkuint32Bytes transferidos en este segmento.
m_dAppPercentCompletedoblePorcentaje completado de las transferencias de esta aplicación.
m_bUploadingboolsi es "false", descargando.

RemoteStorageAppSyncStatusCheck_t

Obsoleta: solo para PS3.

NombreTipoDescripción
m_nAppIDAppId_t
m_eResultEResult

RemoteStorageDeletePublishedFileResult_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_t

Funciones asociadas: DeletePublishedFile

RemoteStorageDownloadUGCResult_t


NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_hFileUGCHandle_tHandle del archivo que se intentó descargar.
m_nAppIDAppId_tId. de la aplicación que creó el archivo.
m_nSizeInBytesint32Tamaño del archivo descargado, en bytes.
m_pchFileNamechar[k_cchFilenameMaxNombre del archivo descargado.
m_ulSteamIDOwneruint64Id. de Steam del usuario que creó este contenido.

Funciones asociadas: UGCDownload, UGCDownloadToLocation

RemoteStorageEnumeratePublishedFilesByUserActionResult_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación
m_eActionEWorkshopFileActionAcción filtrada en
m_nResultsReturnedint32
m_nTotalResultCountint32
m_rgPublishedFileIdPublishedFileId_tk_unEnumeratePublishedFilesMaxResults
m_rgRTimeUpdateduint32k_unEnumeratePublishedFilesMaxResults

Funciones asociadas: EnumeratePublishedFilesByUserAction

RemoteStorageEnumerateUserPublishedFilesResult_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nResultsReturnedint32
m_nTotalResultCountint32
m_rgPublishedFileIdPublishedFileId_tk_unEnumeratePublishedFilesMaxResults

Funciones asociadas: EnumerateUserPublishedFiles, EnumerateUserSharedWorkshopFiles

RemoteStorageEnumerateUserSharedWorkshopFilesResult_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nResultsReturnedint32
m_nTotalResultCountint32
m_rgPublishedFileIdPublishedFileId_tk_unEnumeratePublishedFilesMaxResults

RemoteStorageEnumerateUserSubscribedFilesResult_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nResultsReturnedint32
m_nTotalResultCountint32
m_rgPublishedFileIdPublishedFileId_tk_unEnumeratePublishedFilesMaxResults
m_rgRTimeSubscribeduint32k_unEnumeratePublishedFilesMaxResults

Funciones asociadas: EnumerateUserSubscribedFiles

RemoteStorageEnumerateWorkshopFilesResult_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_eResultEResult
m_nResultsReturnedint32
m_nTotalResultCountint32
m_rgPublishedFileIdPublishedFileId_tk_unEnumeratePublishedFilesMaxResults
m_rgScorefloat[k_unEnumeratePublishedFilesMaxResults
m_nAppIdAppId_t
m_unStartIndexuint32

Funciones asociadas: EnumeratePublishedWorkshopFiles

RemoteStorageFileReadAsyncComplete_t

Respuesta al leer un archivo de forma asíncrona con FileReadAsync.

NombreTipoDescripción
m_hFileReadAsyncSteamAPICall_tEl identificador de llamada de la lectura asíncrona que se realizó, se debe pasar a FileReadAsyncComplete para obtener los datos.
m_eResultEResultEl resultado de la operación.
Si la lectura local fue exitosa, esto será k_EResultOK, luego puedes llamar a FileReadAsyncComplete para obtener los datos.
m_nOffsetuint32Desplazamiento en el archivo donde estaba esta lectura.
m_cubReaduint32Cantidad de bytes leídos: será <= la cantidad solicitada.

Funciones asociadas: FileReadAsync

RemoteStorageFileShareResult_t


NombreTipoDescripción
m_eResultEResultEl resultado de la operación
m_hFileUGCHandle_tHandle que puede compartirse con usuarios y características.
m_rgchFilenamechar[k_cchFilenameMaxNombre del archivo compartido.

Funciones asociadas: FileShare

RemoteStorageFileWriteAsyncComplete_t

Respuesta al escribir un archivo de forma asíncrona con FileWriteAsync.

NombreTipoDescripción
m_eResultEResultEl resultado de la operación.
Si la escritura local fue exitosa, entonces esto será k_EResultOK; cualquier otro valor probablemente indica que el nombre del archivo no es válido o que la escritura disponible hubiera excedido la cuota disponible. Cualquier intento de escribir archivos que excedan este tamaño devolverá un EResult de k_EResultInvalidParam. La escritura de archivos en la nube no puede superar los 100 MiB.

Funciones asociadas: FileWriteAsync

RemoteStorageGetPublishedFileDetailsResult_t

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage, también obsoleta.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_t
m_nCreatorAppIDAppId_tId. de la aplicación que creó el archivo.
m_nConsumerAppIDAppId_tId. de la aplicación que consumirá el archivo.
m_rgchTitlechar[k_cchPublishedDocumentTitleMaxtítulo del documento.
m_rgchDescriptionchar[k_cchPublishedDocumentDescriptionMaxdescripción del documento.
m_hFileUGCHandle_tHandle del archivo principal
m_hPreviewFileUGCHandle_tHandle del archivo de previsualización
m_ulSteamIDOwneruint64Id. de Steam del usuario que creó este contenido.
m_rtimeCreateduint32Hora de creación del archivo.
m_rtimeUpdateduint32Hora de la última actualización del archivo publicado.
m_eVisibilityERemoteStoragePublishedFileVisibility
m_bBannedbool
m_rgchTagschar[k_cchTagListMaxlista de todas las etiquetas asociadas con este artículo, separadas por comas.
m_bTagsTruncatedboolIndica si la lista de etiquetas era demasiado larga para ser devuelta en el búfer dado.
m_pchFileNamechar[k_cchFilenameMaxEl nombre del archivo primario.
m_nFileSizeint32Tamaño del archivo primario.
m_nPreviewFileSizeint32Tamaño del archivo de vista previa.
m_rgchURLchar[k_cchPublishedFileURLMaxURL (para un video o un sitio web).
m_eFileTypeEWorkshopFileTypeTipo de archivo
m_bAcceptedForUseboolIndica si el desarrollador ha marcado este elemento específicamente como aceptado en Workshop.

Funciones asociadas: GetPublishedFileDetails

RemoteStorageGetPublishedItemVoteDetailsResult_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_eResultEResult
m_unPublishedFileIdPublishedFileId_t
m_nVotesForint32
m_nVotesAgainstint32
m_nReportsint32
m_fScorefloat

Funciones asociadas: GetPublishedItemVoteDetails, GetUserPublishedItemVoteDetails

RemoteStorageLocalFileChange_t

Si una applicación de Steam está marcada como compatible con la sincronización dinámica con Steam Cloud y se produce una sincronización, se envía esta función callback a la aplicación cuando cambia algún archivo local.

Funciones asociadas: GetLocalFileChangeCount, GetLocalFileChange

RemoteStoragePublishedFileDeleted_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_nPublishedFileIdPublishedFileId_tId. del archivo publicado.
m_nAppIDAppId_tId. de la aplicación que consumirá el archivo.

RemoteStoragePublishedFileSubscribed_t


NombreTipoDescripción
m_nPublishedFileIdPublishedFileId_tId. del archivo publicado.
m_nAppIDAppId_tId. de la aplicación que consumirá el archivo.

RemoteStoragePublishedFileUnsubscribed_t


NombreTipoDescripción
m_nPublishedFileIdPublishedFileId_tId. del archivo publicado.
m_nAppIDAppId_tId. de la aplicación que consumirá el archivo.

RemoteStoragePublishedFileUpdated_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_nPublishedFileIdPublishedFileId_tId. del archivo publicado.
m_nAppIDAppId_tId. de la aplicación que consumirá el archivo.
m_ulUnuseduint64Ya no se usa.

RemoteStoragePublishFileProgress_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_dPercentFiledoble
m_bPreviewbool

Funciones asociadas: PublishWorkshopFile, PublishVideo

RemoteStoragePublishFileResult_t

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_t
m_bUserNeedsToAcceptWorkshopLegalAgreementbool

RemoteStorageSetUserPublishedFileActionResult_t

Obsoleta: solo se usa con la API de Workshop basada en la obsoleta RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_tId. del archivo publicado.
m_eActionEWorkshopFileActionAcción que se intentó realizar.

Funciones asociadas: SetUserPublishedFileAction

RemoteStorageSubscribePublishedFileResult_t

Se llama cuando el usuario se ha suscrito a un elemento de CGU. El resultado de ISteamUGC::SubscribeItem.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_tArtículo de Workshop al que se ha suscrito el usuario.

Funciones asociadas: SubscribePublishedFile

RemoteStorageUnsubscribePublishedFileResult_t

Se llama cuando el usuario ha cancelado su suscripción a algún elemento de CGU. El resultado de ISteamUGC::UnsubscribeItem.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_tArtículo de Workshop al que ha dejado de estar suscrito el usuario.

Funciones asociadas: UnsubscribePublishedFile

RemoteStorageUpdatePublishedFileResult_t

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_t
m_bUserNeedsToAcceptWorkshopLegalAgreementbool

Funciones asociadas: CommitPublishedFileUpdate

RemoteStorageUpdateUserPublishedItemVoteResult_t

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
m_nPublishedFileIdPublishedFileId_tId. del archivo publicado.

Funciones asociadas: UpdateUserPublishedItemVote

RemoteStorageUserVoteDetails_t

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

NombreTipoDescripción
m_eResultEResultEl resultado de la operación.
m_nPublishedFileIdPublishedFileId_tId. del archivo publicado.
m_eVoteEWorkshopVoteLo que ha votado el usuario.

Structs

Estas son estructuras que las funciones de ISteamRemoteStorage pueden devolver o con las que pueden interactuar.

SteamParamStringArray_t


NombreTipoDescripción
m_ppStringsconst char **Matriz de cadenas.
m_nNumStringsint32El número de cadenas que están en [param]m_ppStrings[/param].

Enums

Estas son las enumeraciones definidas para usarse con ISteamRemoteStorage.

ERemoteStorageLocalFileChange

Formas en que Steam puede cambiar un archivo local durante la sesión de la aplicación. Ver GetLocalFileChange.

NombreValorDescripción
k_ERemoteStorageLocalFileChange_Invalid0Sin usar.
k_ERemoteStorageLocalFileChange_FileUpdated1El contenido del archivo ha cambiado.
k_ERemoteStorageLocalFileChange_FileDeleted2El archivo se ha eliminado.

ERemoteStorageFilePathType

Para las API que pueden devolver rutas de archivos de diferentes formas. Ver GetLocalFileChange.

NombreValorDescripción
k_ERemoteStorageFilePathType_Invalid0Sin usar.
k_ERemoteStorageFilePathType_Absolute1Se proporciona una ruta de acceso al disco absoluta. Este tipo de ruta se utiliza para los archivos gestionados mediante Auto-Cloud.
k_ERemoteStorageFilePathType_APIFilename2Se proporciona una ruta relativa de la API ISteamRemoteStorage. Este tipo de ruta se utiliza para los archivos gestionados mediante los métodos de la API ISteamRemoteStorage (FileWrite, FileRead, etc.).

ERemoteStoragePlatform

Sincronizar marcas de plataformas. Se pueden usar con SetSyncPlatforms para restringir un archivo a un sistema operativo específico.

NombreValorDescripción
k_ERemoteStoragePlatformNone0Este archivo no se descargará en ninguna plataforma.
k_ERemoteStoragePlatformWindows(1 << 0)Este archivo se descargará en Windows.
k_ERemoteStoragePlatformOSX(1 << 1)Este archivo se descargará en macOS.
k_ERemoteStoragePlatformPS3(1 << 2)Este archivo se descargará en PlayStation®3.
k_ERemoteStoragePlatformLinux(1 << 3)Este archivo se descargará en SteamOS/Linux.
k_ERemoteStoragePlatformReserved2(1 << 4)Reservado.
k_ERemoteStoragePlatformAll0xffffffffEste archivo se descargará en todas las plataformas. Este es el valor predeterminado.

ERemoteStoragePublishedFileVisibility

Estados de visibilidad en los que puede estar un artículo de Workshop.

NombreValorDescripción
k_ERemoteStoragePublishedFileVisibilityPublic0Visible para todos.
k_ERemoteStoragePublishedFileVisibilityFriendsOnly1Visible solo para los amigos.
k_ERemoteStoragePublishedFileVisibilityPrivate2Visible solo para su creador. Marcar un artículo de Workshop como privado es lo más parecido que se puede hacer a borrarlo de la API.
k_ERemoteStoragePublishedFileVisibilityUnlisted3Visible para todos, pero no aparece en ninguna consulta global.
Tampoco aparece en ninguna lista de usuarios, excepto si quien realiza la llamada es el creador o un suscriptor.

EUGCReadAction

Posibles acciones de lectura de CGU utilizadas con UGCRead.

NombreValorDescripción
k_EUGCRead_ContinueReadingUntilFinished0Mantiene abierto el identificador o handle del archivo hasta que se ha leído el último byte. Puedes usar esto cuando leas archivos grandes (más de 100 MB) en fragmentos secuenciales.
Si se lee el último byte, se comportará igual que k_EUGCRead_Close. De lo contrario, se comporta de la misma forma que k_EUGCRead_ContinueReading.
Este valor mantiene el mismo comportamiento que antes de la introducción del parámetro EUGCReadAction.
k_EUGCRead_ContinueReading1Mantiene abierto el handle del archivo. Usa esto cuando uses UGCRead para buscar diferentes partes del archivo.
Cuando hayas terminado de buscar alrededor del archivo, haz una llamada final con k_EUGCRead_Close para cerrarla.
k_EUGCRead_Close2Libera el handle del archivo. Usa esto cuando hayas terminado de leer el contenido.
Para volver a leer el archivo de Steam, deberás volver a llamar a UGCDownload.

EWorkshopEnumerationType

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

NombreValorDescripción
k_EWorkshopEnumerationTypeRankedByVote0
k_EWorkshopEnumerationTypeRecent1
k_EWorkshopEnumerationTypeTrending2
k_EWorkshopEnumerationTypeFavoritesOfFriends3
k_EWorkshopEnumerationTypeVotedByFriends4
k_EWorkshopEnumerationTypeContentByFriends5
k_EWorkshopEnumerationTypeRecentFromFollowedUsers6

EWorkshopFileAction

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

NombreValorDescripción
k_EWorkshopFileActionPlayed0El usuario ha jugado con o en este objeto. (por ejemplo, cargado un arma o nivel).
k_EWorkshopFileActionCompleted1El usuario ha completado este artículo (por ejemplo, llegar al final de un mapa lineal).

EWorkshopFileType

Cómo se comparte un archivo compartido con la comunidad.

NombreValorDescripción
k_EWorkshopFileTypeFirst0Se utiliza solo para enumeraciones.
k_EWorkshopFileTypeCommunity0Elemento de Workshop susceptible de suscripción.
k_EWorkshopFileTypeMicrotransaction1Artículo de Workshop sobre el que se puede votar a efectos de venta en el juego. (Consulta: Mentores de Workshop).
k_EWorkshopFileTypeCollection2Una colección de elementos de Workshop.
k_EWorkshopFileTypeArt3Artwork.
k_EWorkshopFileTypeVideo4Video externo.
k_EWorkshopFileTypeScreenshot5Captura.
k_EWorkshopFileTypeGame6No se usa. Antes se usaba para entradas de juegos de Greenlight.
k_EWorkshopFileTypeSoftware7No se usa. Antes se usaba para entradas de software de Greenlight.
k_EWorkshopFileTypeConcept8No se usa. Antes se usaba para conceptos de software de Greenlight.
k_EWorkshopFileTypeWebGuide9Guía web de Steam.
k_EWorkshopFileTypeIntegratedGuide10Guía integrada en la aplicación.
k_EWorkshopFileTypeMerch11Artículos de Workshop sobre los que se puede votar a efectos de venta.
k_EWorkshopFileTypeControllerBinding12Configuraciones del Steam Controller.
k_EWorkshopFileTypeSteamworksAccessInvite13Solo se usa internamente en Steam.
k_EWorkshopFileTypeSteamVideo14Steam Video.
k_EWorkshopFileTypeGameManagedItem15Lo gestiona completamente el juego, no el usuario, y no aparece en la web.
k_EWorkshopFileTypeMax16Se utiliza solo para enumeraciones.

EWorkshopVideoProvider

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

NombreValorDescripción
k_EWorkshopVideoProviderNone0El artículo no tiene video.
k_EWorkshopVideoProviderYoutube1El artículo tiene un video de YouTube.

EWorkshopVote

Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.

NombreValorDescripción
k_EWorkshopVoteUnvoted0El usuario no ha votado.
k_EWorkshopVoteFor1El usuario ha votado a favor de este artículo.
k_EWorkshopVoteAgainst2El usuario ha votado en contra de este artículo.
k_EWorkshopVoteLater3El usuario ha optado por votar en otro momento.

Typedefs

Estas son las definiciones de tipo establecidas para usarse con ISteamRemoteStorage.

NombreTipo de baseDescripción
PublishedFileId_tuint64Un identificador o handle único para un artículo de Workshop individual.
PublishedFileUpdateHandle_tuint64Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.
UGCFileWriteStreamHandle_tuint64Identificador o handle que se usa al escribir de manera asíncrona en Steam Cloud.
UGCHandle_tuint64Identificador o handle único de un artículo de contenido generado por los usuarios.

Constantes

Estas son constantes que se definen para usar con ISteamRemoteStorage.

NombreTipoValorDescripción
k_cchFilenameMaxuint32260Longitud máxima para la ruta de acceso de un archivo de Steam Cloud.
k_cchPublishedDocumentChangeDescriptionMaxuint328000Sin usar.
k_cchPublishedDocumentDescriptionMaxuint328000Tamaño máximo (en bytes) de la descripción de un artículo de Workshop.
k_cchPublishedDocumentTitleMaxuint32128 + 1Tamaño máximo (en bytes) del título de un artículo de Workshop.
k_cchPublishedFileURLMaxuint32256Tamaño máximo (en bytes) de la URL de un artículo de Workshop.
k_cchTagListMaxuint321024 + 1Tamaño máximo (en bytes) de la lista de etiquetas separadas por comas de un artículo de Workshop.
k_PublishedFileIdInvalidPublishedFileId_t0Identificador o handle de un artículo de Workshop no válido.
k_PublishedFileUpdateHandleInvalidPublishedFileUpdateHandle_t0xffffffffffffffffullObsoleta: solo se usa con la API de Workshop basada en RemoteStorage.
k_UGCFileStreamHandleInvalidUGCFileWriteStreamHandle_t0xffffffffffffffffullSe devuelve cuando se produce un error al usar FileWriteStreamOpen.
k_UGCHandleInvalidUGCHandle_t0xffffffffffffffffullUn identificador de CGU no válido. Suelen devolverlo las funciones al indicar un error.
k_unEnumeratePublishedFilesMaxResultsuint3250Obsoleta: solo se usa con la API de Workshop basada en RemoteStorage.
k_unMaxCloudFileChunkSizeuint32100 * 1024 * 1024Define el tamaño de archivo permitido más grande para Steam Cloud.
Los archivos en la nube no pueden escribirse en un solo fragmento de más de 100MiB y no pueden tener más de 200MiB en total.
STEAMREMOTESTORAGE_INTERFACE_VERSIONconst char *"STEAMREMOTESTORAGE_INTERFACE_VERSION014"