endsStop

function endsStop
guideTools.ts:201
endsStop(output: GuideToolOutput) → boolean

Whether an answer ends the current stop, which is what the beat keys on: a linger the guide declared is dropped, and an arrival still waiting to be narrated is superseded.

Read from the answer rather than the tool's name, because the effect is the executor's to state. A move that travels answers moving and later arrives (go_to, frame_pair, stand_at, leave_surface); hold_view answers held, declaring the view as it stands the stop. A refinement of the stop — adjust_view, look_around, set_time — answers ok and leaves a linger running: the visitor is still looking at the same thing. A refused or canceled move changed nothing, so it ends nothing.

outputGuideToolOutput
Undocumented
Returnsboolean