Extend tree synchonization to lists and classes

[aschaeffer]

Currently SharedVars are synchronized via the Inexor Tree. Next step is to synchronize lists/arrays and complex data structures like c++ objects. This would enables us to complete other tasks like the HUD which depends on these information.

Tree path format

• [ ] Define a tree path format for list items
  • /path/to/the/list/0
  • /path/to/the/list/1
• [ ] Define a tree path format for objects, nested objects and
  • /path/to/the/object (e.g.: /gamestate/player1)
  • /path/to/the/object/attributeName (e.g.: /gamestate/player1/frags)
  • /path/to/the/object/nestedObject (e.g.: /gamestate/player1/position)
  • /path/to/the/object/nestedObject/attributeName (e.g.: /gamestate/player1/position/x)
  • /path/to/the/list (e.g.: /gamestate/players)
  • /path/to/the/list/0 (e.g.: /gamestate/players/0)
  • /path/to/the/list/0/attributeName (e.g.: /gamestate/players/0/frags)
  • /path/to/the/list/0/nestedObject/attributeName (e.g.: /gamestate/players/0/position/x)

Tasks Inexor Flex

• [ ] Lists
  • [ ] Add a new datatype list
  • Which is basically a node
  • Don't allow to add childs using addChild(...)
  • Implement typical array functions for appending, inserting and sorting
  • [ ] Receive list messages
  • Append/insert new list entry
  • Update list entry value
  • Remove list entry
  • [ ] Send list messages
  • Append/insert new list entry
  • Update list entry value
  • Remove list entry
  • [ ] Extend the initialization of the Inexor Tree (recursively initialize lists)
• [ ] Objects
  • [ ] Objects in C++ are normal tree nodes (datatype node)
  • [ ] Receive object created messages
  • [ ] Receive object attribute messages
  • [ ] Receive object attribute messages
  • [ ] Extend the initialization of the Inexor Tree (recursively initialize objects)

Tasks Inexor Core

• TODO: @a-teammate

GRPC / Proto

Inexor Tree Structure for Shared Lists

Line numbers for pastebin: http://pastebin.com/QrDcTHa6

• /players
  • tree_node_type
    • list
  • node_name
    • path (players) from event list_inexor_rendering_player_added (Line number 1257)
  • message_mapping
    • added list_inexor_rendering_player_added
    • modified list_inexor_rendering_player_modified
    • removed list_inexor_rendering_player_removed
• /players/0
  • tree_node_type
    • list_entry
  • node_name
    • intern_shared_list_id_number (0) from message list_inexor_rendering_player_added (Line number 45)
    • The node name is always the array index and have to be numeric
    • We have to ensure that!
• /players/0/kills
  • tree_node_type
    • data type (int32) from message list_inexor_rendering_player_added (Line number 47)
  • mapping
    • path (kills) from message list_inexor_rendering_player_added (Line number 43)
  • message_mapping
    • sharedclass_member__rendering_kills (Line number 47)

Newer version of the proto file:

• http://pastebin.com/6HGzw7Cp

List Entry Add Event

In order to create new list elements in NodeJS:

1. Generate a new message
   • Get the message type from the list-Node (/players)
     • list_inexor_rendering_player_added
2. Determine the array index in the message
   • Get the array index from the list_entry-Node (node_name = 0)
   • Mapping: intern_shared_list_id_number
3. For each sub node of a list element check if a mapping exists and set the message value for the corresponding member variable
   • e.g. /players/0/kills
     • message_mapping == sharedclass_member__rendering_kills
4. Send message

List Entry Modify Event

In order to change list elements in NodeJS:

1. Generate a new message
   • Get the message type from the list-Node (/players)
     • list_inexor_rendering_player_modified
2. Determine the array index in the message
   • Get the array index from the list_entry-Node (node_name = 0)
   • Mapping: intern_shared_list_id_number
3. For each sub node of a list element check if a mapping exists and set the message value for the corresponding member variable
   • e.g. /players/0/kills
     • message_mapping == sharedclass_member__rendering_kills
   • Optimization: synchronize changed member variables only
4. Send message

List Entry Remove Event

In order to remove list elements in NodeJS:

1. Generate a new message
   • Get the message type from the list-Node (/players)
     • list_inexor_rendering_player_removed
2. Determine the array index in the message
   • Get the array index from the list_entry-Node (node_name = 0)
   • Mapping: intern_shared_list_id_number
3. Send message