mirror of
https://github.com/Detanup01/gbe_fork.git
synced 2024-10-22 20:48:17 +08:00
implement undocumented interfaces ISteamRemoteStorage015 + ISteamUGC011
This commit is contained in:
a
parent
b8869b60b0
commit
e8d36b3353
@ -77,6 +77,7 @@ public ISteamRemoteStorage011,
|
|||||||
public ISteamRemoteStorage012,
|
public ISteamRemoteStorage012,
|
||||||
public ISteamRemoteStorage013,
|
public ISteamRemoteStorage013,
|
||||||
public ISteamRemoteStorage014,
|
public ISteamRemoteStorage014,
|
||||||
|
public ISteamRemoteStorage015,
|
||||||
public ISteamRemoteStorage
|
public ISteamRemoteStorage
|
||||||
{
|
{
|
||||||
private:
|
private:
|
||||||
|
|||||||
@ -44,6 +44,7 @@ public ISteamUGC007,
|
|||||||
public ISteamUGC008,
|
public ISteamUGC008,
|
||||||
public ISteamUGC009,
|
public ISteamUGC009,
|
||||||
public ISteamUGC010,
|
public ISteamUGC010,
|
||||||
|
public ISteamUGC011,
|
||||||
public ISteamUGC012,
|
public ISteamUGC012,
|
||||||
public ISteamUGC013,
|
public ISteamUGC013,
|
||||||
public ISteamUGC014,
|
public ISteamUGC014,
|
||||||
|
|||||||
@ -573,9 +573,8 @@ ISteamRemoteStorage *Steam_Client::GetISteamRemoteStorage( HSteamUser hSteamuser
|
|||||||
return reinterpret_cast<ISteamRemoteStorage *>(static_cast<ISteamRemoteStorage013 *>(steam_remote_storage));
|
return reinterpret_cast<ISteamRemoteStorage *>(static_cast<ISteamRemoteStorage013 *>(steam_remote_storage));
|
||||||
} else if (strcmp(pchVersion, "STEAMREMOTESTORAGE_INTERFACE_VERSION014") == 0) {
|
} else if (strcmp(pchVersion, "STEAMREMOTESTORAGE_INTERFACE_VERSION014") == 0) {
|
||||||
return reinterpret_cast<ISteamRemoteStorage *>(static_cast<ISteamRemoteStorage014 *>(steam_remote_storage));
|
return reinterpret_cast<ISteamRemoteStorage *>(static_cast<ISteamRemoteStorage014 *>(steam_remote_storage));
|
||||||
|
} else if (strcmp(pchVersion, "STEAMREMOTESTORAGE_INTERFACE_VERSION015") == 0) { // Not found in public Archive, based on reversing
|
||||||
// STEAMREMOTESTORAGE_INTERFACE_VERSION015 Not found in public Archive, must be between 1.51-1.52
|
return reinterpret_cast<ISteamRemoteStorage *>(static_cast<ISteamRemoteStorage015 *>(steam_remote_storage));
|
||||||
|
|
||||||
} else if (strcmp(pchVersion, STEAMREMOTESTORAGE_INTERFACE_VERSION) == 0) {
|
} else if (strcmp(pchVersion, STEAMREMOTESTORAGE_INTERFACE_VERSION) == 0) {
|
||||||
return reinterpret_cast<ISteamRemoteStorage *>(static_cast<ISteamRemoteStorage *>(steam_remote_storage));
|
return reinterpret_cast<ISteamRemoteStorage *>(static_cast<ISteamRemoteStorage *>(steam_remote_storage));
|
||||||
}
|
}
|
||||||
@ -711,9 +710,8 @@ ISteamUGC *Steam_Client::GetISteamUGC( HSteamUser hSteamUser, HSteamPipe hSteamP
|
|||||||
return reinterpret_cast<ISteamUGC *>(static_cast<ISteamUGC009 *>(steam_ugc_temp));
|
return reinterpret_cast<ISteamUGC *>(static_cast<ISteamUGC009 *>(steam_ugc_temp));
|
||||||
} else if (strcmp(pchVersion, "STEAMUGC_INTERFACE_VERSION010") == 0) {
|
} else if (strcmp(pchVersion, "STEAMUGC_INTERFACE_VERSION010") == 0) {
|
||||||
return reinterpret_cast<ISteamUGC *>(static_cast<ISteamUGC010 *>(steam_ugc_temp));
|
return reinterpret_cast<ISteamUGC *>(static_cast<ISteamUGC010 *>(steam_ugc_temp));
|
||||||
|
} else if (strcmp(pchVersion, "STEAMUGC_INTERFACE_VERSION011") == 0) { // Not found in public Archive, based on reversing
|
||||||
// STEAMUGC_INTERFACE_VERSION011 Not found in public Archive, must be between 1.42-1.43
|
return reinterpret_cast<ISteamUGC *>(static_cast<ISteamUGC011 *>(steam_ugc_temp));
|
||||||
|
|
||||||
} else if (strcmp(pchVersion, "STEAMUGC_INTERFACE_VERSION012") == 0) {
|
} else if (strcmp(pchVersion, "STEAMUGC_INTERFACE_VERSION012") == 0) {
|
||||||
return reinterpret_cast<ISteamUGC *>(static_cast<ISteamUGC012 *>(steam_ugc_temp));
|
return reinterpret_cast<ISteamUGC *>(static_cast<ISteamUGC012 *>(steam_ugc_temp));
|
||||||
} else if (strcmp(pchVersion, "STEAMUGC_INTERFACE_VERSION013") == 0) {
|
} else if (strcmp(pchVersion, "STEAMUGC_INTERFACE_VERSION013") == 0) {
|
||||||
|
|||||||
147
sdk/steam/isteamremotestorage015.h
Normal file
147
sdk/steam/isteamremotestorage015.h
Normal file
@ -0,0 +1,147 @@
|
|||||||
|
#ifndef ISTEAMREMOTESTORAGE015_H
|
||||||
|
#define ISTEAMREMOTESTORAGE015_H
|
||||||
|
#ifdef STEAM_WIN32
|
||||||
|
#pragma once
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
// this interface version is not found in public SDK archives, it is based on reversing the returned vftable from steamclient64.dll
|
||||||
|
|
||||||
|
|
||||||
|
//-----------------------------------------------------------------------------
|
||||||
|
// Purpose: Functions for accessing, reading and writing files stored remotely
|
||||||
|
// and cached locally
|
||||||
|
//-----------------------------------------------------------------------------
|
||||||
|
class ISteamRemoteStorage015
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
// NOTE
|
||||||
|
//
|
||||||
|
// Filenames are case-insensitive, and will be converted to lowercase automatically.
|
||||||
|
// So "foo.bar" and "Foo.bar" are the same file, and if you write "Foo.bar" then
|
||||||
|
// iterate the files, the filename returned will be "foo.bar".
|
||||||
|
//
|
||||||
|
|
||||||
|
// file operations
|
||||||
|
virtual bool FileWrite( const char *pchFile, const void *pvData, int32 cubData ) = 0;
|
||||||
|
virtual int32 FileRead( const char *pchFile, void *pvData, int32 cubDataToRead ) = 0;
|
||||||
|
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageFileWriteAsyncComplete_t )
|
||||||
|
virtual SteamAPICall_t FileWriteAsync( const char *pchFile, const void *pvData, uint32 cubData ) = 0;
|
||||||
|
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageFileReadAsyncComplete_t )
|
||||||
|
virtual SteamAPICall_t FileReadAsync( const char *pchFile, uint32 nOffset, uint32 cubToRead ) = 0;
|
||||||
|
virtual bool FileReadAsyncComplete( SteamAPICall_t hReadCall, void *pvBuffer, uint32 cubToRead ) = 0;
|
||||||
|
|
||||||
|
virtual bool FileForget( const char *pchFile ) = 0;
|
||||||
|
virtual bool FileDelete( const char *pchFile ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageFileShareResult_t )
|
||||||
|
virtual SteamAPICall_t FileShare( const char *pchFile ) = 0;
|
||||||
|
virtual bool SetSyncPlatforms( const char *pchFile, ERemoteStoragePlatform eRemoteStoragePlatform ) = 0;
|
||||||
|
|
||||||
|
// file operations that cause network IO
|
||||||
|
virtual UGCFileWriteStreamHandle_t FileWriteStreamOpen( const char *pchFile ) = 0;
|
||||||
|
virtual bool FileWriteStreamWriteChunk( UGCFileWriteStreamHandle_t writeHandle, const void *pvData, int32 cubData ) = 0;
|
||||||
|
virtual bool FileWriteStreamClose( UGCFileWriteStreamHandle_t writeHandle ) = 0;
|
||||||
|
virtual bool FileWriteStreamCancel( UGCFileWriteStreamHandle_t writeHandle ) = 0;
|
||||||
|
|
||||||
|
// file information
|
||||||
|
virtual bool FileExists( const char *pchFile ) = 0;
|
||||||
|
virtual bool FilePersisted( const char *pchFile ) = 0;
|
||||||
|
virtual int32 GetFileSize( const char *pchFile ) = 0;
|
||||||
|
virtual int64 GetFileTimestamp( const char *pchFile ) = 0;
|
||||||
|
virtual ERemoteStoragePlatform GetSyncPlatforms( const char *pchFile ) = 0;
|
||||||
|
|
||||||
|
// iteration
|
||||||
|
virtual int32 GetFileCount() = 0;
|
||||||
|
virtual const char *GetFileNameAndSize( int iFile, int32 *pnFileSizeInBytes ) = 0;
|
||||||
|
|
||||||
|
// configuration management
|
||||||
|
virtual bool GetQuota( uint64 *pnTotalBytes, uint64 *puAvailableBytes ) = 0;
|
||||||
|
virtual bool IsCloudEnabledForAccount() = 0;
|
||||||
|
virtual bool IsCloudEnabledForApp() = 0;
|
||||||
|
virtual void SetCloudEnabledForApp( bool bEnabled ) = 0;
|
||||||
|
|
||||||
|
// user generated content
|
||||||
|
|
||||||
|
// Downloads a UGC file. A priority value of 0 will download the file immediately,
|
||||||
|
// otherwise it will wait to download the file until all downloads with a lower priority
|
||||||
|
// value are completed. Downloads with equal priority will occur simultaneously.
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageDownloadUGCResult_t )
|
||||||
|
virtual SteamAPICall_t UGCDownload( UGCHandle_t hContent, uint32 unPriority ) = 0;
|
||||||
|
|
||||||
|
// Gets the amount of data downloaded so far for a piece of content. pnBytesExpected can be 0 if function returns false
|
||||||
|
// or if the transfer hasn't started yet, so be careful to check for that before dividing to get a percentage
|
||||||
|
virtual bool GetUGCDownloadProgress( UGCHandle_t hContent, int32 *pnBytesDownloaded, int32 *pnBytesExpected ) = 0;
|
||||||
|
|
||||||
|
// Gets metadata for a file after it has been downloaded. This is the same metadata given in the RemoteStorageDownloadUGCResult_t call result
|
||||||
|
virtual bool GetUGCDetails( UGCHandle_t hContent, AppId_t *pnAppID, STEAM_OUT_STRING() char **ppchName, int32 *pnFileSizeInBytes, STEAM_OUT_STRUCT() CSteamID *pSteamIDOwner ) = 0;
|
||||||
|
|
||||||
|
// After download, gets the content of the file.
|
||||||
|
// Small files can be read all at once by calling this function with an offset of 0 and cubDataToRead equal to the size of the file.
|
||||||
|
// Larger files can be read in chunks to reduce memory usage (since both sides of the IPC client and the game itself must allocate
|
||||||
|
// enough memory for each chunk). Once the last byte is read, the file is implicitly closed and further calls to UGCRead will fail
|
||||||
|
// unless UGCDownload is called again.
|
||||||
|
// For especially large files (anything over 100MB) it is a requirement that the file is read in chunks.
|
||||||
|
virtual int32 UGCRead( UGCHandle_t hContent, void *pvData, int32 cubDataToRead, uint32 cOffset, EUGCReadAction eAction ) = 0;
|
||||||
|
|
||||||
|
// Functions to iterate through UGC that has finished downloading but has not yet been read via UGCRead()
|
||||||
|
virtual int32 GetCachedUGCCount() = 0;
|
||||||
|
virtual UGCHandle_t GetCachedUGCHandle( int32 iCachedContent ) = 0;
|
||||||
|
|
||||||
|
// publishing UGC
|
||||||
|
STEAM_CALL_RESULT( RemoteStoragePublishFileProgress_t )
|
||||||
|
virtual 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 ) = 0;
|
||||||
|
virtual PublishedFileUpdateHandle_t CreatePublishedFileUpdateRequest( PublishedFileId_t unPublishedFileId ) = 0;
|
||||||
|
virtual bool UpdatePublishedFileFile( PublishedFileUpdateHandle_t updateHandle, const char *pchFile ) = 0;
|
||||||
|
virtual bool UpdatePublishedFilePreviewFile( PublishedFileUpdateHandle_t updateHandle, const char *pchPreviewFile ) = 0;
|
||||||
|
virtual bool UpdatePublishedFileTitle( PublishedFileUpdateHandle_t updateHandle, const char *pchTitle ) = 0;
|
||||||
|
virtual bool UpdatePublishedFileDescription( PublishedFileUpdateHandle_t updateHandle, const char *pchDescription ) = 0;
|
||||||
|
virtual bool UpdatePublishedFileVisibility( PublishedFileUpdateHandle_t updateHandle, ERemoteStoragePublishedFileVisibility eVisibility ) = 0;
|
||||||
|
virtual bool UpdatePublishedFileTags( PublishedFileUpdateHandle_t updateHandle, SteamParamStringArray_t *pTags ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageUpdatePublishedFileResult_t )
|
||||||
|
virtual SteamAPICall_t CommitPublishedFileUpdate( PublishedFileUpdateHandle_t updateHandle ) = 0;
|
||||||
|
// Gets published file details for the given publishedfileid. If unMaxSecondsOld is greater than 0,
|
||||||
|
// cached data may be returned, depending on how long ago it was cached. A value of 0 will force a refresh.
|
||||||
|
// A value of k_WorkshopForceLoadPublishedFileDetailsFromCache will use cached data if it exists, no matter how old it is.
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageGetPublishedFileDetailsResult_t )
|
||||||
|
virtual SteamAPICall_t GetPublishedFileDetails( PublishedFileId_t unPublishedFileId, uint32 unMaxSecondsOld ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageDeletePublishedFileResult_t )
|
||||||
|
virtual SteamAPICall_t DeletePublishedFile( PublishedFileId_t unPublishedFileId ) = 0;
|
||||||
|
// enumerate the files that the current user published with this app
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageEnumerateUserPublishedFilesResult_t )
|
||||||
|
virtual SteamAPICall_t EnumerateUserPublishedFiles( uint32 unStartIndex ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageSubscribePublishedFileResult_t )
|
||||||
|
virtual SteamAPICall_t SubscribePublishedFile( PublishedFileId_t unPublishedFileId ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageEnumerateUserSubscribedFilesResult_t )
|
||||||
|
virtual SteamAPICall_t EnumerateUserSubscribedFiles( uint32 unStartIndex ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageUnsubscribePublishedFileResult_t )
|
||||||
|
virtual SteamAPICall_t UnsubscribePublishedFile( PublishedFileId_t unPublishedFileId ) = 0;
|
||||||
|
virtual bool UpdatePublishedFileSetChangeDescription( PublishedFileUpdateHandle_t updateHandle, const char *pchChangeDescription ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageGetPublishedItemVoteDetailsResult_t )
|
||||||
|
virtual SteamAPICall_t GetPublishedItemVoteDetails( PublishedFileId_t unPublishedFileId ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageUpdateUserPublishedItemVoteResult_t )
|
||||||
|
virtual SteamAPICall_t UpdateUserPublishedItemVote( PublishedFileId_t unPublishedFileId, bool bVoteUp ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageGetPublishedItemVoteDetailsResult_t )
|
||||||
|
virtual SteamAPICall_t GetUserPublishedItemVoteDetails( PublishedFileId_t unPublishedFileId ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageEnumerateUserPublishedFilesResult_t )
|
||||||
|
virtual SteamAPICall_t EnumerateUserSharedWorkshopFiles( CSteamID steamId, uint32 unStartIndex, SteamParamStringArray_t *pRequiredTags, SteamParamStringArray_t *pExcludedTags ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStoragePublishFileProgress_t )
|
||||||
|
virtual 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 ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageSetUserPublishedFileActionResult_t )
|
||||||
|
virtual SteamAPICall_t SetUserPublishedFileAction( PublishedFileId_t unPublishedFileId, EWorkshopFileAction eAction ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageEnumeratePublishedFilesByUserActionResult_t )
|
||||||
|
virtual SteamAPICall_t EnumeratePublishedFilesByUserAction( EWorkshopFileAction eAction, uint32 unStartIndex ) = 0;
|
||||||
|
// this method enumerates the public view of workshop files
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageEnumerateWorkshopFilesResult_t )
|
||||||
|
virtual SteamAPICall_t EnumeratePublishedWorkshopFiles( EWorkshopEnumerationType eEnumerationType, uint32 unStartIndex, uint32 unCount, uint32 unDays, SteamParamStringArray_t *pTags, SteamParamStringArray_t *pUserTags ) = 0;
|
||||||
|
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageDownloadUGCResult_t )
|
||||||
|
virtual SteamAPICall_t UGCDownloadToLocation( UGCHandle_t hContent, const char *pchLocation, uint32 unPriority ) = 0;
|
||||||
|
|
||||||
|
// Cloud dynamic state change notification
|
||||||
|
virtual int32 GetLocalFileChangeCount() = 0;
|
||||||
|
virtual const char *GetLocalFileChange( int iFile, ERemoteStorageLocalFileChange *pEChangeType, ERemoteStorageFilePathType *pEFilePathType ) = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // ISTEAMREMOTESTORAGE015_H
|
||||||
161
sdk/steam/isteamugc011.h
Normal file
161
sdk/steam/isteamugc011.h
Normal file
@ -0,0 +1,161 @@
|
|||||||
|
|
||||||
|
#ifndef ISTEAMUGC011_H
|
||||||
|
#define ISTEAMUGC011_H
|
||||||
|
#ifdef STEAM_WIN32
|
||||||
|
#pragma once
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// this interface version is not found in public SDK archives, it is based on reversing the returned vftable from steamclient64.dll
|
||||||
|
|
||||||
|
class ISteamUGC011
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
|
||||||
|
// Query UGC associated with a user. Creator app id or consumer app id must be valid and be set to the current running app. unPage should start at 1.
|
||||||
|
virtual UGCQueryHandle_t CreateQueryUserUGCRequest( AccountID_t unAccountID, EUserUGCList eListType, EUGCMatchingUGCType eMatchingUGCType, EUserUGCListSortOrder eSortOrder, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint32 unPage ) = 0;
|
||||||
|
|
||||||
|
// Query for all matching UGC using the new deep paging interface. Creator app id or consumer app id must be valid and be set to the current running app. pchCursor should be set to NULL or "*" to get the first result set.
|
||||||
|
virtual UGCQueryHandle_t CreateQueryAllUGCRequest( EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, const char *pchCursor = NULL ) = 0;
|
||||||
|
|
||||||
|
// Query for the details of the given published file ids (the RequestUGCDetails call is deprecated and replaced with this)
|
||||||
|
virtual UGCQueryHandle_t CreateQueryUGCDetailsRequest( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs ) = 0;
|
||||||
|
|
||||||
|
// Send the query to Steam
|
||||||
|
STEAM_CALL_RESULT( SteamUGCQueryCompleted_t )
|
||||||
|
virtual SteamAPICall_t SendQueryUGCRequest( UGCQueryHandle_t handle ) = 0;
|
||||||
|
|
||||||
|
// Retrieve an individual result after receiving the callback for querying UGC
|
||||||
|
virtual bool GetQueryUGCResult( UGCQueryHandle_t handle, uint32 index, SteamUGCDetails_t *pDetails ) = 0;
|
||||||
|
virtual bool GetQueryUGCPreviewURL( UGCQueryHandle_t handle, uint32 index, STEAM_OUT_STRING_COUNT(cchURLSize) char *pchURL, uint32 cchURLSize ) = 0;
|
||||||
|
virtual bool GetQueryUGCMetadata( UGCQueryHandle_t handle, uint32 index, STEAM_OUT_STRING_COUNT(cchMetadatasize) char *pchMetadata, uint32 cchMetadatasize ) = 0;
|
||||||
|
virtual bool GetQueryUGCChildren( UGCQueryHandle_t handle, uint32 index, PublishedFileId_t* pvecPublishedFileID, uint32 cMaxEntries ) = 0;
|
||||||
|
virtual bool GetQueryUGCStatistic( UGCQueryHandle_t handle, uint32 index, EItemStatistic eStatType, uint64 *pStatValue ) = 0;
|
||||||
|
virtual uint32 GetQueryUGCNumAdditionalPreviews( UGCQueryHandle_t handle, uint32 index ) = 0;
|
||||||
|
virtual bool GetQueryUGCAdditionalPreview( UGCQueryHandle_t handle, uint32 index, uint32 previewIndex, STEAM_OUT_STRING_COUNT(cchURLSize) char *pchURLOrVideoID, uint32 cchURLSize, STEAM_OUT_STRING_COUNT(cchURLSize) char *pchOriginalFileName, uint32 cchOriginalFileNameSize, EItemPreviewType *pPreviewType ) = 0;
|
||||||
|
virtual uint32 GetQueryUGCNumKeyValueTags( UGCQueryHandle_t handle, uint32 index ) = 0;
|
||||||
|
virtual bool GetQueryUGCKeyValueTag( UGCQueryHandle_t handle, uint32 index, uint32 keyValueTagIndex, STEAM_OUT_STRING_COUNT(cchKeySize) char *pchKey, uint32 cchKeySize, STEAM_OUT_STRING_COUNT(cchValueSize) char *pchValue, uint32 cchValueSize ) = 0;
|
||||||
|
|
||||||
|
// Release the request to free up memory, after retrieving results
|
||||||
|
virtual bool ReleaseQueryUGCRequest( UGCQueryHandle_t handle ) = 0;
|
||||||
|
|
||||||
|
// Options to set for querying UGC
|
||||||
|
virtual bool AddRequiredTag( UGCQueryHandle_t handle, const char *pTagName ) = 0;
|
||||||
|
virtual bool AddExcludedTag( UGCQueryHandle_t handle, const char *pTagName ) = 0;
|
||||||
|
virtual bool SetReturnOnlyIDs( UGCQueryHandle_t handle, bool bReturnOnlyIDs ) = 0;
|
||||||
|
virtual bool SetReturnKeyValueTags( UGCQueryHandle_t handle, bool bReturnKeyValueTags ) = 0;
|
||||||
|
virtual bool SetReturnLongDescription( UGCQueryHandle_t handle, bool bReturnLongDescription ) = 0;
|
||||||
|
virtual bool SetReturnMetadata( UGCQueryHandle_t handle, bool bReturnMetadata ) = 0;
|
||||||
|
virtual bool SetReturnChildren( UGCQueryHandle_t handle, bool bReturnChildren ) = 0;
|
||||||
|
virtual bool SetReturnAdditionalPreviews( UGCQueryHandle_t handle, bool bReturnAdditionalPreviews ) = 0;
|
||||||
|
virtual bool SetReturnTotalOnly( UGCQueryHandle_t handle, bool bReturnTotalOnly ) = 0;
|
||||||
|
virtual bool SetReturnPlaytimeStats( UGCQueryHandle_t handle, uint32 unDays ) = 0;
|
||||||
|
virtual bool SetLanguage( UGCQueryHandle_t handle, const char *pchLanguage ) = 0;
|
||||||
|
virtual bool SetAllowCachedResponse( UGCQueryHandle_t handle, uint32 unMaxAgeSeconds ) = 0;
|
||||||
|
|
||||||
|
// Options only for querying user UGC
|
||||||
|
virtual bool SetCloudFileNameFilter( UGCQueryHandle_t handle, const char *pMatchCloudFileName ) = 0;
|
||||||
|
|
||||||
|
// Options only for querying all UGC
|
||||||
|
virtual bool SetMatchAnyTag( UGCQueryHandle_t handle, bool bMatchAnyTag ) = 0;
|
||||||
|
virtual bool SetSearchText( UGCQueryHandle_t handle, const char *pSearchText ) = 0;
|
||||||
|
virtual bool SetRankedByTrendDays( UGCQueryHandle_t handle, uint32 unDays ) = 0;
|
||||||
|
virtual bool AddRequiredKeyValueTag( UGCQueryHandle_t handle, const char *pKey, const char *pValue ) = 0;
|
||||||
|
|
||||||
|
// DEPRECATED - Use CreateQueryUGCDetailsRequest call above instead!
|
||||||
|
virtual SteamAPICall_t RequestUGCDetails( PublishedFileId_t nPublishedFileID, uint32 unMaxAgeSeconds ) = 0;
|
||||||
|
|
||||||
|
// Steam Workshop Creator API
|
||||||
|
STEAM_CALL_RESULT( CreateItemResult_t )
|
||||||
|
virtual SteamAPICall_t CreateItem( AppId_t nConsumerAppId, EWorkshopFileType eFileType ) = 0; // create new item for this app with no content attached yet
|
||||||
|
|
||||||
|
virtual UGCUpdateHandle_t StartItemUpdate( AppId_t nConsumerAppId, PublishedFileId_t nPublishedFileID ) = 0; // start an UGC item update. Set changed properties before commiting update with CommitItemUpdate()
|
||||||
|
|
||||||
|
virtual bool SetItemTitle( UGCUpdateHandle_t handle, const char *pchTitle ) = 0; // change the title of an UGC item
|
||||||
|
virtual bool SetItemDescription( UGCUpdateHandle_t handle, const char *pchDescription ) = 0; // change the description of an UGC item
|
||||||
|
virtual bool SetItemUpdateLanguage( UGCUpdateHandle_t handle, const char *pchLanguage ) = 0; // specify the language of the title or description that will be set
|
||||||
|
virtual bool SetItemMetadata( UGCUpdateHandle_t handle, const char *pchMetaData ) = 0; // change the metadata of an UGC item (max = k_cchDeveloperMetadataMax)
|
||||||
|
virtual bool SetItemVisibility( UGCUpdateHandle_t handle, ERemoteStoragePublishedFileVisibility eVisibility ) = 0; // change the visibility of an UGC item
|
||||||
|
virtual bool SetItemTags( UGCUpdateHandle_t updateHandle, const SteamParamStringArray_t *pTags ) = 0; // change the tags of an UGC item
|
||||||
|
virtual bool SetItemContent( UGCUpdateHandle_t handle, const char *pszContentFolder ) = 0; // update item content from this local folder
|
||||||
|
virtual bool SetItemPreview( UGCUpdateHandle_t handle, const char *pszPreviewFile ) = 0; // change preview image file for this item. pszPreviewFile points to local image file, which must be under 1MB in size
|
||||||
|
virtual bool SetAllowLegacyUpload( UGCUpdateHandle_t handle, bool bAllowLegacyUpload ) = 0; // use legacy upload for a single small file. The parameter to SetItemContent() should either be a directory with one file or the full path to the file. The file must also be less than 10MB in size.
|
||||||
|
virtual bool RemoveItemKeyValueTags( UGCUpdateHandle_t handle, const char *pchKey ) = 0; // remove any existing key-value tags with the specified key
|
||||||
|
virtual bool AddItemKeyValueTag( UGCUpdateHandle_t handle, const char *pchKey, const char *pchValue ) = 0; // add new key-value tags for the item. Note that there can be multiple values for a tag.
|
||||||
|
virtual bool AddItemPreviewFile( UGCUpdateHandle_t handle, const char *pszPreviewFile, EItemPreviewType type ) = 0; // add preview file for this item. pszPreviewFile points to local file, which must be under 1MB in size
|
||||||
|
virtual bool AddItemPreviewVideo( UGCUpdateHandle_t handle, const char *pszVideoID ) = 0; // add preview video for this item
|
||||||
|
virtual bool UpdateItemPreviewFile( UGCUpdateHandle_t handle, uint32 index, const char *pszPreviewFile ) = 0; // updates an existing preview file for this item. pszPreviewFile points to local file, which must be under 1MB in size
|
||||||
|
virtual bool UpdateItemPreviewVideo( UGCUpdateHandle_t handle, uint32 index, const char *pszVideoID ) = 0; // updates an existing preview video for this item
|
||||||
|
virtual bool RemoveItemPreview( UGCUpdateHandle_t handle, uint32 index ) = 0; // remove a preview by index starting at 0 (previews are sorted)
|
||||||
|
|
||||||
|
STEAM_CALL_RESULT( SubmitItemUpdateResult_t )
|
||||||
|
virtual SteamAPICall_t SubmitItemUpdate( UGCUpdateHandle_t handle, const char *pchChangeNote ) = 0; // commit update process started with StartItemUpdate()
|
||||||
|
virtual EItemUpdateStatus GetItemUpdateProgress( UGCUpdateHandle_t handle, uint64 *punBytesProcessed, uint64* punBytesTotal ) = 0;
|
||||||
|
|
||||||
|
// Steam Workshop Consumer API
|
||||||
|
STEAM_CALL_RESULT( SetUserItemVoteResult_t )
|
||||||
|
virtual SteamAPICall_t SetUserItemVote( PublishedFileId_t nPublishedFileID, bool bVoteUp ) = 0;
|
||||||
|
STEAM_CALL_RESULT( GetUserItemVoteResult_t )
|
||||||
|
virtual SteamAPICall_t GetUserItemVote( PublishedFileId_t nPublishedFileID ) = 0;
|
||||||
|
STEAM_CALL_RESULT( UserFavoriteItemsListChanged_t )
|
||||||
|
virtual SteamAPICall_t AddItemToFavorites( AppId_t nAppId, PublishedFileId_t nPublishedFileID ) = 0;
|
||||||
|
STEAM_CALL_RESULT( UserFavoriteItemsListChanged_t )
|
||||||
|
virtual SteamAPICall_t RemoveItemFromFavorites( AppId_t nAppId, PublishedFileId_t nPublishedFileID ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageSubscribePublishedFileResult_t )
|
||||||
|
virtual SteamAPICall_t SubscribeItem( PublishedFileId_t nPublishedFileID ) = 0; // subscribe to this item, will be installed ASAP
|
||||||
|
STEAM_CALL_RESULT( RemoteStorageUnsubscribePublishedFileResult_t )
|
||||||
|
virtual SteamAPICall_t UnsubscribeItem( PublishedFileId_t nPublishedFileID ) = 0; // unsubscribe from this item, will be uninstalled after game quits
|
||||||
|
virtual uint32 GetNumSubscribedItems() = 0; // number of subscribed items
|
||||||
|
virtual uint32 GetSubscribedItems( PublishedFileId_t* pvecPublishedFileID, uint32 cMaxEntries ) = 0; // all subscribed item PublishFileIDs
|
||||||
|
|
||||||
|
// get EItemState flags about item on this client
|
||||||
|
virtual uint32 GetItemState( PublishedFileId_t nPublishedFileID ) = 0;
|
||||||
|
|
||||||
|
// get info about currently installed content on disc for items that have k_EItemStateInstalled set
|
||||||
|
// if k_EItemStateLegacyItem is set, pchFolder contains the path to the legacy file itself (not a folder)
|
||||||
|
virtual bool GetItemInstallInfo( PublishedFileId_t nPublishedFileID, uint64 *punSizeOnDisk, STEAM_OUT_STRING_COUNT( cchFolderSize ) char *pchFolder, uint32 cchFolderSize, uint32 *punTimeStamp ) = 0;
|
||||||
|
|
||||||
|
// get info about pending update for items that have k_EItemStateNeedsUpdate set. punBytesTotal will be valid after download started once
|
||||||
|
virtual bool GetItemDownloadInfo( PublishedFileId_t nPublishedFileID, uint64 *punBytesDownloaded, uint64 *punBytesTotal ) = 0;
|
||||||
|
|
||||||
|
// download new or update already installed item. If function returns true, wait for DownloadItemResult_t. If the item is already installed,
|
||||||
|
// then files on disk should not be used until callback received. If item is not subscribed to, it will be cached for some time.
|
||||||
|
// If bHighPriority is set, any other item download will be suspended and this item downloaded ASAP.
|
||||||
|
virtual bool DownloadItem( PublishedFileId_t nPublishedFileID, bool bHighPriority ) = 0;
|
||||||
|
|
||||||
|
// game servers can set a specific workshop folder before issuing any UGC commands.
|
||||||
|
// This is helpful if you want to support multiple game servers running out of the same install folder
|
||||||
|
virtual bool BInitWorkshopForGameServer( DepotId_t unWorkshopDepotID, const char *pszFolder ) = 0;
|
||||||
|
|
||||||
|
// SuspendDownloads( true ) will suspend all workshop downloads until SuspendDownloads( false ) is called or the game ends
|
||||||
|
virtual void SuspendDownloads( bool bSuspend ) = 0;
|
||||||
|
|
||||||
|
// usage tracking
|
||||||
|
STEAM_CALL_RESULT( StartPlaytimeTrackingResult_t )
|
||||||
|
virtual SteamAPICall_t StartPlaytimeTracking( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs ) = 0;
|
||||||
|
STEAM_CALL_RESULT( StopPlaytimeTrackingResult_t )
|
||||||
|
virtual SteamAPICall_t StopPlaytimeTracking( PublishedFileId_t *pvecPublishedFileID, uint32 unNumPublishedFileIDs ) = 0;
|
||||||
|
STEAM_CALL_RESULT( StopPlaytimeTrackingResult_t )
|
||||||
|
virtual SteamAPICall_t StopPlaytimeTrackingForAllItems() = 0;
|
||||||
|
|
||||||
|
// parent-child relationship or dependency management
|
||||||
|
STEAM_CALL_RESULT( AddUGCDependencyResult_t )
|
||||||
|
virtual SteamAPICall_t AddDependency( PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoveUGCDependencyResult_t )
|
||||||
|
virtual SteamAPICall_t RemoveDependency( PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID ) = 0;
|
||||||
|
|
||||||
|
// add/remove app dependence/requirements (usually DLC)
|
||||||
|
STEAM_CALL_RESULT( AddAppDependencyResult_t )
|
||||||
|
virtual SteamAPICall_t AddAppDependency( PublishedFileId_t nPublishedFileID, AppId_t nAppID ) = 0;
|
||||||
|
STEAM_CALL_RESULT( RemoveAppDependencyResult_t )
|
||||||
|
virtual SteamAPICall_t RemoveAppDependency( PublishedFileId_t nPublishedFileID, AppId_t nAppID ) = 0;
|
||||||
|
// request app dependencies. note that whatever callback you register for GetAppDependenciesResult_t may be called multiple times
|
||||||
|
// until all app dependencies have been returned
|
||||||
|
STEAM_CALL_RESULT( GetAppDependenciesResult_t )
|
||||||
|
virtual SteamAPICall_t GetAppDependencies( PublishedFileId_t nPublishedFileID ) = 0;
|
||||||
|
|
||||||
|
// delete the item without prompting the user
|
||||||
|
STEAM_CALL_RESULT( DeleteItemResult_t )
|
||||||
|
virtual SteamAPICall_t DeleteItem( PublishedFileId_t nPublishedFileID ) = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // ISTEAMUGC011_H
|
||||||
@ -137,6 +137,7 @@
|
|||||||
#include "isteamremotestorage012.h"
|
#include "isteamremotestorage012.h"
|
||||||
#include "isteamremotestorage013.h"
|
#include "isteamremotestorage013.h"
|
||||||
#include "isteamremotestorage014.h"
|
#include "isteamremotestorage014.h"
|
||||||
|
#include "isteamremotestorage015.h"
|
||||||
#include "isteamscreenshots.h"
|
#include "isteamscreenshots.h"
|
||||||
#include "isteamscreenshots001.h"
|
#include "isteamscreenshots001.h"
|
||||||
#include "isteamscreenshots002.h"
|
#include "isteamscreenshots002.h"
|
||||||
@ -163,6 +164,7 @@
|
|||||||
#include "isteamugc008.h"
|
#include "isteamugc008.h"
|
||||||
#include "isteamugc009.h"
|
#include "isteamugc009.h"
|
||||||
#include "isteamugc010.h"
|
#include "isteamugc010.h"
|
||||||
|
#include "isteamugc011.h"
|
||||||
#include "isteamugc012.h"
|
#include "isteamugc012.h"
|
||||||
#include "isteamugc013.h"
|
#include "isteamugc013.h"
|
||||||
#include "isteamugc014.h"
|
#include "isteamugc014.h"
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user