Skip to main content

Filter

Overview

This document explains the TargetFilter commands used to pick which object a script acts on.

  • A Condition decides whether a script runs. A Filter decides what it runs against.
  • A Filter searches the world for a matching object — a chair to sit on, a nearby character to talk to, an inventory item to hand over — and puts the result in OutResult for the rest of the script to use.
  • Filters are generated from the game source, so this list matches the build.

Parameter

Every Filter takes the same three arguments:

ParamsDescription
InContextThe BaseObject the search starts from
InFilterThe filter's own settings. Which of S1 · S2 · SearchRange and other fields matter depends on the command
OutResultWhere the matched object is written

The per-command pages list exactly which InFilter fields that command reads, and what values they accept.

Full List