Copyright © 2025-2026 Candy ArtsVN Stop
The VN_Stop command stops the playback of one or more Actors' busts on a specific frame. The Actors remain on screen; use VN_Remove to remove them.
Keys
Every key also accepts a ¢ expression instead of a fixed value, unless its description says otherwise. See CandyRef Expressions.
Actors
Description:
The Actors the command acts on, each on a bust of the VN Scene. Each key is an Actor, and its value is a Dictionary of settings for that Actor (see below), or an empty Dictionary for none. List every Actor by name: there is no shorthand for all Actors. The Engine reports an entry it can't find and skips it, without affecting the others.
Values:
• Actor Reference: A key of the actors dictionary, such as Alice.
• °role: The Actor currently assigned to that Role, such as °guard.
Actor Settings
Each Actor in Actors accepts the following keys.
Stop_Frame
Description:
The frame the bust stops on. It remains on screen; use VN_Remove to remove the Actor.
Values:
• 0: Stop on the current frame.
• -1: Stop on the last frame.
• Positive number: Stop on that frame, counted from 1 and clamped to the available frames.
• Empty: 0.
Loops
Description:
Stops the playback once it has played this many loops, counted from its start, rather than at once. It replaces the Loops and Duration of the Line that started the playback, and the playback then stops on this Line's Stop_Frame. The Dialogue doesn't wait for it. A point that has already passed stops the playback at once, where it is; so does media that isn't playing (held by a Loops of 0, finished or already stopped). The stop follows the Actor through VN_Move and VN_Swap.
Values:
• Empty or null: No loops: stop at once, unless Duration is set.
• 0 or a positive number: The number of loops, counted from the start of the playback.
Duration
Description:
How long the playback continues after those loops before it stops, counted on playback, as the Duration of a Play command is: paused time doesn't count. With an empty Loops, it counts from the start of the playback.
Values:
• Number of seconds: Such as 2.5.
• Timestamp: In the format SS.xx, MM:SS.xx or HH:MM:SS.xx, such as 01:30.5.
• f=N: N frames, counted at FPS, else at the frame rate the media plays at. SpriteFrames count their own frames.
• 0, null or empty: No duration: Loops alone decides.
FPS
Description:
The frame rate at which an f= Duration is counted.
Values:
• Frames per second: Such as 12.
• Empty: The frame rate the bust plays at.
Take_Hold
Description:
Whether this command takes hold of the bust scene, if it is Public. While an Engine holds it, its Public Mode determines which commands other Engines may send it: none (Exclusive), only the commands it lists (Semi-Exclusive), or any (Free). The hold applies to the whole scene, and lasts until the holding Engine's Dialogue ends. Setting Take_Hold on any Actor of the Line applies it to the whole scene.
Values:
• Empty: The bust scene decides, from its own list of commands that take hold.
• 1: Take hold, even if the bust scene doesn't list this command.
• -1: Never take hold.