ISteamRemoteStorage

Note

This documentation is auto-generated. Methods marked with 🤖 are automatically generated bindings. Methods marked with ✍️ are manually implemented and methods marked with ✋ are currently not implemented.

List of Functions

RemoteStorage.BeginFileWriteBatch()
RemoteStorage.CommitPublishedFileUpdate()
RemoteStorage.CreatePublishedFileUpdateRequest()
RemoteStorage.DeletePublishedFile()
RemoteStorage.EndFileWriteBatch()
RemoteStorage.EnumeratePublishedFilesByUserAction()
RemoteStorage.EnumeratePublishedWorkshopFiles()
RemoteStorage.EnumerateUserPublishedFiles()
RemoteStorage.EnumerateUserSharedWorkshopFiles()
RemoteStorage.EnumerateUserSubscribedFiles()
RemoteStorage.FileDelete()
RemoteStorage.FileExists()
RemoteStorage.FileForget()
RemoteStorage.FilePersisted()
RemoteStorage.FileRead()
RemoteStorage.FileReadAsync()
RemoteStorage.FileReadAsyncComplete()
RemoteStorage.FileShare()
RemoteStorage.FileWrite()
RemoteStorage.FileWriteAsync()
RemoteStorage.FileWriteStreamCancel()
RemoteStorage.FileWriteStreamClose()
RemoteStorage.FileWriteStreamOpen()
RemoteStorage.FileWriteStreamWriteChunk()
RemoteStorage.GetCachedUGCCount()
RemoteStorage.GetCachedUGCHandle()
RemoteStorage.GetFileCount()
RemoteStorage.GetFileNameAndSize()
RemoteStorage.GetFileSize()
RemoteStorage.GetFileTimestamp()
RemoteStorage.GetLocalFileChange()
RemoteStorage.GetLocalFileChangeCount()
RemoteStorage.GetPublishedFileDetails()
RemoteStorage.GetPublishedItemVoteDetails()
RemoteStorage.GetQuota()
RemoteStorage.GetSyncPlatforms()
RemoteStorage.GetUGCDetails()
RemoteStorage.GetUGCDownloadProgress()
RemoteStorage.GetUserPublishedItemVoteDetails()
RemoteStorage.IsCloudEnabledForAccount()
RemoteStorage.IsCloudEnabledForApp()
RemoteStorage.PublishVideo()
RemoteStorage.PublishWorkshopFile()
RemoteStorage.SetCloudEnabledForApp()
RemoteStorage.SetSyncPlatforms()
RemoteStorage.SetUserPublishedFileAction()
RemoteStorage.SubscribePublishedFile()
RemoteStorage.UGCDownload()
RemoteStorage.UGCDownloadToLocation()
RemoteStorage.UGCRead()
RemoteStorage.UnsubscribePublishedFile()
RemoteStorage.UpdatePublishedFileDescription()
RemoteStorage.UpdatePublishedFileFile()
RemoteStorage.UpdatePublishedFilePreviewFile()
RemoteStorage.UpdatePublishedFileSetChangeDescription()
RemoteStorage.UpdatePublishedFileTags()
RemoteStorage.UpdatePublishedFileTitle()
RemoteStorage.UpdatePublishedFileVisibility()
RemoteStorage.UpdateUserPublishedItemVote()

List of Callbacks

RemoteStorage.OnRemoteStorageFileShareResult()
RemoteStorage.OnRemoteStoragePublishFileResult()
RemoteStorage.OnRemoteStorageDeletePublishedFileResult()
RemoteStorage.OnRemoteStorageEnumerateUserPublishedFilesResult()
RemoteStorage.OnRemoteStorageSubscribePublishedFileResult()
RemoteStorage.OnRemoteStorageEnumerateUserSubscribedFilesResult()
RemoteStorage.OnRemoteStorageUnsubscribePublishedFileResult()
RemoteStorage.OnRemoteStorageUpdatePublishedFileResult()
RemoteStorage.OnRemoteStorageDownloadUGCResult()
RemoteStorage.OnRemoteStorageGetPublishedFileDetailsResult()
RemoteStorage.OnRemoteStorageEnumerateWorkshopFilesResult()
RemoteStorage.OnRemoteStorageGetPublishedItemVoteDetailsResult()
RemoteStorage.OnRemoteStoragePublishedFileSubscribed()
RemoteStorage.OnRemoteStoragePublishedFileUnsubscribed()
RemoteStorage.OnRemoteStoragePublishedFileDeleted()
RemoteStorage.OnRemoteStorageUpdateUserPublishedItemVoteResult()
RemoteStorage.OnRemoteStorageUserVoteDetails()
RemoteStorage.OnRemoteStorageEnumerateUserSharedWorkshopFilesResult()
RemoteStorage.OnRemoteStorageSetUserPublishedFileActionResult()
RemoteStorage.OnRemoteStorageEnumeratePublishedFilesByUserActionResult()
RemoteStorage.OnRemoteStoragePublishFileProgress()
RemoteStorage.OnRemoteStoragePublishedFileUpdated()
RemoteStorage.OnRemoteStorageFileWriteAsyncComplete()
RemoteStorage.OnRemoteStorageFileReadAsyncComplete()
RemoteStorage.OnRemoteStorageLocalFileChange()

