Copyright © 2025-2026 Candy ArtsLine Portrait
The Line_Portrait command controls the portrait of the Spoken Line being written: it shows another portrait, pauses or resumes its animation, stops it on a frame, or jumps to a frame. It only works inside a Text Event.
It acts on the portrait of the UI element displaying the Line: the dialogue box, or the Line's Chat_Line in Chat mode. A speaker who receives no portrait there (because of the Portrait_Mode or the Chat's Portrait_Display) receives none from Line_Portrait either. In Chat mode, the Line retains its new portrait when it scrolls out of view and back.
Keys
Every key also accepts a ¢ expression instead of a fixed value, unless its description says otherwise. See CandyRef Expressions.
Action
Description:
The action performed on the portrait. The value is case-insensitive.
Values:
• Show: Show another portrait, set by the keys below.
• Pause: Pause its animation.
• Resume: Resume it.
• Stop: Stop it on a frame, set by Frame.
• Frame: Jump to a frame, set by Frame; the animation continues playing, or remains paused, as it was.
Portrait
Description:
Show only. The portrait to show, in the form the Spoken Line's Portrait key accepts. See Spoken Line.
Values:
• File name, animation name, or res:// / user:// path: As on the Spoken Line.
• null: The Line's own portrait.
Sprite_Frames_File
Description:
Show only. For an AnimatedSprite portrait node, the SpriteFrames file holding the Portrait animation.
Values:
• File name, or res:// / user:// path: As on the Spoken Line.
• null: The Line's own.
Portrait_Play
Description:
Show only. How many times the new portrait plays. It also decides when the portrait stops: -1 stops it when the Dialogue moves on, -3 when the voice ends.
Values:
• Positive number, 0, -1, -2, -3 or -3/n: As on the Spoken Line.
• null: The Line's own.
Portrait_Stop
Description:
Show only. The frame the new portrait stops on.
Values:
• Positive number, -1 or 0: As on the Spoken Line.
• null: The Line's own.
Frame
Description:
Stop and Frame only. The frame to stop on, or to jump to, counted from 1. A video uses that frame's timestamp. A still image has no frames: it doesn't change.
Values:
• Positive number: That frame.
• -1: The last frame.
• 0: Stop only. No frame: the portrait is removed.
• null: Stop only. The Line's own Portrait_Stop frame.