Recording Options

Table of contents

1. Description
2. Format

---

Origin:

Game/Engine

Target:

Frame by Frame

Description

The Recording Options message informs Frame by Frame of the different recording options available in your game/engine.

The game/engine should send it to Frame by Frame in the following situations:

• When first connecting to Frame by Frame.
• Every time the value of a recording option changes.

Format

The format is an array of RecordingOption objects:

[RecordingOption, RecordingOption, ...]

Each RecordingOption object should have the following layout:

{
    "name": string,
    "enabled": boolean
}

• name: Name of the recording option.
• enabled: Indicates if the recording option is enabled or not.

Example Example of a full RecordingOption message. The type value is documented in the Network Messages section.

{
    "type": 1,
    "data": [
        { "name": "Colliders", "enabled": true },
        { "name": "Damage Handling", "enabled": false }
    ]
}