Function Reference

RemoteStorage.BeginFileWriteBatch()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: BeginFileWriteBatch

Example:

Steam.RemoteStorage.BeginFileWriteBatch()
Steam.RemoteStorage.FileWrite('config.dat', configData, #configData)
Steam.RemoteStorage.FileWrite('progress.dat', progressData, #progressData)
Steam.RemoteStorage.EndFileWriteBatch()

RemoteStorage.CommitPublishedFileUpdate(updateHandle, callback)

🤖 Auto-generated binding

Parameters:

updateHandle (uint64 - PublishedFileUpdateHandle_t) –
callback (function) – CallResult callback receiving struct RemoteStorageUpdatePublishedFileResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

CommitPublishedFileUpdate

RemoteStorage.CreatePublishedFileUpdateRequest(unPublishedFileId)

🤖 Auto-generated binding

Parameters:: unPublishedFileId (uint64 - PublishedFileId_t) –
Returns:: (uint64 - PublishedFileUpdateHandle_t) Return value
SteamWorks:: CreatePublishedFileUpdateRequest

RemoteStorage.DeletePublishedFile(unPublishedFileId, callback)

🤖 Auto-generated binding

Parameters:

unPublishedFileId (uint64 - PublishedFileId_t) –
callback (function) – CallResult callback receiving struct RemoteStorageDeletePublishedFileResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

DeletePublishedFile

RemoteStorage.EndFileWriteBatch()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: EndFileWriteBatch

RemoteStorage.EnumeratePublishedFilesByUserAction(eAction, unStartIndex, callback)

🤖 Auto-generated binding

Parameters:

eAction (int - EWorkshopFileAction) –
unStartIndex (int) –
callback (function) – CallResult callback receiving struct RemoteStorageEnumeratePublishedFilesByUserActionResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

EnumeratePublishedFilesByUserAction

RemoteStorage.EnumeratePublishedWorkshopFiles(eEnumerationType, unStartIndex, unCount, unDays, pTags, pUserTags, callback)

🤖 Auto-generated binding

Parameters:

eEnumerationType (int - EWorkshopEnumerationType) –
unStartIndex (int) –
unCount (int) –
unDays (int) –
pTags – (SteamParamStringArray_t)
pUserTags – (SteamParamStringArray_t)
callback (function) – CallResult callback receiving struct RemoteStorageEnumerateWorkshopFilesResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

EnumeratePublishedWorkshopFiles

RemoteStorage.EnumerateUserPublishedFiles(unStartIndex, callback)

🤖 Auto-generated binding

Parameters:

unStartIndex (int) –
callback (function) – CallResult callback receiving struct RemoteStorageEnumerateUserPublishedFilesResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

EnumerateUserPublishedFiles

RemoteStorage.EnumerateUserSharedWorkshopFiles(steamId, unStartIndex, pRequiredTags, pExcludedTags, callback)

🤖 Auto-generated binding

Parameters:

steamId (uint64 - CSteamID) –
unStartIndex (int) –
pRequiredTags – (SteamParamStringArray_t)
pExcludedTags – (SteamParamStringArray_t)
callback (function) – CallResult callback receiving struct RemoteStorageEnumerateUserPublishedFilesResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

EnumerateUserSharedWorkshopFiles

RemoteStorage.EnumerateUserSubscribedFiles(unStartIndex, callback)

🤖 Auto-generated binding

Parameters:

unStartIndex (int) –
callback (function) – CallResult callback receiving struct RemoteStorageEnumerateUserSubscribedFilesResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

EnumerateUserSubscribedFiles

RemoteStorage.FileDelete(pchFile)

🤖 Auto-generated binding

Parameters:: pchFile (str?) –
Returns:: (bool) Return value
SteamWorks:: FileDelete

Example:

if Steam.RemoteStorage.FileDelete('old_save.txt') then
    print('Cloud file deleted')
end

RemoteStorage.FileExists(pchFile)

🤖 Auto-generated binding

Parameters:: pchFile (str?) –
Returns:: (bool) Return value
SteamWorks:: FileExists

Example:

if Steam.RemoteStorage.FileExists('savegame.txt') then
    loadCloudSave()
else
    createNewSave()
end

RemoteStorage.FileForget(pchFile)

🤖 Auto-generated binding

Parameters:: pchFile (str?) –
Returns:: (bool) Return value
SteamWorks:: FileForget

RemoteStorage.FilePersisted(pchFile)

🤖 Auto-generated binding

Parameters:: pchFile (str?) –
Returns:: (bool) Return value
SteamWorks:: FilePersisted

Example:

if Steam.RemoteStorage.FilePersisted('savegame.txt') then
    print('File is synchronized to the cloud')
end

RemoteStorage.FileRead(pchFile, cubDataToRead)

🤖 Auto-generated binding

Parameters:

pchFile (str?) –
cubDataToRead (int?) – size of the buffer to allocate for pvData. If nil then the buffer will be NULL.

Returns:

(int) Return value

Returns:

(str) pvData

SteamWorks:

FileRead

Signature differences from C++ API:

Parameter pvData is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

Example:

local size = Steam.RemoteStorage.GetFileSize('savegame.txt')
local _, data = Steam.RemoteStorage.FileRead('savegame.txt', size)
if data then
    loadSaveData(data)
end

RemoteStorage.FileReadAsync(pchFile, nOffset, cubToRead, callback)

🤖 Auto-generated binding

Parameters:

pchFile (str?) –
nOffset (int) –
cubToRead (int) –
callback (function) – CallResult callback receiving struct RemoteStorageFileReadAsyncComplete_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

FileReadAsync

Example:

Steam.RemoteStorage.FileReadAsync('savegame.dat', 0, fileSize, function(data, err)
    if not err and data.m_eResult == Steam.k_EResultOK then
        local ok, fileData = Steam.RemoteStorage.FileReadAsyncComplete(data.m_hFileReadAsync, fileSize)
        if ok then
            loadSaveData(fileData)
        end
    end
end)

RemoteStorage.FileReadAsyncComplete(hReadCall, cubToRead)

🤖 Auto-generated binding

Parameters:

hReadCall (uint64) –
cubToRead (int?) – size of the buffer to allocate for pvBuffer. If nil then the buffer will be NULL.

Returns:

(bool) Return value

Returns:

(str) pvBuffer

SteamWorks:

FileReadAsyncComplete

Signature differences from C++ API:

Parameter pvBuffer is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

Notes:

See RemoteStorage.FileReadAsync()’s example.

RemoteStorage.FileShare(pchFile, callback)

🤖 Auto-generated binding

Parameters:

pchFile (str?) –
callback (function) – CallResult callback receiving struct RemoteStorageFileShareResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

FileShare

RemoteStorage.FileWrite(pchFile, pvData, cubData)

🤖 Auto-generated binding

Parameters:

pchFile (str?) –
pvData (str?) –
cubData (int) – size of the input array pvData

Returns:

(bool) Return value

SteamWorks:

FileWrite

Example:

local data = 'player_name=Alice
level=42
'
local ok = Steam.RemoteStorage.FileWrite('savegame.txt', data, #data)
if not ok then
    print('Failed to write cloud save')
end

RemoteStorage.FileWriteAsync(pchFile, pvData, cubData, callback)

🤖 Auto-generated binding

Parameters:

pchFile (str?) –
pvData (str?) –
cubData (int) – size of the input array pvData
callback (function) – CallResult callback receiving struct RemoteStorageFileWriteAsyncComplete_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

FileWriteAsync

Example:

Steam.RemoteStorage.FileWriteAsync('autosave.dat', saveData, #saveData, function(data, err)
    if err or data.m_eResult ~= Steam.k_EResultOK then
        print('Async write failed')
    else
        print('Cloud save written asynchronously')
    end
end)

RemoteStorage.FileWriteStreamCancel(writeHandle)

🤖 Auto-generated binding

Parameters:: writeHandle (uint64 - UGCFileWriteStreamHandle_t) –
Returns:: (bool) Return value
SteamWorks:: FileWriteStreamCancel

RemoteStorage.FileWriteStreamClose(writeHandle)

🤖 Auto-generated binding

Parameters:: writeHandle (uint64 - UGCFileWriteStreamHandle_t) –
Returns:: (bool) Return value
SteamWorks:: FileWriteStreamClose

RemoteStorage.FileWriteStreamOpen(pchFile)

🤖 Auto-generated binding

Parameters:: pchFile (str?) –
Returns:: (uint64 - UGCFileWriteStreamHandle_t) Return value
SteamWorks:: FileWriteStreamOpen

RemoteStorage.FileWriteStreamWriteChunk(writeHandle, pvData, cubData)

🤖 Auto-generated binding

Parameters:

writeHandle (uint64 - UGCFileWriteStreamHandle_t) –
pvData (str?) –
cubData (int) – size of the input array pvData

Returns:

(bool) Return value

SteamWorks:

FileWriteStreamWriteChunk

RemoteStorage.GetCachedUGCCount()

🤖 Auto-generated binding

Returns:: (int) Return value
SteamWorks:: GetCachedUGCCount

RemoteStorage.GetCachedUGCHandle(iCachedContent)

🤖 Auto-generated binding

Parameters:: iCachedContent (int) –
Returns:: (uint64 - UGCHandle_t) Return value
SteamWorks:: GetCachedUGCHandle

RemoteStorage.GetFileCount()

🤖 Auto-generated binding

Returns:: (int) Return value
SteamWorks:: GetFileCount

Example:

local count = Steam.RemoteStorage.GetFileCount()
for i = 0, count - 1 do
    local name, size = Steam.RemoteStorage.GetFileNameAndSize(i)
    print(name .. ' (' .. size .. ' bytes)')
end

RemoteStorage.GetFileNameAndSize(iFile)

🤖 Auto-generated binding

Parameters:: iFile (int) –
Returns:: (str) Return value
Returns:: (int) pnFileSizeInBytes
SteamWorks:: GetFileNameAndSize

Signature differences from C++ API:

Parameter pnFileSizeInBytes is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

Notes:

See RemoteStorage.GetFileCount()’s example.

RemoteStorage.GetFileSize(pchFile)

🤖 Auto-generated binding

Parameters:: pchFile (str?) –
Returns:: (int) Return value
SteamWorks:: GetFileSize

Example:

local size = Steam.RemoteStorage.GetFileSize('savegame.txt')
print('Save file size: ' .. size .. ' bytes')

RemoteStorage.GetFileTimestamp(pchFile)

🤖 Auto-generated binding

Parameters:: pchFile (str?) –
Returns:: (uint64) Return value
SteamWorks:: GetFileTimestamp

Example:

local timestamp = Steam.RemoteStorage.GetFileTimestamp('savegame.txt')
print('Last modified: ' .. os.date('%c', timestamp))

RemoteStorage.GetLocalFileChange(iFile)

🤖 Auto-generated binding

Parameters:: iFile (int) –
Returns:: (str) Return value
Returns:: (int) pEChangeType
Returns:: (int) pEFilePathType
SteamWorks:: GetLocalFileChange

Signature differences from C++ API:

Parameter pEChangeType is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.
Parameter pEFilePathType is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

RemoteStorage.GetLocalFileChangeCount()

🤖 Auto-generated binding

Returns:: (int) Return value
SteamWorks:: GetLocalFileChangeCount

Example:

-- Check for external changes (e.g. from another PC)
local count = Steam.RemoteStorage.GetLocalFileChangeCount()
for i = 0, count - 1 do
    local name, changeType = Steam.RemoteStorage.GetLocalFileChange(i)
    print('Cloud file changed:', name, changeType)
end

RemoteStorage.GetPublishedFileDetails(unPublishedFileId, unMaxSecondsOld, callback)

🤖 Auto-generated binding

Parameters:

unPublishedFileId (uint64 - PublishedFileId_t) –
unMaxSecondsOld (int) –
callback (function) – CallResult callback receiving struct RemoteStorageGetPublishedFileDetailsResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

GetPublishedFileDetails

RemoteStorage.GetPublishedItemVoteDetails(unPublishedFileId, callback)

🤖 Auto-generated binding

Parameters:

unPublishedFileId (uint64 - PublishedFileId_t) –
callback (function) – CallResult callback receiving struct RemoteStorageGetPublishedItemVoteDetailsResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

GetPublishedItemVoteDetails

RemoteStorage.GetQuota()

🤖 Auto-generated binding

Returns:: (bool) Return value
Returns:: (uint64) pnTotalBytes
Returns:: (uint64) puAvailableBytes
SteamWorks:: GetQuota

Signature differences from C++ API:

Parameter pnTotalBytes is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.
Parameter puAvailableBytes is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

Example:

local _, total, available = Steam.RemoteStorage.GetQuota()
print(string.format('Cloud storage: %d/%d bytes used', total - available, total))

RemoteStorage.GetSyncPlatforms(pchFile)

🤖 Auto-generated binding

Parameters:: pchFile (str?) –
Returns:: (int - ERemoteStoragePlatform) Return value
SteamWorks:: GetSyncPlatforms

RemoteStorage.GetUGCDetails(hContent)

🤖 Auto-generated binding

Parameters:: hContent (uint64 - UGCHandle_t) –
Returns:: (bool) Return value
Returns:: (int) pnAppID
Returns:: (str) ppchName
Returns:: (int) pnFileSizeInBytes
Returns:: (uint64) pSteamIDOwner
SteamWorks:: GetUGCDetails

Signature differences from C++ API:

Parameter pnAppID is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.
Parameter ppchName is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.
Parameter pnFileSizeInBytes is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.
Parameter pSteamIDOwner is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

RemoteStorage.GetUGCDownloadProgress(hContent)

🤖 Auto-generated binding

Parameters:: hContent (uint64 - UGCHandle_t) –
Returns:: (bool) Return value
Returns:: (int) pnBytesDownloaded
Returns:: (int) pnBytesExpected
SteamWorks:: GetUGCDownloadProgress

Signature differences from C++ API:

Parameter pnBytesDownloaded is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.
Parameter pnBytesExpected is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

RemoteStorage.GetUserPublishedItemVoteDetails(unPublishedFileId, callback)

🤖 Auto-generated binding

Parameters:

unPublishedFileId (uint64 - PublishedFileId_t) –
callback (function) – CallResult callback receiving struct RemoteStorageGetPublishedItemVoteDetailsResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

GetUserPublishedItemVoteDetails

RemoteStorage.IsCloudEnabledForAccount()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: IsCloudEnabledForAccount

RemoteStorage.IsCloudEnabledForApp()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: IsCloudEnabledForApp

Example:

if Steam.RemoteStorage.IsCloudEnabledForApp() then
    syncCloudSaves()
end

RemoteStorage.PublishVideo(eVideoProvider, pchVideoAccount, pchVideoIdentifier, pchPreviewFile, nConsumerAppId, pchTitle, pchDescription, eVisibility, callback)

🤖 Auto-generated binding

Parameters:

eVideoProvider (int - EWorkshopVideoProvider) –
pchVideoAccount (str?) –
pchVideoIdentifier (str?) –
pchPreviewFile (str?) –
nConsumerAppId (int - AppId_t) –
pchTitle (str?) –
pchDescription (str?) –
eVisibility (int - ERemoteStoragePublishedFileVisibility) –
callback (function) – CallResult callback receiving struct RemoteStoragePublishFileProgress_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

Returns:

(SteamParamStringArray_t) pTags

SteamWorks:

PublishVideo

Signature differences from C++ API:

Parameter pTags is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

RemoteStorage.PublishWorkshopFile(pchFile, pchPreviewFile, nConsumerAppId, pchTitle, pchDescription, eVisibility, eWorkshopFileType, callback)

🤖 Auto-generated binding

Parameters:

pchFile (str?) –
pchPreviewFile (str?) –
nConsumerAppId (int - AppId_t) –
pchTitle (str?) –
pchDescription (str?) –
eVisibility (int - ERemoteStoragePublishedFileVisibility) –
eWorkshopFileType (int - EWorkshopFileType) –
callback (function) – CallResult callback receiving struct RemoteStoragePublishFileProgress_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

Returns:

(SteamParamStringArray_t) pTags

SteamWorks:

PublishWorkshopFile

Signature differences from C++ API:

Parameter pTags is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

RemoteStorage.SetCloudEnabledForApp(bEnabled)

🤖 Auto-generated binding

Parameters:: bEnabled (bool) –
SteamWorks:: SetCloudEnabledForApp

Example:

-- Allow user to toggle cloud saves
Steam.RemoteStorage.SetCloudEnabledForApp(userWantsCloud)

RemoteStorage.SetSyncPlatforms(pchFile, eRemoteStoragePlatform)

🤖 Auto-generated binding

Parameters:

pchFile (str?) –
eRemoteStoragePlatform (int - ERemoteStoragePlatform) –

Returns:

(bool) Return value

SteamWorks:

SetSyncPlatforms

RemoteStorage.SetUserPublishedFileAction(unPublishedFileId, eAction, callback)

🤖 Auto-generated binding

Parameters:

unPublishedFileId (uint64 - PublishedFileId_t) –
eAction (int - EWorkshopFileAction) –
callback (function) – CallResult callback receiving struct RemoteStorageSetUserPublishedFileActionResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

SetUserPublishedFileAction

RemoteStorage.SubscribePublishedFile(unPublishedFileId, callback)

🤖 Auto-generated binding

Parameters:

unPublishedFileId (uint64 - PublishedFileId_t) –
callback (function) – CallResult callback receiving struct RemoteStorageSubscribePublishedFileResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

SubscribePublishedFile

RemoteStorage.UGCDownload(hContent, unPriority, callback)

🤖 Auto-generated binding

Parameters:

hContent (uint64 - UGCHandle_t) –
unPriority (int) –
callback (function) – CallResult callback receiving struct RemoteStorageDownloadUGCResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

UGCDownload

RemoteStorage.UGCDownloadToLocation(hContent, pchLocation, unPriority, callback)

🤖 Auto-generated binding

Parameters:

hContent (uint64 - UGCHandle_t) –
pchLocation (str?) –
unPriority (int) –
callback (function) – CallResult callback receiving struct RemoteStorageDownloadUGCResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

UGCDownloadToLocation

RemoteStorage.UGCRead(hContent, cubDataToRead, cOffset, eAction)

🤖 Auto-generated binding

Parameters:

hContent (uint64 - UGCHandle_t) –
cubDataToRead (int?) – size of the buffer to allocate for pvData. If nil then the buffer will be NULL.
cOffset (int) –
eAction (int - EUGCReadAction) –

Returns:

(int) Return value

Returns:

(str) pvData

SteamWorks:

UGCRead

Signature differences from C++ API:

Parameter pvData is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

RemoteStorage.UnsubscribePublishedFile(unPublishedFileId, callback)

🤖 Auto-generated binding

Parameters:

unPublishedFileId (uint64 - PublishedFileId_t) –
callback (function) – CallResult callback receiving struct RemoteStorageUnsubscribePublishedFileResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

UnsubscribePublishedFile

RemoteStorage.UpdatePublishedFileDescription(updateHandle, pchDescription)

🤖 Auto-generated binding

Parameters:

updateHandle (uint64 - PublishedFileUpdateHandle_t) –
pchDescription (str?) –

Returns:

(bool) Return value

SteamWorks:

UpdatePublishedFileDescription

RemoteStorage.UpdatePublishedFileFile(updateHandle, pchFile)

🤖 Auto-generated binding

Parameters:

updateHandle (uint64 - PublishedFileUpdateHandle_t) –
pchFile (str?) –

Returns:

(bool) Return value

SteamWorks:

UpdatePublishedFileFile

RemoteStorage.UpdatePublishedFilePreviewFile(updateHandle, pchPreviewFile)

🤖 Auto-generated binding

Parameters:

updateHandle (uint64 - PublishedFileUpdateHandle_t) –
pchPreviewFile (str?) –

Returns:

(bool) Return value

SteamWorks:

UpdatePublishedFilePreviewFile

RemoteStorage.UpdatePublishedFileSetChangeDescription(updateHandle, pchChangeDescription)

🤖 Auto-generated binding

Parameters:

updateHandle (uint64 - PublishedFileUpdateHandle_t) –
pchChangeDescription (str?) –

Returns:

(bool) Return value

SteamWorks:

UpdatePublishedFileSetChangeDescription

RemoteStorage.UpdatePublishedFileTags(updateHandle)

🤖 Auto-generated binding

Parameters:: updateHandle (uint64 - PublishedFileUpdateHandle_t) –
Returns:: (bool) Return value
Returns:: (SteamParamStringArray_t) pTags
SteamWorks:: UpdatePublishedFileTags

Signature differences from C++ API:

Parameter pTags is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

RemoteStorage.UpdatePublishedFileTitle(updateHandle, pchTitle)

🤖 Auto-generated binding

Parameters:

updateHandle (uint64 - PublishedFileUpdateHandle_t) –
pchTitle (str?) –

Returns:

(bool) Return value

SteamWorks:

UpdatePublishedFileTitle

RemoteStorage.UpdatePublishedFileVisibility(updateHandle, eVisibility)

🤖 Auto-generated binding

Parameters:

updateHandle (uint64 - PublishedFileUpdateHandle_t) –
eVisibility (int - ERemoteStoragePublishedFileVisibility) –

Returns:

(bool) Return value

SteamWorks:

UpdatePublishedFileVisibility

RemoteStorage.UpdateUserPublishedItemVote(unPublishedFileId, bVoteUp, callback)

🤖 Auto-generated binding

Parameters:

unPublishedFileId (uint64 - PublishedFileId_t) –
bVoteUp (bool) –
callback (function) – CallResult callback receiving struct RemoteStorageUpdateUserPublishedItemVoteResult_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

UpdateUserPublishedItemVote

Callbacks

RemoteStorage.OnRemoteStorageFileShareResult()

Callback for RemoteStorageFileShareResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_hFile (uint64 - UGCHandle_t)
data.m_rgchFilename (string)

RemoteStorage.OnRemoteStoragePublishFileResult()

Callback for RemoteStoragePublishFileResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_bUserNeedsToAcceptWorkshopLegalAgreement (bool)

RemoteStorage.OnRemoteStorageDeletePublishedFileResult()

Callback for RemoteStorageDeletePublishedFileResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)

RemoteStorage.OnRemoteStorageEnumerateUserPublishedFilesResult()

Callback for RemoteStorageEnumerateUserPublishedFilesResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nResultsReturned (int)
data.m_nTotalResultCount (int)
data.m_rgPublishedFileId (uint64[] - PublishedFileId_t)

RemoteStorage.OnRemoteStorageSubscribePublishedFileResult()

Callback for RemoteStorageSubscribePublishedFileResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)

RemoteStorage.OnRemoteStorageEnumerateUserSubscribedFilesResult()

Callback for RemoteStorageEnumerateUserSubscribedFilesResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nResultsReturned (int)
data.m_nTotalResultCount (int)
data.m_rgPublishedFileId (uint64[] - PublishedFileId_t)
data.m_rgRTimeSubscribed (int)

RemoteStorage.OnRemoteStorageUnsubscribePublishedFileResult()

Callback for RemoteStorageUnsubscribePublishedFileResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)

