Skip to main content

SearchFilter

This construct represents a filter that a player can use to search resources in the resource (orange) section of the system.

JSON Format

{
"type": "SearchFilter",
"name": ...,
"stat": ...,
"true_name": ...,
"false_name": ...,
"options": ...,
"options_display_stat": ...
}

Fields

FieldTypeRequiredDescription
options_display_statStringFor resource-type stat filters, you need to provide the resource id of the values that the stat will contain in the options property, and you also need to specify what stat of this resource should be used to display its option value in the filter. For example, if this is a search filter for a species on its source stat, and source is a resource of type source that contains a stat called the_source_name, you could set this property to the_source_name as you would want to display that when showing the player the options they can choose from.