Copyright © 2025-2026 Candy ArtsVN Swap
The VN_Swap command exchanges the busts of pairs of Actors. Both Actors play their Move_From effects, swap busts, then play their Move_To effects, and each continues to display and play what it was. List each pair only once, since listing it from both sides swaps it back. Like every VN command, it requires the Engine's vn_mode to be enabled. See Busts.
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.
With
Description:
The Actor to exchange busts with, which is required. Both Actors must be on busts of the same node type.
Values:
• Actor Reference: Such as Bob.
• °role: The Actor currently assigned to that Role.
JML_Order
Description:
Groups the Line's Actors, which are processed in ascending order of group: the Actors of a group appear, move or leave together, and the next group starts once all of them have finished. See JML Effects.
Values:
• Number: The Actor's group.
• Empty: 0.
Move_From_Effect
Description:
Overrides both Actors' Move From effect for this Line. When not set, the effect comes from the Actor's VNMoveFromEffect in the actors dictionary, otherwise from the VN Scene, otherwise from the Engine.
Values:
• Animation name: An animation of the bust's JML player, such as Fade_In.
• Empty: No effect on this Line.
• null: Not set; the Actor, the VN Scene or the Engine decides.
Move_To_Effect
Description:
Overrides both Actors' Move To effect for this Line. When not set, the effect comes from the Actor's VNMoveToEffect in the actors dictionary, otherwise from the VN Scene, otherwise from the Engine.
Values:
• Animation name: An animation of the bust's JML player, such as Fade_In.
• Empty: No effect on this Line.
• null: Not set; the Actor, the VN Scene or the Engine decides.
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.