Queries Actions

Built-in authoring reference for Mercury 1.0.1. All actions.

Check Animator State

True while this instance’s 3D Animator is in the named state (the blend target counts from the moment a transition starts). Name a Layer to read that layer’s machine. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryAnimState.

Editor category: Queries > 3D World.

Availability: 3D Logic only.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Parameter	Type	Optional	Details
State	text	No	Text value; some actions also accept $global names.
Layer	text	Yes	An Animator layer name. Blank reads the base machine.

Results

Field	Type	Description
value	boolean

Check Assets Prepared

Checks whether the selected request completed successfully. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryAssetsPrepared.

Editor category: Queries > Asset Loading.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Preparation token	text	No	Text value; some actions also accept $global names.

Results

Field	Type	Description
value	boolean

Check Block At

True when a block (optionally the named one) fills that 3D Scene cell. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryBlockAt.

Editor category: Queries > 3D World.

Availability: 3D Logic only.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Cell X	number	No	Expression or literal value.
Cell Y	number	No	Expression or literal value.
Cell Z (Level)	number	No	Expression or literal value.
Block	text	Yes	Blank = any block; a name matches that palette block only.

Results

Field	Type	Description
value	boolean

Check Builder Item Is Available

Checks whether this Object is available in the Builder toolbox. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryBuilderItemAvailable.

Editor category: Queries > Builder Mode.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Object	thing:object	No	Object resource name. Live-instance target parameters may also select an attached Child Object placement.

Results

Field	Type	Description
value	boolean

Check Builder Mode

Checks whether Build My Version is open. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryBuilderMode.

Editor category: Queries > Builder Mode.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Builder Navigation Is Enabled

Checks whether Builder navigation controls are enabled. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryBuilderNavigationEnabled.

Editor category: Queries > Builder Mode.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Builder Placement Exists

Checks whether the placement exists in the player-created version. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryBuilderPlacementExists.

Editor category: Queries > Builder Mode.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Placement ID	text	Yes	Leave blank to test the selected placement.

Results

Field	Type	Description
value	boolean

Check Can Craft

Checks whether the complete recipe transaction can succeed. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryCanCraft.

Editor category: Queries > Inventory and Crafting.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Recipes Table	thing:data	No	Choose a data resource.
Recipe Row	text	No	Text value; some actions also accept $global names.
Inventory Table	thing:data	No	Choose a data resource.
Times	number	Yes	Expression or literal value. Default: 1.
Station	text	Yes	Text value; some actions also accept $global names.

Results

Field	Type	Description
value	boolean

Check Chip Output

Questions a chip’s OUT latch — what its program last spoke — without typing the $<prefix>_out global by hand. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryChipOutput.

Editor category: Queries > Computers.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Chip Object	thing:object	Yes	The Object whose Coil Chip is read. Blank reads this object’s own chip. Default: “”.
Operator	enum	Yes	Choose one of the listed options. Choices: ==, !=, <, <=, >, >=. Default: “==”.
Value	number	No	Compared against the chip’s OUT latch (0–15), the picker-friendly face of $<prefix>_out. Default: 1.

Results

Field	Type	Description
value	boolean

Check Connected

Checks whether this game is connected to a multiplayer room. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryNetConnected.

Editor category: Queries > Multiplayer.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Cooldown Ready

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryCooldownReady.

Editor category: Queries > Logic and State.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Parameter	Type	Optional	Details
Cooldown Key	text	No	Text value; some actions also accept $global names. Default: “cooldown”.

Results

Field	Type	Description
value	boolean

Check Data Row Exists

Checks whether the Data Table has that row. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryDataRow.

Editor category: Queries > Data Tables.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Table	thing:data	No	Choose a data resource.
Row	number-or-text	No	A row name, or an expression for a 0-based row index when no row has that name.

Results

Field	Type	Description
value	boolean

Check Day Phase

True during that part of the day — the phase boundaries come from the active Scene’s Atmosphere. Expressions can also read $time_phase. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryTimePhase.

