Méthode | Description | |
---|---|---|
CommitPublishedFileUpdate ( PublishedFileUpdateHandle_t updateHandle ) : SteamAPICall_t | ||
CreatePublishedFileUpdateRequest ( PublishedFileId_t unPublishedFileId ) : PublishedFileUpdateHandle_t | ||
DeletePublishedFile ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
EnumeratePublishedFilesByUserAction ( EWorkshopFileAction eAction, uint unStartIndex ) : SteamAPICall_t | ||
EnumeratePublishedWorkshopFiles ( EWorkshopEnumerationType eEnumerationType, uint unStartIndex, uint unCount, uint unDays, System |
this method enumerates the public view of workshop files
|
|
EnumerateUserPublishedFiles ( uint unStartIndex ) : SteamAPICall_t |
enumerate the files that the current user published with this app
|
|
EnumerateUserSharedWorkshopFiles ( CSteamID steamId, uint unStartIndex, System |
||
EnumerateUserSubscribedFiles ( uint unStartIndex ) : SteamAPICall_t | ||
FileDelete ( string pchFile ) : bool | ||
FileExists ( string pchFile ) : bool |
file information
|
|
FileFetch ( string pchFile ) : bool |
Indicate this file should be downloaded in the next sync
|
|
FileForget ( string pchFile ) : bool | ||
FilePersist ( string pchFile ) : bool |
Indicate this file should be persisted in the next sync
|
|
FilePersisted ( string pchFile ) : bool | ||
FileRead ( string pchFile, byte pvData, int cubDataToRead ) : int | ||
FileReadAsync ( string pchFile, uint nOffset, uint cubToRead ) : SteamAPICall_t | ||
FileReadAsyncComplete ( SteamAPICall_t hReadCall, byte pvBuffer, uint cubToRead ) : bool | ||
FileShare ( string pchFile ) : SteamAPICall_t | ||
FileWrite ( string pchFile, byte pvData, int cubData ) : bool |
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
|
|
FileWriteAsync ( string pchFile, byte pvData, uint cubData ) : SteamAPICall_t | ||
FileWriteStreamCancel ( UGCFileWriteStreamHandle_t writeHandle ) : bool | ||
FileWriteStreamClose ( UGCFileWriteStreamHandle_t writeHandle ) : bool | ||
FileWriteStreamOpen ( string pchFile ) : UGCFileWriteStreamHandle_t |
file operations that cause network IO
|
|
FileWriteStreamWriteChunk ( UGCFileWriteStreamHandle_t writeHandle, byte pvData, int cubData ) : bool | ||
GetCachedUGCCount ( ) : int |
Functions to iterate through UGC that has finished downloading but has not yet been read via UGCRead()
|
|
GetCachedUGCHandle ( int iCachedContent ) : UGCHandle_t | ||
GetFileCount ( ) : int |
iteration
|
|
GetFileListFromServer ( ) : void |
The following functions are only necessary on the Playstation 3. On PC & Mac, the Steam client will handle these operations for you On Playstation 3, the game controls which files are stored in the cloud, via FilePersist, FileFetch, and FileForget. Connect to Steam and get a list of files in the Cloud - results in a RemoteStorageAppSyncStatusCheck_t callback
|
|
GetFileNameAndSize ( int iFile, int &pnFileSizeInBytes ) : string | ||
GetFileSize ( string pchFile ) : int | ||
GetFileTimestamp ( string pchFile ) : long | ||
GetPublishedFileDetails ( PublishedFileId_t unPublishedFileId, uint unMaxSecondsOld ) : SteamAPICall_t |
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.
|
|
GetPublishedItemVoteDetails ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
GetQuota ( ulong &pnTotalBytes, ulong &puAvailableBytes ) : bool |
configuration management
|
|
GetSyncPlatforms ( string pchFile ) : ERemoteStoragePlatform | ||
GetUGCDetails ( UGCHandle_t hContent, AppId_t &pnAppID, string &ppchName, int &pnFileSizeInBytes, CSteamID &pSteamIDOwner ) : bool |
Gets metadata for a file after it has been downloaded. This is the same metadata given in the RemoteStorageDownloadUGCResult_t call result
|
|
GetUGCDownloadProgress ( UGCHandle_t hContent, int &pnBytesDownloaded, int &pnBytesExpected ) : bool |
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
|
|
GetUserPublishedItemVoteDetails ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
IsCloudEnabledForAccount ( ) : bool | ||
IsCloudEnabledForApp ( ) : bool | ||
PublishVideo ( EWorkshopVideoProvider eVideoProvider, string pchVideoAccount, string pchVideoIdentifier, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, System |
||
PublishWorkshopFile ( string pchFile, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, System |
publishing UGC
|
|
ResetFileRequestState ( ) : bool |
Reset any fetch/persist/etc requests
|
|
SetCloudEnabledForApp ( bool bEnabled ) : void | ||
SetSyncPlatforms ( string pchFile, ERemoteStoragePlatform eRemoteStoragePlatform ) : bool | ||
SetUserPublishedFileAction ( PublishedFileId_t unPublishedFileId, EWorkshopFileAction eAction ) : SteamAPICall_t | ||
SubscribePublishedFile ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
SynchronizeToClient ( ) : bool |
Pull any requested files down from the Cloud - results in a RemoteStorageAppSyncedClient_t callback
|
|
SynchronizeToServer ( ) : bool |
Upload any requested files to the Cloud - results in a RemoteStorageAppSyncedServer_t callback
|
|
UGCDownload ( UGCHandle_t hContent, uint unPriority ) : SteamAPICall_t |
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.
|
|
UGCDownloadToLocation ( UGCHandle_t hContent, string pchLocation, uint unPriority ) : SteamAPICall_t | ||
UGCRead ( UGCHandle_t hContent, byte pvData, int cubDataToRead, uint cOffset, EUGCReadAction eAction ) : int |
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.
|
|
UnsubscribePublishedFile ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
UpdatePublishedFileDescription ( PublishedFileUpdateHandle_t updateHandle, string pchDescription ) : bool | ||
UpdatePublishedFileFile ( PublishedFileUpdateHandle_t updateHandle, string pchFile ) : bool | ||
UpdatePublishedFilePreviewFile ( PublishedFileUpdateHandle_t updateHandle, string pchPreviewFile ) : bool | ||
UpdatePublishedFileSetChangeDescription ( PublishedFileUpdateHandle_t updateHandle, string pchChangeDescription ) : bool | ||
UpdatePublishedFileTags ( PublishedFileUpdateHandle_t updateHandle, System |
||
UpdatePublishedFileTitle ( PublishedFileUpdateHandle_t updateHandle, string pchTitle ) : bool | ||
UpdatePublishedFileVisibility ( PublishedFileUpdateHandle_t updateHandle, ERemoteStoragePublishedFileVisibility eVisibility ) : bool | ||
UpdateUserPublishedItemVote ( PublishedFileId_t unPublishedFileId, bool bVoteUp ) : SteamAPICall_t |
public static CommitPublishedFileUpdate ( PublishedFileUpdateHandle_t updateHandle ) : SteamAPICall_t | ||
updateHandle | PublishedFileUpdateHandle_t | |
Résultat | SteamAPICall_t |
public static CreatePublishedFileUpdateRequest ( PublishedFileId_t unPublishedFileId ) : PublishedFileUpdateHandle_t | ||
unPublishedFileId | PublishedFileId_t | |
Résultat | PublishedFileUpdateHandle_t |
public static DeletePublishedFile ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
unPublishedFileId | PublishedFileId_t | |
Résultat | SteamAPICall_t |
public static EnumeratePublishedFilesByUserAction ( EWorkshopFileAction eAction, uint unStartIndex ) : SteamAPICall_t | ||
eAction | EWorkshopFileAction | |
unStartIndex | uint | |
Résultat | SteamAPICall_t |
public static EnumeratePublishedWorkshopFiles ( EWorkshopEnumerationType eEnumerationType, uint unStartIndex, uint unCount, uint unDays, System |
||
eEnumerationType | EWorkshopEnumerationType | |
unStartIndex | uint | |
unCount | uint | |
unDays | uint | |
pTags | System |
|
pUserTags | System |
|
Résultat | SteamAPICall_t |
public static EnumerateUserPublishedFiles ( uint unStartIndex ) : SteamAPICall_t | ||
unStartIndex | uint | |
Résultat | SteamAPICall_t |
public static EnumerateUserSharedWorkshopFiles ( CSteamID steamId, uint unStartIndex, System |
||
steamId | CSteamID | |
unStartIndex | uint | |
pRequiredTags | System |
|
pExcludedTags | System |
|
Résultat | SteamAPICall_t |
public static EnumerateUserSubscribedFiles ( uint unStartIndex ) : SteamAPICall_t | ||
unStartIndex | uint | |
Résultat | SteamAPICall_t |
public static FileDelete ( string pchFile ) : bool | ||
pchFile | string | |
Résultat | bool |
public static FileExists ( string pchFile ) : bool | ||
pchFile | string | |
Résultat | bool |
public static FileFetch ( string pchFile ) : bool | ||
pchFile | string | |
Résultat | bool |
public static FileForget ( string pchFile ) : bool | ||
pchFile | string | |
Résultat | bool |
public static FilePersist ( string pchFile ) : bool | ||
pchFile | string | |
Résultat | bool |
public static FilePersisted ( string pchFile ) : bool | ||
pchFile | string | |
Résultat | bool |
public static FileRead ( string pchFile, byte pvData, int cubDataToRead ) : int | ||
pchFile | string | |
pvData | byte | |
cubDataToRead | int | |
Résultat | int |
public static FileReadAsync ( string pchFile, uint nOffset, uint cubToRead ) : SteamAPICall_t | ||
pchFile | string | |
nOffset | uint | |
cubToRead | uint | |
Résultat | SteamAPICall_t |
public static FileReadAsyncComplete ( SteamAPICall_t hReadCall, byte pvBuffer, uint cubToRead ) : bool | ||
hReadCall | SteamAPICall_t | |
pvBuffer | byte | |
cubToRead | uint | |
Résultat | bool |
public static FileShare ( string pchFile ) : SteamAPICall_t | ||
pchFile | string | |
Résultat | SteamAPICall_t |
public static FileWrite ( string pchFile, byte pvData, int cubData ) : bool | ||
pchFile | string | |
pvData | byte | |
cubData | int | |
Résultat | bool |
public static FileWriteAsync ( string pchFile, byte pvData, uint cubData ) : SteamAPICall_t | ||
pchFile | string | |
pvData | byte | |
cubData | uint | |
Résultat | SteamAPICall_t |
public static FileWriteStreamCancel ( UGCFileWriteStreamHandle_t writeHandle ) : bool | ||
writeHandle | UGCFileWriteStreamHandle_t | |
Résultat | bool |
public static FileWriteStreamClose ( UGCFileWriteStreamHandle_t writeHandle ) : bool | ||
writeHandle | UGCFileWriteStreamHandle_t | |
Résultat | bool |
public static FileWriteStreamOpen ( string pchFile ) : UGCFileWriteStreamHandle_t | ||
pchFile | string | |
Résultat | UGCFileWriteStreamHandle_t |
public static FileWriteStreamWriteChunk ( UGCFileWriteStreamHandle_t writeHandle, byte pvData, int cubData ) : bool | ||
writeHandle | UGCFileWriteStreamHandle_t | |
pvData | byte | |
cubData | int | |
Résultat | bool |
public static GetCachedUGCHandle ( int iCachedContent ) : UGCHandle_t | ||
iCachedContent | int | |
Résultat | UGCHandle_t |
public static GetFileListFromServer ( ) : void | ||
Résultat | void |
public static GetFileNameAndSize ( int iFile, int &pnFileSizeInBytes ) : string | ||
iFile | int | |
pnFileSizeInBytes | int | |
Résultat | string |
public static GetFileSize ( string pchFile ) : int | ||
pchFile | string | |
Résultat | int |
public static GetFileTimestamp ( string pchFile ) : long | ||
pchFile | string | |
Résultat | long |
public static GetPublishedFileDetails ( PublishedFileId_t unPublishedFileId, uint unMaxSecondsOld ) : SteamAPICall_t | ||
unPublishedFileId | PublishedFileId_t | |
unMaxSecondsOld | uint | |
Résultat | SteamAPICall_t |
public static GetPublishedItemVoteDetails ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
unPublishedFileId | PublishedFileId_t | |
Résultat | SteamAPICall_t |
public static GetQuota ( ulong &pnTotalBytes, ulong &puAvailableBytes ) : bool | ||
pnTotalBytes | ulong | |
puAvailableBytes | ulong | |
Résultat | bool |
public static GetSyncPlatforms ( string pchFile ) : ERemoteStoragePlatform | ||
pchFile | string | |
Résultat | ERemoteStoragePlatform |
public static GetUGCDetails ( UGCHandle_t hContent, AppId_t &pnAppID, string &ppchName, int &pnFileSizeInBytes, CSteamID &pSteamIDOwner ) : bool | ||
hContent | UGCHandle_t | |
pnAppID | AppId_t | |
ppchName | string | |
pnFileSizeInBytes | int | |
pSteamIDOwner | CSteamID | |
Résultat | bool |
public static GetUGCDownloadProgress ( UGCHandle_t hContent, int &pnBytesDownloaded, int &pnBytesExpected ) : bool | ||
hContent | UGCHandle_t | |
pnBytesDownloaded | int | |
pnBytesExpected | int | |
Résultat | bool |
public static GetUserPublishedItemVoteDetails ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
unPublishedFileId | PublishedFileId_t | |
Résultat | SteamAPICall_t |
public static IsCloudEnabledForAccount ( ) : bool | ||
Résultat | bool |
public static IsCloudEnabledForApp ( ) : bool | ||
Résultat | bool |
public static PublishVideo ( EWorkshopVideoProvider eVideoProvider, string pchVideoAccount, string pchVideoIdentifier, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, System |
||
eVideoProvider | EWorkshopVideoProvider | |
pchVideoAccount | string | |
pchVideoIdentifier | string | |
pchPreviewFile | string | |
nConsumerAppId | AppId_t | |
pchTitle | string | |
pchDescription | string | |
eVisibility | ERemoteStoragePublishedFileVisibility | |
pTags | System |
|
Résultat | SteamAPICall_t |
public static PublishWorkshopFile ( string pchFile, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, System |
||
pchFile | string | |
pchPreviewFile | string | |
nConsumerAppId | AppId_t | |
pchTitle | string | |
pchDescription | string | |
eVisibility | ERemoteStoragePublishedFileVisibility | |
pTags | System |
|
eWorkshopFileType | EWorkshopFileType | |
Résultat | SteamAPICall_t |
public static ResetFileRequestState ( ) : bool | ||
Résultat | bool |
public static SetCloudEnabledForApp ( bool bEnabled ) : void | ||
bEnabled | bool | |
Résultat | void |
public static SetSyncPlatforms ( string pchFile, ERemoteStoragePlatform eRemoteStoragePlatform ) : bool | ||
pchFile | string | |
eRemoteStoragePlatform | ERemoteStoragePlatform | |
Résultat | bool |
public static SetUserPublishedFileAction ( PublishedFileId_t unPublishedFileId, EWorkshopFileAction eAction ) : SteamAPICall_t | ||
unPublishedFileId | PublishedFileId_t | |
eAction | EWorkshopFileAction | |
Résultat | SteamAPICall_t |
public static SubscribePublishedFile ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
unPublishedFileId | PublishedFileId_t | |
Résultat | SteamAPICall_t |
public static SynchronizeToClient ( ) : bool | ||
Résultat | bool |
public static SynchronizeToServer ( ) : bool | ||
Résultat | bool |
public static UGCDownload ( UGCHandle_t hContent, uint unPriority ) : SteamAPICall_t | ||
hContent | UGCHandle_t | |
unPriority | uint | |
Résultat | SteamAPICall_t |
public static UGCDownloadToLocation ( UGCHandle_t hContent, string pchLocation, uint unPriority ) : SteamAPICall_t | ||
hContent | UGCHandle_t | |
pchLocation | string | |
unPriority | uint | |
Résultat | SteamAPICall_t |
public static UGCRead ( UGCHandle_t hContent, byte pvData, int cubDataToRead, uint cOffset, EUGCReadAction eAction ) : int | ||
hContent | UGCHandle_t | |
pvData | byte | |
cubDataToRead | int | |
cOffset | uint | |
eAction | EUGCReadAction | |
Résultat | int |
public static UnsubscribePublishedFile ( PublishedFileId_t unPublishedFileId ) : SteamAPICall_t | ||
unPublishedFileId | PublishedFileId_t | |
Résultat | SteamAPICall_t |
public static UpdatePublishedFileDescription ( PublishedFileUpdateHandle_t updateHandle, string pchDescription ) : bool | ||
updateHandle | PublishedFileUpdateHandle_t | |
pchDescription | string | |
Résultat | bool |
public static UpdatePublishedFileFile ( PublishedFileUpdateHandle_t updateHandle, string pchFile ) : bool | ||
updateHandle | PublishedFileUpdateHandle_t | |
pchFile | string | |
Résultat | bool |
public static UpdatePublishedFilePreviewFile ( PublishedFileUpdateHandle_t updateHandle, string pchPreviewFile ) : bool | ||
updateHandle | PublishedFileUpdateHandle_t | |
pchPreviewFile | string | |
Résultat | bool |
public static UpdatePublishedFileSetChangeDescription ( PublishedFileUpdateHandle_t updateHandle, string pchChangeDescription ) : bool | ||
updateHandle | PublishedFileUpdateHandle_t | |
pchChangeDescription | string | |
Résultat | bool |
public static UpdatePublishedFileTags ( PublishedFileUpdateHandle_t updateHandle, System |
||
updateHandle | PublishedFileUpdateHandle_t | |
pTags | System |
|
Résultat | bool |
public static UpdatePublishedFileTitle ( PublishedFileUpdateHandle_t updateHandle, string pchTitle ) : bool | ||
updateHandle | PublishedFileUpdateHandle_t | |
pchTitle | string | |
Résultat | bool |
public static UpdatePublishedFileVisibility ( PublishedFileUpdateHandle_t updateHandle, ERemoteStoragePublishedFileVisibility eVisibility ) : bool | ||
updateHandle | PublishedFileUpdateHandle_t | |
eVisibility | ERemoteStoragePublishedFileVisibility | |
Résultat | bool |
public static UpdateUserPublishedItemVote ( PublishedFileId_t unPublishedFileId, bool bVoteUp ) : SteamAPICall_t | ||
unPublishedFileId | PublishedFileId_t | |
bVoteUp | bool | |
Résultat | SteamAPICall_t |