Recording Options Changed

Table of contents

  1. Description
  2. Format
  3. Example

Origin:

Frame by Frame

Target:

Game/Engine

Description

The Recording Options Changed message informs that a recording option has changed. This means that it has been either activated or deactivated.

The Game/Engine should receive this message, and enable or disable that recording option locally.

Format

The format of the data is a JSON with 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 RecordingOptionChanged message. The type value is documented in the Network Messages section.

{
    "type": 2,
    "data": {
        "name": "Colliders",
        "enabled": true
    }
}