Editor category: Queries > Time and Saves.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Phase	enum	No	Choose one of the listed options. Choices: dawn, day, dusk, night. Default: “night”.

Results

Field	Type	Description
value	boolean

Check Dialogue Active

Checks whether a conversation is open. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryDialogueActive.

Editor category: Queries > Animation and Media.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Event Other Is Relative

Compares the Event Other collider center with this Object without writing coordinate math. It is false when the Event has no Other Object. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryEventOtherRelativePosition.

Editor category: Queries > Objects and Spatial Queries.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Position	enum	No	Choose one of the listed options. Choices: above, below, left of, right of. Default: “below”.
Minimum Gap	number	Yes	Required collider-center separation in meters. Default: 0.

Results

Field	Type	Description
value	boolean

Check Exists

True when Applies To still names at least one live instance: a named result (an empty set, or one whose instances were destroyed, is false), an Instance Parameter, or an Instance Output of a Function call. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryExists.

Editor category: Queries > Objects and Spatial Queries.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Results

Field	Type	Description
value	boolean

Check Game State

Runs nested actions while the singular project Game State matches the selected value. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryGameState.

Editor category: Queries > Logic and State.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Game State	enum	No	Value for Game State.

Results

Field	Type	Description
value	boolean

Check Grounded

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryGrounded.

Editor category: Queries > Movement and Physics.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Happened Before

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryHappenedBefore.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
First Event	text	No	True only when the FIRST time this was remembered came strictly before the other event’s first time. Both must have happened — absence is never “before”. Default: “met-elder”.
Later Event	text	No	The event that should have come after. Default: “door-opened”.

Results

Field	Type	Description
value	boolean

Check Has Item

Runs nested actions when the Inventory table has at least this many of the item. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryHasItem.

Editor category: Queries > Inventory and Crafting.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Inventory Table	thing:data	No	Choose a data resource.
Item	text	No	Text value; some actions also accept $global names.
Amount	number	No	Expression or literal value. Default: 1.

Results

Field	Type	Description
value	boolean

Check Host

Runs the nested actions only on the host (the first player in the room — the one whose game runs the shared logic in Synced objects mode). The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryNetHost.

Editor category: Queries > Multiplayer.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check In State

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryInState.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
State	text	No	True when this instance’s state machine is currently in this state. Default: “alert”.

Results

Field	Type	Description
value	boolean

Check In Water

True while this instance is in water — inside a Water Zone in a 2D Scene, or below the surface of ANY water body in a 3D Scene. Swim animations, splashy footsteps, air timers and “slower in the river” checks all start here. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryInWater.

Editor category: Queries > Movement and Physics.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Results

Field	Type	Description
value	boolean

Check In Zone

True while this instance stands in the named painted zone. Expressions can also ask zoneAt() — the current cell’s zone name. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryInZone.

Editor category: Queries > Objects and Spatial Queries.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Parameter	Type	Optional	Details
Zone	text	No	A zone name painted with the Scene Editor’s Zones tool.

Results

Field	Type	Description
value	boolean

Check Input Context Active

Runs nested actions while the selected Input Context belongs to the active-context set. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryInputContextActive.

Editor category: Queries > Logic and State.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Input Context	enum	No	Value for Input Context.

Results

Field	Type	Description
value	boolean

Check Instance Count

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryInstanceCount.

Editor category: Queries > Objects and Spatial Queries.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Object	thing:object	No	Object resource name. Live-instance target parameters may also select an attached Child Object placement.
Operator	enum	Yes	Choose one of the listed options. Choices: ==, !=, <, <=, >, >=. Default: “>=”.
Value	number	No	Count to compare against. Accepts a number, variable, global, or expression. Default: 1.

Results

Field	Type	Description
value	boolean

Check It Happened

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryHappened.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Event	text	No	The remembered event name a Remember This action recorded. Default: “door-opened”.
Detail	text	No	Optional: only count entries whose detail matches exactly. Blank matches any. Default: “”.
At Least	number	No	True when it was remembered at least this many times. Default: 1.

Results

Field	Type	Description
value	boolean

Check Jointed