RemoteStorage.OnRemoteStorageUpdatePublishedFileResult()

Callback for RemoteStorageUpdatePublishedFileResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_bUserNeedsToAcceptWorkshopLegalAgreement (bool)

RemoteStorage.OnRemoteStorageDownloadUGCResult()

Callback for RemoteStorageDownloadUGCResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_hFile (uint64 - UGCHandle_t)
data.m_nAppID (int - AppId_t)
data.m_nSizeInBytes (int)
data.m_pchFileName (string)
data.m_ulSteamIDOwner (uint64)

RemoteStorage.OnRemoteStorageGetPublishedFileDetailsResult()

Callback for RemoteStorageGetPublishedFileDetailsResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_nCreatorAppID (int - AppId_t)
data.m_nConsumerAppID (int - AppId_t)
data.m_rgchTitle (string)
data.m_rgchDescription (string)
data.m_hFile (uint64 - UGCHandle_t)
data.m_hPreviewFile (uint64 - UGCHandle_t)
data.m_ulSteamIDOwner (uint64)
data.m_rtimeCreated (int)
data.m_rtimeUpdated (int)
data.m_eVisibility (int - ERemoteStoragePublishedFileVisibility)
data.m_bBanned (bool)
data.m_rgchTags (string)
data.m_bTagsTruncated (bool)
data.m_pchFileName (string)
data.m_nFileSize (int)
data.m_nPreviewFileSize (int)
data.m_rgchURL (string)
data.m_eFileType (int - EWorkshopFileType)
data.m_bAcceptedForUse (bool)

