Static Public Member Functions
static SteamAPICall_t	CommitPublishedFileUpdate (PublishedFileUpdateHandle_t updateHandle)

static PublishedFileUpdateHandle_t	CreatePublishedFileUpdateRequest (PublishedFileId_t unPublishedFileId)

static SteamAPICall_t	DeletePublishedFile (PublishedFileId_t unPublishedFileId)

static SteamAPICall_t	EnumeratePublishedFilesByUserAction (EWorkshopFileAction eAction, uint unStartIndex)

static SteamAPICall_t	EnumeratePublishedWorkshopFiles (EWorkshopEnumerationType eEnumerationType, uint unStartIndex, uint unCount, uint unDays, System.Collections.Generic.IList< string > pTags, System.Collections.Generic.IList< string > pUserTags)

static SteamAPICall_t	EnumerateUserPublishedFiles (uint unStartIndex)

static SteamAPICall_t	EnumerateUserSharedWorkshopFiles (CSteamID steamId, uint unStartIndex, System.Collections.Generic.IList< string > pRequiredTags, System.Collections.Generic.IList< string > pExcludedTags)

static SteamAPICall_t	EnumerateUserSubscribedFiles (uint unStartIndex)

static bool	FileDelete (string pchFile)

static bool	FileExists (string pchFile)

static bool	FileForget (string pchFile)

static bool	FilePersisted (string pchFile)

static int	FileRead (string pchFile, byte[] pvData, int cubDataToRead)

static SteamAPICall_t	FileReadAsync (string pchFile, uint nOffset, uint cubToRead)

static bool	FileReadAsyncComplete (SteamAPICall_t hReadCall, byte[] pvBuffer, uint cubToRead)

static SteamAPICall_t	FileShare (string pchFile)

static bool	FileWrite (string pchFile, byte[] pvData, int cubData)

static SteamAPICall_t	FileWriteAsync (string pchFile, byte[] pvData, uint cubData)

static bool	FileWriteStreamCancel (UGCFileWriteStreamHandle_t writeHandle)

static bool	FileWriteStreamClose (UGCFileWriteStreamHandle_t writeHandle)

static UGCFileWriteStreamHandle_t	FileWriteStreamOpen (string pchFile)

static bool	FileWriteStreamWriteChunk (UGCFileWriteStreamHandle_t writeHandle, byte[] pvData, int cubData)

static int	GetCachedUGCCount ()

static UGCHandle_t	GetCachedUGCHandle (int iCachedContent)

static int	GetFileCount ()

static string	GetFileNameAndSize (int iFile, out int pnFileSizeInBytes)

static int	GetFileSize (string pchFile)

static long	GetFileTimestamp (string pchFile)

static SteamAPICall_t	GetPublishedFileDetails (PublishedFileId_t unPublishedFileId, uint unMaxSecondsOld)

static SteamAPICall_t	GetPublishedItemVoteDetails (PublishedFileId_t unPublishedFileId)

static bool	GetQuota (out ulong pnTotalBytes, out ulong puAvailableBytes)

static ERemoteStoragePlatform	GetSyncPlatforms (string pchFile)

static bool	GetUGCDetails (UGCHandle_t hContent, out AppId_t pnAppID, out string ppchName, out int pnFileSizeInBytes, out CSteamID pSteamIDOwner)

static bool	GetUGCDownloadProgress (UGCHandle_t hContent, out int pnBytesDownloaded, out int pnBytesExpected)

static SteamAPICall_t	GetUserPublishedItemVoteDetails (PublishedFileId_t unPublishedFileId)

static bool	IsCloudEnabledForAccount ()

static bool	IsCloudEnabledForApp ()

static SteamAPICall_t	PublishVideo (EWorkshopVideoProvider eVideoProvider, string pchVideoAccount, string pchVideoIdentifier, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, System.Collections.Generic.IList< string > pTags)

static SteamAPICall_t	PublishWorkshopFile (string pchFile, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, System.Collections.Generic.IList< string > pTags, EWorkshopFileType eWorkshopFileType)