Checks whether this object has a live joint — optionally one to a particular object, or with a particular name. Ask it to know whether the crate is still on the hook or the trailer is still hitched. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryJointed.

Editor category: Queries > Movement and Physics.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Parameter	Type	Optional	Details
To Object	thing:object	Yes	Only count joints connected to this object. Blank counts any joint.
Joint Name	text	Yes	Only count joints with this label.

Results

Field	Type	Description
value	boolean

Check Language Action

True when the last single recognized meaning carries this exact typed action. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLanguageAction.

Editor category: Queries > Language Packs.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Exact action	text	No	Text value; some actions also accept $global names. Default: “open”.

Results

Field	Type	Description
value	boolean

Check Language Capability

True when the last adapter preview or receipt used this exact bounded capability. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLanguageCapability.

Editor category: Queries > Language Packs.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Capability	enum	No	Choose one of the listed options. Choices: object.set-boolean, object.set-number, object.set-text, mind.query, mind.assert, ui.response. Default: “object.set-boolean”.

Results

Field	Type	Description
value	boolean

Check Language Effect

Tests the typed Effect Receipt status from the last interpretation. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLanguageEffect.

Editor category: Queries > Language Packs.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Receipt status	text	No	Examples: applied, preview-only, already-value, not-allowlisted, target-not-live. Default: “applied”.

Results

Field	Type	Description
value	boolean

Check Language Grant

True when this exact Language Grant authorized the most recent meaning. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLanguageGrant.

Editor category: Queries > Language Packs.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Grant ID	text	No	Text value; some actions also accept $global names. Default: “starter-player”.

Results

Field	Type	Description
value	boolean

Check Language Status

Tests the status of the most recent Interpret Language Pack result. No automatic event is dispatched. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLanguageStatus.

Editor category: Queries > Language Packs.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Status	enum	No	Choose one of the listed options. Choices: accepted, recognized-unauthorized, ambiguous, no-parse, no-referent, empty, too-many-tokens, input-too-long, limit-exceeded, pack-missing, runtime-missing, intent-error, error. Default: “accepted”.

Results

Field	Type	Description
value	boolean

Check Language Target

True when the last single recognized meaning carries this exact typed target. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLanguageTarget.

Editor category: Queries > Language Packs.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Exact target	text	No	Text value; some actions also accept $global names. Default: “gate”.

Results

Field	Type	Description
value	boolean

Check Living Paper Is Enabled

Checks whether this game publishes Living Paper. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLivingPaperEnabled.

Editor category: Queries > Living Paper.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Logic Enabled

True while the selected Logic’s per-instance enabled state is on. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryBehaviorEnabled.

Editor category: Queries > Logic and State.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Parameter	Type	Optional	Details
Logic Component	thing:behavior	No	Choose a behavior resource.

Results

Field	Type	Description
value	boolean

Check Menu Open

True while any menu (or the named one) is the open, focused menu. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryMenuOpen.

Editor category: Queries > Animation and Media.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Menu Element	thing:object	Yes	Choose a screen object resource.

Results

Field	Type	Description
value	boolean

Check Mic Loud

Returns a Boolean for microphone loudness. Leave Threshold blank to read the steady loud state used by Loud Sound, or supply a Number to compare the current $mic_level. Enable the microphone first. With the microphone off, the result is false and no error is raised. Use the result in a later If, While, or value expression.

Reference key: queryMicLoud.

Editor category: Queries > Input, Audio, and Voice.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Louder than (0-100)	number	Yes	Blank = the game’s tuned loud state (Set Mic Loud Threshold, with its steady hold — no flicker). A number = a one-off instant check of $mic_level against it.

Results

Field	Type	Description
value	boolean

Check Mind Call Status

Checks the exact lifecycle status of the currently published Mind capability call. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryNlCallStatus.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Status	enum	No	Choose one of the listed options. Choices: ready, completed, failed, rejected. Default: “completed”.

Results

Field	Type	Description
value	boolean

Check Mind Capability

True when the currently published Mind call belongs to the named capability. Filtered capability events usually avoid this condition; it remains useful in generic result and error handlers. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryNlCapability.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Capability (blank = any)	enum	Yes	Blank checks whether any capability call is current; a name checks that exact registered capability.