RemoteStorage.OnRemoteStorageEnumerateWorkshopFilesResult()

Callback for RemoteStorageEnumerateWorkshopFilesResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nResultsReturned (int)
data.m_nTotalResultCount (int)
data.m_rgPublishedFileId (uint64[] - PublishedFileId_t)
data.m_rgScore (float)
data.m_nAppId (int - AppId_t)
data.m_unStartIndex (int)

RemoteStorage.OnRemoteStorageGetPublishedItemVoteDetailsResult()

Callback for RemoteStorageGetPublishedItemVoteDetailsResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_unPublishedFileId (uint64 - PublishedFileId_t)
data.m_nVotesFor (int)
data.m_nVotesAgainst (int)
data.m_nReports (int)
data.m_fScore (float)

RemoteStorage.OnRemoteStoragePublishedFileSubscribed()

Callback for RemoteStoragePublishedFileSubscribed_t

callback(data) receives:

data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_nAppID (int - AppId_t)

RemoteStorage.OnRemoteStoragePublishedFileUnsubscribed()

Callback for RemoteStoragePublishedFileUnsubscribed_t

callback(data) receives:

data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_nAppID (int - AppId_t)

RemoteStorage.OnRemoteStoragePublishedFileDeleted()

Callback for RemoteStoragePublishedFileDeleted_t