static void	SetCloudEnabledForApp (bool bEnabled)

static bool	SetSyncPlatforms (string pchFile, ERemoteStoragePlatform eRemoteStoragePlatform)

static SteamAPICall_t	SetUserPublishedFileAction (PublishedFileId_t unPublishedFileId, EWorkshopFileAction eAction)

static SteamAPICall_t	SubscribePublishedFile (PublishedFileId_t unPublishedFileId)

static SteamAPICall_t	UGCDownload (UGCHandle_t hContent, uint unPriority)

static SteamAPICall_t	UGCDownloadToLocation (UGCHandle_t hContent, string pchLocation, uint unPriority)

static int	UGCRead (UGCHandle_t hContent, byte[] pvData, int cubDataToRead, uint cOffset, EUGCReadAction eAction)

static SteamAPICall_t	UnsubscribePublishedFile (PublishedFileId_t unPublishedFileId)

static bool	UpdatePublishedFileDescription (PublishedFileUpdateHandle_t updateHandle, string pchDescription)

static bool	UpdatePublishedFileFile (PublishedFileUpdateHandle_t updateHandle, string pchFile)

static bool	UpdatePublishedFilePreviewFile (PublishedFileUpdateHandle_t updateHandle, string pchPreviewFile)

static bool	UpdatePublishedFileSetChangeDescription (PublishedFileUpdateHandle_t updateHandle, string pchChangeDescription)

static bool	UpdatePublishedFileTags (PublishedFileUpdateHandle_t updateHandle, System.Collections.Generic.IList< string > pTags)

static bool	UpdatePublishedFileTitle (PublishedFileUpdateHandle_t updateHandle, string pchTitle)

static bool	UpdatePublishedFileVisibility (PublishedFileUpdateHandle_t updateHandle, ERemoteStoragePublishedFileVisibility eVisibility)

static SteamAPICall_t	UpdateUserPublishedItemVote (PublishedFileId_t unPublishedFileId, bool bVoteUp)

Member Function Documentation

static SteamAPICall_t Steamworks.SteamRemoteStorage.CommitPublishedFileUpdate ( PublishedFileUpdateHandle_t updateHandle )

inlinestatic

static PublishedFileUpdateHandle_t Steamworks.SteamRemoteStorage.CreatePublishedFileUpdateRequest ( PublishedFileId_t unPublishedFileId )

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.DeletePublishedFile ( PublishedFileId_t unPublishedFileId )

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.EnumeratePublishedFilesByUserAction	(	EWorkshopFileAction	eAction,
		uint	unStartIndex
	)

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.EnumeratePublishedWorkshopFiles	(	EWorkshopEnumerationType	eEnumerationType,
		uint	unStartIndex,
		uint	unCount,
		uint	unDays,
		System.Collections.Generic.IList< string >	pTags,
		System.Collections.Generic.IList< string >	pUserTags
	)

inlinestatic

this method enumerates the public view of workshop files

static SteamAPICall_t Steamworks.SteamRemoteStorage.EnumerateUserPublishedFiles ( uint unStartIndex )

inlinestatic

enumerate the files that the current user published with this app

static SteamAPICall_t Steamworks.SteamRemoteStorage.EnumerateUserSharedWorkshopFiles	(	CSteamID	steamId,
		uint	unStartIndex,
		System.Collections.Generic.IList< string >	pRequiredTags,
		System.Collections.Generic.IList< string >	pExcludedTags
	)

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.EnumerateUserSubscribedFiles ( uint unStartIndex )

inlinestatic

static bool Steamworks.SteamRemoteStorage.FileDelete ( string pchFile )

inlinestatic

static bool Steamworks.SteamRemoteStorage.FileExists ( string pchFile )

inlinestatic

file information

static bool Steamworks.SteamRemoteStorage.FileForget ( string pchFile )

inlinestatic

static bool Steamworks.SteamRemoteStorage.FilePersisted ( string pchFile )

inlinestatic