Results

Field	Type	Description
value	boolean

Check Mind Knows

True when exactly this fact was taught (or loaded from data). The quiet twin of Ask Mind — no answer text, just a yes/no the event sheet can branch on. Supports {expressions} in all three parts. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryNlKnows.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Subject	text	No	Text value; some actions also accept $global names. Default: “”.
Predicate	text	No	Text value; some actions also accept $global names. Default: “”.
Object	text	No	Text value; some actions also accept $global names. Default: “”.

Results

Field	Type	Description
value	boolean

Check Mind Proves

True only when a direct fact, inherited fact, or bounded controlled rule proves the triple in the chosen viewpoint. Unknown remains different from false. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryNlProves.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Subject	text	No	Text value; some actions also accept $global names. Default: “”.
Predicate	text	No	Text value; some actions also accept $global names. Default: “”.
Object	text	No	Text value; some actions also accept $global names. Default: “”.
Context	text	Yes	Text value; some actions also accept $global names.
Prove explicit falsehood	boolean	Yes	On or off. Default: false.

Results

Field	Type	Description
value	boolean

Check Mine

Checks whether this instance belongs to the local player (a “One per player” object spawned for them, or any instance on a game without ownership). The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryNetOwned.

Editor category: Queries > Multiplayer.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Results

Field	Type	Description
value	boolean

Check Object Type

Checks whether the selected instance is one exact Object or Variant, or belongs to the selected base Object family. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryObjectType.

Editor category: Queries > Objects and Spatial Queries.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Parameter	Type	Optional	Details
Object Type	thing:object	No	Object resource name. Live-instance target parameters may also select an attached Child Object placement.
Match	enum	No	Exact matches one Object or Variant; Family matches every Variant of the selected base Object. Choices: exact, family. Default: “exact”.

Results

Field	Type	Description
value	boolean

Check Paper Game Is Active

Checks whether a paper game is active. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLivingPaperGameActive.

Editor category: Queries > Living Paper.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Paper Game Saving Is Allowed

Checks whether the creator allows paper game saving. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLivingPaperSaveAllowed.

Editor category: Queries > Living Paper.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Paper Glyph Count

Runs the nested actions when the number of live drawings carrying any selected Glyph matches the comparison. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryLivingPaperGlyphCount.

Editor category: Queries > Living Paper.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Glyphs	text	No	Comma-separated Glyph names or ids.
Operator	enum	Yes	Choose one of the listed options. Choices: ==, !=, <, <=, >, >=. Default: “==”.
Count	number	No	Expression or literal value. Default: 0.

Results

Field	Type	Description
value	boolean

Check Path Exists

Checks whether this instance could walk to a point around the walls, solid tiles and fixed solid Objects. Works in 2D and 3D Scenes. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryPathExists.

Editor category: Queries > Movement and Physics.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Parameter	Type	Optional	Details
X	number	No	Target X in meters. Default: 0.
Y	number	No	Target Y in meters. Default: 0.

Results

Field	Type	Description
value	boolean

Check Path Progress

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryPathProgress.

Editor category: Queries > Movement and Physics.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Operator	enum	Yes	Choose one of the listed options. Choices: ==, !=, <, <=, >, >=. Default: “>=”.
Percent (0–100)	number	No	Number value; decimals are allowed. Default: 50.

Results

Field	Type	Description
value	boolean

Check Plan Step

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryHtnStep.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Step	text	No	True when this instance’s current plan step is exactly this — handy for one shared handler serving several steps. Default: “walk-wall”.

Results

Field	Type	Description
value	boolean

Check Prefers

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryPrefers.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Actor	text	No	Whose preferences to consult (blank = the shared table). Default: “guard”.
Category	text	No	Which category the two options belong to. Default: “response”.
Prefers	text	No	True when the actor prefers this option… Default: “flee”.
Over	text	No	…to this one, under the context that currently applies — derived through the taught chain, false when nothing decides it. Default: “fight”.

Results

