Datatype · Structs

EntitySearchEntry

struct

Search-entry definition consumed by entity.add_search_entry / entity.update_search_entry. Describes how to walk the DataModel from a known anchor and which descendants qualify as entities.

Exactly one of EntityRelation, Team, or TeamScanContext must be supplied. EntityRelation is the simplest form: a single Enum value synthesises a default Team for you. Team is for static team membership; TeamScanContext is for dynamic team assignment driven by a second validator tree.

Fields

Name	Type	Description
EntityKind	EntityKind	Classification applied to matched descendants: `NPC`, `Player`, or `Unknown`.
EntityRelation	EntityRelation?	Shortcut: pick `Self`, `Enemy`, `Teammate`, or `Neutral` and a default `Team` is synthesised for you. Mutually exclusive with `Team` and `TeamScanContext`.
EvaluationDistance	number?	Optional max distance (in studs) from the local character. `0` disables the gate.
FirstValidChild	boolean	When `true`, stop at the first descendant that passes the validator tree. When `false`, sweep all matches.
Id	string	Stable unique id. Duplicates are rejected with `EntityActionResult.DuplicateId`. Pass this back to `remove_search_entry` / `update_search_entry`.
IgnoredNames	{ string }?	Optional leaf names to skip while walking `SearchPath`.
Name	string	Human-readable label used in overlays and logs.
ScanValidatorTree	{ ValidatorEntry }	Chain of validator predicates AND-ed in order. Every entry must pass for the descendant to qualify.
SearchMode	EntitySearchMode	Walk order: `BFS`, `DFS`, or `First`. `First` is shorthand for `FirstValidChild` semantics.
SearchPath	string	Dotted DataModel path to begin the descent at, e.g. `Workspace.Enemies`.
Team	EntityTeamSpec?	Static team rule. Mutually exclusive with `EntityRelation` and `TeamScanContext`.
TeamScanContext	EntityTeamScanContext?	Dynamic team rule driven by a second validator tree. Mutually exclusive with `EntityRelation` and `Team`.