LootLocker Unreal SDK 10.6.0
Game backend SDK for Unreal Engine
Loading...
Searching...
No Matches
Player Files

Detailed Description

CDN-backed file storage scoped to a player's profile.

Best suited for large files such as screenshots, cloud saves, or profile pictures that benefit from CDN delivery. For small key-value data prefer Metadata. Each file upload requires a declared purpose; files can be marked private to restrict visibility. Up to five revisions per file are retained, with revert capability in the Web Console.

See the LootLocker documentation.

Typedef Documentation

◆ FLootLockerFileContentDelegate

typedef void(* FLootLockerFileContentDelegate) (FLootLockerPlayerFileContentResponse)

C++ response callback delegate; receives an FLootLockerPlayerFileContentResponse result.

◆ FLootLockerFileDeletedDelegate

typedef void(* FLootLockerFileDeletedDelegate) (FLootLockerResponse)

C++ response callback delegate; receives an FLootLockerResponse result.

◆ FLootLockerFileListDelegate

typedef void(* FLootLockerFileListDelegate) (FLootLockerFileListResponse)

C++ response callback delegate; receives an FLootLockerFileListResponse result.

◆ FLootLockerFileRevisionsDelegate

typedef void(* FLootLockerFileRevisionsDelegate) (FLootLockerPlayerFileRevisionsResponse)

C++ response callback delegate; receives an FLootLockerPlayerFileRevisionsResponse result.

◆ FLootLockerUploadFileDelegate

typedef void(* FLootLockerUploadFileDelegate) (FLootLockerPlayerFileResponse)

C++ response callback delegate; receives an FLootLockerPlayerFileResponse result.

Function Documentation

◆ DeletePlayerFile()