Field	Type	Description
value	boolean

Check Pursuing Goal

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryPursuing.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Goal	text	No	True when this declared goal is the TOP recognized goal right now. Default: “get-the-amulet”.
Max Detour	number	No	How many wasted steps the player may have taken and still count as pursuing it. 0 = perfectly on track. Default: 0.

Results

Field	Type	Description
value	boolean

Check Reflex Result

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryReflexResult.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Status	enum	No	True when the last Tick NPC Reflexes on this instance ended with this status. Choices: success, failure, running. Default: “success”.

Results

Field	Type	Description
value	boolean

Check Rig Animation

Asks what the instance’s rig is doing — gate combos on the current swing, or wait for idle before acting. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryRigAnim.

Editor category: Queries > Animation and Media.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Animation	text	Yes	True while this rig animation plays. Blank = true while ANY rig animation plays.

Results

Field	Type	Description
value	boolean

Check Save Exists

True when the named save slot exists — show a “Continue” button only when there is something to continue. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: querySaveExists.

Editor category: Queries > Time and Saves.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Slot	text	No	Text value; some actions also accept $global names. Default: “default”.

Results

Field	Type	Description
value	boolean	True when a record is found for the exact resolved slot. This checks presence, not valid or compatible snapshot content. False when no record is found or storage access fails; Load Game still needs a failure path.

Check Speech Is Playing

True while the voice is busy: speaking, paused mid-line, or with lines waiting. The globals $speech_speaking, $speech_pending, $speech_paused and $speech_supported carry the details. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: querySpeaking.

Editor category: Queries > Animation and Media.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Story Relation

The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryStoryRelation.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Interval	text	No	First interval. Default: “festival”.
Relation	enum	No	True only when the composed calendar makes this the DEFINITE relation — a maybe never gates. Choices: before, after, during, contains, meets, overlaps, equals. Default: “before”.
Interval	text	No	Second interval. Default: “winter”.

Results

Field	Type	Description
value	boolean

Check Time Between

True while the clock reads inside the window; From later than To wraps through midnight (20 → 6 is “overnight”). The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryTimeBetween.

Editor category: Queries > Time and Saves.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
From hour	number	No	Expression or literal value. Default: 20.
To hour	number	No	Expression or literal value. Default: 6.

Results

Field	Type	Description
value	boolean

Check Timeline Playing

True while matching playback is running. Scope = self checks only players bound to this instance. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryTimelinePlaying.

Editor category: Queries > Animation and Media.

Example: Run the check, then compare its produced .value field in a later If.

Choose the target instance with the Action’s Applies To field.

Parameter	Type	Optional	Details
Timeline	thing:timeline	No	Choose a timeline resource.
Scope	enum	Yes	Choose one of the listed options. Choices: all, self. Default: “all”.

Results

Field	Type	Description
value	boolean

Check Understood

True when the last Understand Text matched a taught intent — blank checks “anything”, a name checks that one. Read the captures from $nl_slot_name. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryNlIntent.

Editor category: Queries > Mind.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Intent name	text	Yes	Blank = “anything was understood” (any intent matched the last Understand Text). A name = exactly that intent.

Results

Field	Type	Description
value	boolean

Check Video Is Playing

True while a fullscreen video is on screen (a paused video still counts). The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryVideoPlaying.

Editor category: Queries > Animation and Media.

Example: Run the check, then compare its produced .value field in a later If.

Results

Field	Type	Description
value	boolean

Check Voice Heard

True when the named Voice Word (or any word, with Word blank) was confidently heard within the last few seconds. The natural partner of Voice Command Heard for branching one event per word — $voice_last and $voice_score carry the details. The produced Boolean can be referenced directly by a later If, While, or value expression.

Reference key: queryVoiceHeard.

Editor category: Queries > Input, Audio, and Voice.

Example: Run the check, then compare its produced .value field in a later If.

Parameter	Type	Optional	Details
Word	text	Yes	The taught word to check. Blank = any taught word.
Within Seconds	number	Yes	How recently it must have been heard (default 2). Default: 2.

Results

Field	Type	Description
value	boolean