Skip to content
ClassStorage & Replay@public

FrameRecord

Represents recorded inputs and state checksum for a single simulation frame.

ts
export declare class FrameRecord

Constructors

ts
constructor(frame?: number, keys?: CodePair[], mouse?: MouseRecord | null, checksum?: string | null, gamepads?: FlxGamepadFrameRecord[], touches?: FlxTouchFrameRecord[])

Constructs a new instance of the FrameRecord class

ParameterTypeDescription
framenumber-
keysCodePair[]-
mouseMouseRecord | null-
checksumstring | null-
gamepadsFlxGamepadFrameRecord[]-
touchesFlxTouchFrameRecord[]-

Properties

PropertyModifiersTypeDescription
checksum-string | null-
frame-number-
gamepads-FlxGamepadFrameRecord[]-
keys-CodePair[]-
mouse-MouseRecord | null-
touches-FlxTouchFrameRecord[]-

Methods

destroy()

ts
destroy(): void

Releases resources associated with this frame record.

Returns: void

load()

ts
load(data: string | FrameRecordData): void

Loads data into this frame record from a plain object or serialized string.

Parameters:

ParameterTypeDescription
datastring | FrameRecordData-

Returns: void

save()

ts
save(): FrameRecordData

Serializes the frame record into a plain JSON object.

Returns: FrameRecordData

Released under the MIT License.