static int Steamworks.SteamRemoteStorage.FileRead	(	string	pchFile,
		byte[]	pvData,
		int	cubDataToRead
	)

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.FileReadAsync	(	string	pchFile,
		uint	nOffset,
		uint	cubToRead
	)

inlinestatic

static bool Steamworks.SteamRemoteStorage.FileReadAsyncComplete	(	SteamAPICall_t	hReadCall,
		byte[]	pvBuffer,
		uint	cubToRead
	)

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.FileShare ( string pchFile )

inlinestatic

static bool Steamworks.SteamRemoteStorage.FileWrite	(	string	pchFile,
		byte[]	pvData,
		int	cubData
	)

inlinestatic

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

static SteamAPICall_t Steamworks.SteamRemoteStorage.FileWriteAsync	(	string	pchFile,
		byte[]	pvData,
		uint	cubData
	)

inlinestatic

static bool Steamworks.SteamRemoteStorage.FileWriteStreamCancel ( UGCFileWriteStreamHandle_t writeHandle )

inlinestatic

static bool Steamworks.SteamRemoteStorage.FileWriteStreamClose ( UGCFileWriteStreamHandle_t writeHandle )

inlinestatic

static UGCFileWriteStreamHandle_t Steamworks.SteamRemoteStorage.FileWriteStreamOpen ( string pchFile )

inlinestatic

file operations that cause network IO

static bool Steamworks.SteamRemoteStorage.FileWriteStreamWriteChunk	(	UGCFileWriteStreamHandle_t	writeHandle,
		byte[]	pvData,
		int	cubData
	)

inlinestatic

static int Steamworks.SteamRemoteStorage.GetCachedUGCCount ( )

inlinestatic

Functions to iterate through UGC that has finished downloading but has not yet been read via UGCRead()

static UGCHandle_t Steamworks.SteamRemoteStorage.GetCachedUGCHandle ( int iCachedContent )

inlinestatic

static int Steamworks.SteamRemoteStorage.GetFileCount ( )

inlinestatic

iteration

static string Steamworks.SteamRemoteStorage.GetFileNameAndSize	(	int	iFile,
		out int	pnFileSizeInBytes
	)

inlinestatic

static int Steamworks.SteamRemoteStorage.GetFileSize ( string pchFile )

inlinestatic

static long Steamworks.SteamRemoteStorage.GetFileTimestamp ( string pchFile )

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.GetPublishedFileDetails	(	PublishedFileId_t	unPublishedFileId,
		uint	unMaxSecondsOld
	)

inlinestatic

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.

static SteamAPICall_t Steamworks.SteamRemoteStorage.GetPublishedItemVoteDetails ( PublishedFileId_t unPublishedFileId )

inlinestatic

static bool Steamworks.SteamRemoteStorage.GetQuota	(	out ulong	pnTotalBytes,
		out ulong	puAvailableBytes
	)

inlinestatic

configuration management

static ERemoteStoragePlatform Steamworks.SteamRemoteStorage.GetSyncPlatforms ( string pchFile )

inlinestatic

static bool Steamworks.SteamRemoteStorage.GetUGCDetails	(	UGCHandle_t	hContent,
		out AppId_t	pnAppID,
		out string	ppchName,
		out int	pnFileSizeInBytes,
		out CSteamID	pSteamIDOwner
	)

inlinestatic

Gets metadata for a file after it has been downloaded. This is the same metadata given in the RemoteStorageDownloadUGCResult_t call result

static bool Steamworks.SteamRemoteStorage.GetUGCDownloadProgress	(	UGCHandle_t	hContent,
		out int	pnBytesDownloaded,
		out int	pnBytesExpected
	)

inlinestatic

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

static SteamAPICall_t Steamworks.SteamRemoteStorage.GetUserPublishedItemVoteDetails ( PublishedFileId_t unPublishedFileId )

inlinestatic

static bool Steamworks.SteamRemoteStorage.IsCloudEnabledForAccount ( )

inlinestatic

