SaveData::SaveDataRequests::SaveDataBufferParams Struct Reference

The parameters used to send a save data buffer request. More...

#include <SaveDataRequestBus.h>

Public Attributes
DataBuffer	dataBuffer = DataBuffer(nullptr, &DataBufferDeleterNone)
AZ::u64	dataBufferSize = 0
	The size of the data buffer to be saved.
AZStd::string	dataBufferName
AzFramework::LocalUserId	localUserId = AzFramework::LocalUserIdNone
	The local user id the data buffer to be saved is associated with.
OnDataBufferSaved	callback = nullptr
	Callback function to invoke on the main thread once the data buffer has been saved.

Detailed Description

The parameters used to send a save data buffer request.

Member Data Documentation

dataBuffer

DataBuffer SaveData::SaveDataRequests::SaveDataBufferParams::dataBuffer = DataBuffer(nullptr, &DataBufferDeleterNone)

mutable

The data buffer to be saved. Please also see DataBufferDeleter. It is mutable so the SaveDataBufferParams struct can be passed around by const ref to achieve 'conceptual constness', but also move-captured by the lambda function that will perform the save.

dataBufferName

AZStd::string SaveData::SaveDataRequests::SaveDataBufferParams::dataBufferName

The name of the data buffer to be saved. Used as a filename on most platforms, or in another way to uniquely identify this save data buffer for the associated local user.

---

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

• Gems/SaveData/Code/Include/SaveData/SaveDataRequestBus.h