Scene

Description of the scene field

interface SceneState {
    updatedAttributesFromUI: string[] | undefined
    updatedAttributesFromPlayer: string[] | undefined
    focusedNodeId: string
}

updatedAttributesFromUI

Updated by: UI/Player

Notify the Player that some attributes were updated in the UI. The Player will send the update to the other users.

Data model

updatedAttributesFromUI: string[] | undefined

Examples

An attribute has been updated

{
  "scene":{
    ...
    "updatedAttributesFromUI": ["Status"]
    ...
  }
}

Operations done by the Player

Once received by the Player, the attributes are removed from updatedAttributesFromUI.

updatedAttributesFromPlayer

Updated by: Player

Notify the UI that some attributes were updated by a live user on the same file.

Data model

updatedAttributesFromPlayer: string[] | undefined

Operations done by the Player

The Player updates the updatedAttributesFromPlayer:

{
  "scene":{
    ...
    "updatedAttributesFromPlayer": ["Status"]
    ...
}

focusedNodeId

Updated by: UI/Player

The ID of the node that is focused.

Data model

focusedNodeId: string

Examples

Focus on a node

{
  "scene":{
    ...
    "focusedNodeId":"61f8f8dda3d924000949d5cd"
    ...
}

Operations done by the Player

If the user focuses on a Node in the 3D view by double-clicking on it for instance, the Player changes the focused node:

{
  "scene":{
    ...
    "focusedNodeId":"000949d5cd61f8f8dda3d924"
    ...
}

---

November 24, 2022 March 8, 2022