Filter

This formula allows you to filter values from an array (list) based on a condition.

Returns

array<T>

JSON Format

{
  "type": "filter",
  "components": ...,
  "filter": ...,
  "filter_value_key": ...
}

RPG Script

This component can be written in RPG Script as:

filter(...)

Fields

Field	Type	Required	Description
filter_value_key	String		Optional parameter that lets you provide a key to use in the filter formula to access the array's current value in the iteration. e.g: if you are iterating classes, you might want to assign "$class" to the filter_value_key, to make your system easier to read. This is also helpful when dealing with nested filter formulas, as it will allow inner filter formulas to access the values of outer filter formulas.