static bool Steamworks.SteamRemoteStorage.IsCloudEnabledForApp ( )

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.PublishVideo	(	EWorkshopVideoProvider	eVideoProvider,
		string	pchVideoAccount,
		string	pchVideoIdentifier,
		string	pchPreviewFile,
		AppId_t	nConsumerAppId,
		string	pchTitle,
		string	pchDescription,
		ERemoteStoragePublishedFileVisibility	eVisibility,
		System.Collections.Generic.IList< string >	pTags
	)

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.PublishWorkshopFile	(	string	pchFile,
		string	pchPreviewFile,
		AppId_t	nConsumerAppId,
		string	pchTitle,
		string	pchDescription,
		ERemoteStoragePublishedFileVisibility	eVisibility,
		System.Collections.Generic.IList< string >	pTags,
		EWorkshopFileType	eWorkshopFileType
	)

inlinestatic

publishing UGC

static void Steamworks.SteamRemoteStorage.SetCloudEnabledForApp ( bool bEnabled )

inlinestatic

static bool Steamworks.SteamRemoteStorage.SetSyncPlatforms	(	string	pchFile,
		ERemoteStoragePlatform	eRemoteStoragePlatform
	)

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.SetUserPublishedFileAction	(	PublishedFileId_t	unPublishedFileId,
		EWorkshopFileAction	eAction
	)

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.SubscribePublishedFile ( PublishedFileId_t unPublishedFileId )

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.UGCDownload	(	UGCHandle_t	hContent,
		uint	unPriority
	)

inlinestatic

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.

static SteamAPICall_t Steamworks.SteamRemoteStorage.UGCDownloadToLocation	(	UGCHandle_t	hContent,
		string	pchLocation,
		uint	unPriority
	)

inlinestatic

static int Steamworks.SteamRemoteStorage.UGCRead	(	UGCHandle_t	hContent,
		byte[]	pvData,
		int	cubDataToRead,
		uint	cOffset,
		EUGCReadAction	eAction
	)

inlinestatic

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.

static SteamAPICall_t Steamworks.SteamRemoteStorage.UnsubscribePublishedFile ( PublishedFileId_t unPublishedFileId )

inlinestatic

static bool Steamworks.SteamRemoteStorage.UpdatePublishedFileDescription	(	PublishedFileUpdateHandle_t	updateHandle,
		string	pchDescription
	)

inlinestatic

static bool Steamworks.SteamRemoteStorage.UpdatePublishedFileFile	(	PublishedFileUpdateHandle_t	updateHandle,
		string	pchFile
	)

inlinestatic

static bool Steamworks.SteamRemoteStorage.UpdatePublishedFilePreviewFile	(	PublishedFileUpdateHandle_t	updateHandle,
		string	pchPreviewFile
	)

inlinestatic

static bool Steamworks.SteamRemoteStorage.UpdatePublishedFileSetChangeDescription	(	PublishedFileUpdateHandle_t	updateHandle,
		string	pchChangeDescription
	)

inlinestatic

static bool Steamworks.SteamRemoteStorage.UpdatePublishedFileTags	(	PublishedFileUpdateHandle_t	updateHandle,
		System.Collections.Generic.IList< string >	pTags
	)

inlinestatic

static bool Steamworks.SteamRemoteStorage.UpdatePublishedFileTitle	(	PublishedFileUpdateHandle_t	updateHandle,
		string	pchTitle
	)

inlinestatic

static bool Steamworks.SteamRemoteStorage.UpdatePublishedFileVisibility	(	PublishedFileUpdateHandle_t	updateHandle,
		ERemoteStoragePublishedFileVisibility	eVisibility
	)

inlinestatic

static SteamAPICall_t Steamworks.SteamRemoteStorage.UpdateUserPublishedItemVote	(	PublishedFileId_t	unPublishedFileId,
		bool	bVoteUp
	)

inlinestatic

The documentation for this class was generated from the following file:

KSP/Assets/Plugins/Steamworks.NET/autogen/isteamremotestorage.cs

Static Public Member Functions

Member Function Documentation