Skip to content

The Entity Config

Connor Jakubik edited this page Aug 6, 2024 · 4 revisions
The Fundamentals → The Entity Config

Up to date for Platform 0.16.0

Written by Connor Jakubik.

Prerequisite reading:


The Entity Config

Feature Track: https://github.com/SimDynamX/SC_Platform/issues/679

An Entity Config file is a JSON-format file that holds a "template" of an Entity that matches what would be in the Sim Config for a similar Entity. We use these to cut down on the copy pasting of parameters that shouldn't change from simulation to simulation for a certain Entity. For example, we use this for our solar system Entities to supply them every parameter they need to be driven by NAIF SPICE, with the exception of the observer and observerFrame parameters (which can be filled in by the ParamOverrides functionality provided by FromTemplate).

These can be used in a simulation by the use of the FromTemplate Entity Type, with the path to the particular Entity Config entered in #FromTemplate\Source_Path. We have most of our Entity Configs in the SharedData/SCAssets/* directories.

Systems is ignored on Entity Configs.

TODO

  • An example
  • Sim Config functionality that doesn't work in an EntityConfig (EntityRef?)
  • What exactly can be left out of this compared to the Sim Config's entities