Space Engineers

Space Engineers

Asteroid Filter API
Echthros  [developer] 16 Apr @ 1:58pm
Config Values
The config will allow the user to change the priority of all registered filters to change what order they are processed in.

<AsteroidFilterInfo Name="NameHere" Priority="###" />
Priority value can be changed as desired. Do not change the Name value or it will not be applied.

Config will contain a list of <ActiveFilters> and <InactiveFilters>. Active filters are filters that are currently registered with the system and will be applied in the world. Inactive filters are filters that had been added previously, but have since been removed (i.e. you removed the corresponding filter mod from the world). The inactive filter list only exists to preserve the last priority setting for that filter name, so removing/changing elements will not affect anything unless you re-add the relevant filter mod to the world.

The order of elements in the list does not matter (they will be automatically reordered to reflect the priority order from highest to lowest).

Filters can be reordered as desired, but in general you may want to follow the rule of thumb:
  • Subtractive filters are highest priority.
  • Additive filters are medium priority.
  • The "RemoveAll" filter is lowest priority (i.e. 0).

All additive filters will also add the "RemoveAll" filter at lowest priority so that any asteroids that do not meet the requirements of any of the additive filters will be removed.

In general, the priority order of subtractive filters relative to each other and additive filters relative to each other do not matter as long as all of the subtractives are above all of the additives. Also, this rule is not absolute depending on how complex you want your ruleset. Just keep in mind that the first filter in the list to be triggered is the only one that will be used.
Last edited by Echthros; 16 Apr @ 1:59pm