callback(data) receives:

data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_nAppID (int - AppId_t)

RemoteStorage.OnRemoteStorageUpdateUserPublishedItemVoteResult()

Callback for RemoteStorageUpdateUserPublishedItemVoteResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)

RemoteStorage.OnRemoteStorageUserVoteDetails()

Callback for RemoteStorageUserVoteDetails_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_eVote (int - EWorkshopVote)

RemoteStorage.OnRemoteStorageEnumerateUserSharedWorkshopFilesResult()

Callback for RemoteStorageEnumerateUserSharedWorkshopFilesResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nResultsReturned (int)
data.m_nTotalResultCount (int)
data.m_rgPublishedFileId (uint64[] - PublishedFileId_t)

RemoteStorage.OnRemoteStorageSetUserPublishedFileActionResult()

Callback for RemoteStorageSetUserPublishedFileActionResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_eAction (int - EWorkshopFileAction)

RemoteStorage.OnRemoteStorageEnumeratePublishedFilesByUserActionResult()

Callback for RemoteStorageEnumeratePublishedFilesByUserActionResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_eAction (int - EWorkshopFileAction)
data.m_nResultsReturned (int)
data.m_nTotalResultCount (int)
data.m_rgPublishedFileId (uint64[] - PublishedFileId_t)
data.m_rgRTimeUpdated (int)

