host.anzo.eossdk.eos.sdk.playerdatastorage.callbacks

Interface EOS_PlayerDataStorage_OnWriteFileDataCallback

All Superinterfaces:

com.sun.jna.Callback

public interface EOS_PlayerDataStorage_OnWriteFileDataCallback
extends com.sun.jna.Callback

Since:

8/22/2023

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Callback

com.sun.jna.Callback.UncaughtExceptionHandler

Field Summary

Fields inherited from interface com.sun.jna.Callback

FORBIDDEN_NAMES, METHOD_NAME

Method Summary

Modifier and Type	Method and Description
EOS_PlayerDataStorage_EWriteResult	apply(EOS_PlayerDataStorage_WriteFileDataCallbackInfo data, com.sun.jna.Pointer outDataBuffer, com.sun.jna.ptr.IntByReference outDataWritten) Callback for when we are ready to get more data to be written into the requested file.

Method Detail

apply

EOS_PlayerDataStorage_EWriteResult apply(EOS_PlayerDataStorage_WriteFileDataCallbackInfo data,
                                         com.sun.jna.Pointer outDataBuffer,
                                         com.sun.jna.ptr.IntByReference outDataWritten)

Callback for when we are ready to get more data to be written into the requested file. It is undefined how often this will be called during a single tick.

Parameters:

data - Struct containing metadata for the file being written to, as well as the max length in bytes that can be safely written to DataBuffer

outDataBuffer - A buffer to write data into, to be appended to the end of the file that is being written to. The maximum length of this value is provided in the Info parameter. The number of bytes written to this buffer should be set in OutDataWritten.

outDataWritten - The length of the data written to OutDataBuffer. This must be less than or equal than the DataBufferLengthBytes provided in the Info parameter

Returns:

The result of the write operation. If this value is not EOS_PlayerDataStorage_EWriteResult.EOS_WR_ContinueWriting, this callback will not be called again for the same request. If this is set to EOS_PlayerDataStorage_EWriteResult.EOS_WR_FailRequest or EOS_PlayerDataStorage_EWriteResult.EOS_WR_CancelRequest, all data written during the request will not be saved