[2.0.10] API documentation doesn't match data-raw-dump.json from Space Age
Posted: Thu Oct 24, 2024 4:30 pm
I'm writing automated tooling to read the whole data dump from json, and I've found a few inconsistencies. These are the changes to documentation to make them match the found data:
AchievementPrototypeWithCondition::objective_condition
must be optional (at least it's missing for "solaris")
LoaderPrototype
shares typename with Loader1x2Prototype
please make LoaderPrototype abstract
and remove it from AnyPrototype (which has 2 entries for type="loader")
SpaceLocationPrototype::gravity_pull
must be optional (at least it's missing from "space-location-unknown")
UtilityConstants::space_platform_default_speed_formula
must be renamed to space_platform_acceleration_expression
CranePartDyingEffect::particle_effects
must be of type CreateParticleTriggerEffectItem or array[CreateParticleTriggerEffectItem]
CursorBoxSpecification::rts_selected
must be renamed to spidertron_remote_selected
CursorBoxSpecification::rts_to_be_selected
must be renamed to spidertron_remote_to_be_selected
MapLocation::direction
must be of type Direction
ProcessionTimeline::audio_events
must be optional
RailPictureSet::rail_endings
must be optional (at least it's missing from "dummy-rail-ramp")
SingleGraphicLayerProcessionBezierControlPoint::frame
must be optional
Sound
must be of type struct or array[SoundDefinition] or FileName
TileTransitionsVariants::main
must be optional
WorkingVisualisations::working_visualisations
must be of type WorkingVisualisation or array[WorkingVisualisation]
At least that is what directly threw exceptions in my face.
AchievementPrototypeWithCondition::objective_condition
must be optional (at least it's missing for "solaris")
LoaderPrototype
shares typename with Loader1x2Prototype
please make LoaderPrototype abstract
and remove it from AnyPrototype (which has 2 entries for type="loader")
SpaceLocationPrototype::gravity_pull
must be optional (at least it's missing from "space-location-unknown")
UtilityConstants::space_platform_default_speed_formula
must be renamed to space_platform_acceleration_expression
CranePartDyingEffect::particle_effects
must be of type CreateParticleTriggerEffectItem or array[CreateParticleTriggerEffectItem]
CursorBoxSpecification::rts_selected
must be renamed to spidertron_remote_selected
CursorBoxSpecification::rts_to_be_selected
must be renamed to spidertron_remote_to_be_selected
MapLocation::direction
must be of type Direction
ProcessionTimeline::audio_events
must be optional
RailPictureSet::rail_endings
must be optional (at least it's missing from "dummy-rail-ramp")
SingleGraphicLayerProcessionBezierControlPoint::frame
must be optional
Sound
must be of type struct or array[SoundDefinition] or FileName
TileTransitionsVariants::main
must be optional
WorkingVisualisations::working_visualisations
must be of type WorkingVisualisation or array[WorkingVisualisation]
At least that is what directly threw exceptions in my face.