static FString ULootLockerSDKManager::DeletePlayerFile ( const int32  FileID,
const FLootLockerFileDeletedDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Permanently delete a player-owned file (irreversible).

Parameters
FileIDFile id to delete (from upload response or ListFiles)
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ DeletePlayerFileByKey()

static FString ULootLockerSDKManager::DeletePlayerFileByKey ( const FString &  Key,
const FLootLockerFileDeletedDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Delete a player file by its key.

Parameters
KeyThe key of the file to delete
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ GetFileByKey()

static FString ULootLockerSDKManager::GetFileByKey ( const FString &  Key,
const FLootLockerUploadFileDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Get a player file by its key (upsert key).

Parameters
KeyThe key of the file
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ GetFileRevision()

static FString ULootLockerSDKManager::GetFileRevision ( const int32  FileID,
const FString &  RevisionID,
const FLootLockerFileContentDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Get a specific revision of a player file by its revision ULID.

Parameters
FileIDFile id (retrieved from upload response or ListFiles)
RevisionIDThe ULID of the revision to retrieve
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ GetFileRevisionByKey()

static FString ULootLockerSDKManager::GetFileRevisionByKey ( const FString &  Key,
const FString &  RevisionID,
const FLootLockerFileContentDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Get a specific revision of a player file by its key and revision ULID.

Parameters
KeyThe key of the file
RevisionIDThe ULID of the revision to retrieve
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ GetSingleFile()

static FString ULootLockerSDKManager::GetSingleFile ( const int32  FileID,
const FLootLockerUploadFileDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Retrieve metadata (including access URL) for a single file.

Parameters
FileIDFile id (retrieved from upload response or ListFiles)
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ ListFileRevisions()

static FString ULootLockerSDKManager::ListFileRevisions ( const int32  FileID,
const FLootLockerFileRevisionsDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

List all revisions for a player file.

Parameters
FileIDFile id (retrieved from upload response or ListFiles)
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ ListFileRevisionsByKey()

static FString ULootLockerSDKManager::ListFileRevisionsByKey ( const FString &  Key,
const FLootLockerFileRevisionsDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

List all revisions for a player file identified by its key.

Parameters
KeyThe key of the file
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ ListFiles()

static FString ULootLockerSDKManager::ListFiles ( const FLootLockerFileListDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

List all files owned by the player.

Parameters
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ ListOtherPlayersPublicFiles()

static FString ULootLockerSDKManager::ListOtherPlayersPublicFiles ( const int32  PlayerID,
const FLootLockerFileListDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

List all public files owned by another player (by legacy PlayerID).

Parameters
PlayerIDLegacy player id of the target player
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ PromoteFileRevision()

static FString ULootLockerSDKManager::PromoteFileRevision ( const int32  FileID,
const FString &  RevisionID,
const FLootLockerDefaultDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Promote a specific revision to be the current (active) revision of a player file.

Parameters
FileIDFile id (retrieved from upload response or ListFiles)
RevisionIDThe ULID of the revision to promote
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ PromoteFileRevisionByKey()

static FString ULootLockerSDKManager::PromoteFileRevisionByKey ( const FString &  Key,
const FString &  RevisionID,
const FLootLockerDefaultDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Promote a specific revision to be the current (active) revision of a player file identified by its key.

Parameters
KeyThe key of the file
RevisionIDThe ULID of the revision to promote
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ UpdateFile()

static FString ULootLockerSDKManager::UpdateFile ( const int32  FileId,
const FLootLockerFileUpdateRequest &  Request,
const FLootLockerUploadFileDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Update an existing player-owned file with new content or metadata.

Parameters
FileIdFile id (retrieved from upload response or ListFiles)
RequestFile update request payload
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ UploadFile()

static FString ULootLockerSDKManager::UploadFile ( const FLootLockerFileUploadRequest &  Request,
const FLootLockerUploadFileDelegate &  OnComplete,
const FString &  ForPlayerWithUlid = "" 
)
static

Upload a file owned by the player (initial creation).

Use UpdateFile to modify existing files.

Parameters
RequestFile upload request payload
OnCompleteDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

Typedefs

typedef void(* FLootLockerUploadFileDelegate) (FLootLockerPlayerFileResponse)
 C++ response callback delegate; receives an FLootLockerPlayerFileResponse result.
 
typedef void(* FLootLockerFileListDelegate) (FLootLockerFileListResponse)
 C++ response callback delegate; receives an FLootLockerFileListResponse result.
 
typedef void(* FLootLockerFileDeletedDelegate) (FLootLockerResponse)
 C++ response callback delegate; receives an FLootLockerResponse result.
 
typedef void(* FLootLockerFileRevisionsDelegate) (FLootLockerPlayerFileRevisionsResponse)
 C++ response callback delegate; receives an FLootLockerPlayerFileRevisionsResponse result.
 
typedef void(* FLootLockerFileContentDelegate) (FLootLockerPlayerFileContentResponse)
 C++ response callback delegate; receives an FLootLockerPlayerFileContentResponse result.
 

Functions

static FString ULootLockerSDKManager::UploadFile (const FLootLockerFileUploadRequest &Request, const FLootLockerUploadFileDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Upload a file owned by the player (initial creation).
 
static FString ULootLockerSDKManager::UpdateFile (const int32 FileId, const FLootLockerFileUpdateRequest &Request, const FLootLockerUploadFileDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Update an existing player-owned file with new content or metadata.
 
static FString ULootLockerSDKManager::ListFiles (const FLootLockerFileListDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 List all files owned by the player.
 
static FString ULootLockerSDKManager::ListOtherPlayersPublicFiles (const int32 PlayerID, const FLootLockerFileListDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 List all public files owned by another player (by legacy PlayerID).
 
static FString ULootLockerSDKManager::GetSingleFile (const int32 FileID, const FLootLockerUploadFileDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Retrieve metadata (including access URL) for a single file.
 
static FString ULootLockerSDKManager::DeletePlayerFile (const int32 FileID, const FLootLockerFileDeletedDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Permanently delete a player-owned file (irreversible).
 
static FString ULootLockerSDKManager::ListFileRevisions (const int32 FileID, const FLootLockerFileRevisionsDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 List all revisions for a player file.
 
static FString ULootLockerSDKManager::GetFileRevision (const int32 FileID, const FString &RevisionID, const FLootLockerFileContentDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Get a specific revision of a player file by its revision ULID.
 
static FString ULootLockerSDKManager::PromoteFileRevision (const int32 FileID, const FString &RevisionID, const FLootLockerDefaultDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Promote a specific revision to be the current (active) revision of a player file.
 
static FString ULootLockerSDKManager::GetFileByKey (const FString &Key, const FLootLockerUploadFileDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Get a player file by its key (upsert key).
 
static FString ULootLockerSDKManager::ListFileRevisionsByKey (const FString &Key, const FLootLockerFileRevisionsDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 List all revisions for a player file identified by its key.
 
static FString ULootLockerSDKManager::GetFileRevisionByKey (const FString &Key, const FString &RevisionID, const FLootLockerFileContentDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Get a specific revision of a player file by its key and revision ULID.
 
static FString ULootLockerSDKManager::PromoteFileRevisionByKey (const FString &Key, const FString &RevisionID, const FLootLockerDefaultDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Promote a specific revision to be the current (active) revision of a player file identified by its key.
 
static FString ULootLockerSDKManager::DeletePlayerFileByKey (const FString &Key, const FLootLockerFileDeletedDelegate &OnComplete, const FString &ForPlayerWithUlid="")
 Delete a player file by its key.