RemoteStorage.OnRemoteStoragePublishFileProgress()

Callback for RemoteStoragePublishFileProgress_t

callback(data) receives:

data.m_dPercentFile (float)
data.m_bPreview (bool)

RemoteStorage.OnRemoteStoragePublishedFileUpdated()

Callback for RemoteStoragePublishedFileUpdated_t

callback(data) receives:

data.m_nPublishedFileId (uint64 - PublishedFileId_t)
data.m_nAppID (int - AppId_t)
data.m_ulUnused (uint64)

RemoteStorage.OnRemoteStorageFileWriteAsyncComplete()

Callback for RemoteStorageFileWriteAsyncComplete_t

callback(data) receives:

data.m_eResult (int - EResult)

RemoteStorage.OnRemoteStorageFileReadAsyncComplete()

Callback for RemoteStorageFileReadAsyncComplete_t

callback(data) receives:

data.m_hFileReadAsync (uint64 - SteamAPICall_t)
data.m_eResult (int - EResult)
data.m_nOffset (int)
data.m_cubRead (int)

RemoteStorage.OnRemoteStorageLocalFileChange()

Callback for RemoteStorageLocalFileChange_t

callback(data) receives no fields (notification only).

Example:

function Steam.RemoteStorage.OnRemoteStorageLocalFileChange()
    local count = Steam.RemoteStorage.GetLocalFileChangeCount()
    print('Cloud file changes detected:', count)
    reloadCloudSaves()
end