Candy Logo

Portrait Preview
The Portrait Preview displays the portrait of a Spoken Line: the file named in its Portrait field, from the folder of its Speaker. A Line has one portrait for all its Variations.
Portrait Preview
Requirements
  • The project root and the Portraits folder set in Settings > Project > Paths.
  • A Speaker that is an Actor. The portrait of a Role, or of a speaker set by an expression, is only known in the game.
  • A Portrait written with its file extension, as the dropdown writes it.
When there is nothing to display, the preview says "No file to preview". When the file can't be read, it says so with the file's path. A portrait written without its extension isn't previewed: the game adds the extension itself, and the preview doesn't guess it. The same applies to an empty Portrait, for which the game displays the Actor's default portrait. Animated Portraits A portrait can be an image, a video, a sprite sheet, a folder of frames or an animation of a SpriteFrames file. Animated portraits play in the preview as they will in the game, following the Line's fields:
  • Play Portrait: how many times the animation plays.
  • Portrait Stop: the frame it stops on.
The portrait plays from the start when the Line is displayed and when one of these fields changes. Sprite sheets and folders of frames play at the Portrait FPS of Settings > UI > Editor. With the Voice With Sync portrait on in a Voice Preview of the same Dialogue Editor, playing the voice plays the portrait with it, as the two play together in the game. See Voice Preview. Buttons The preview displays five buttons, where its Buttons option places them, in the order of its Button order option:
ButtonWhat it does
PlayPlays or pauses the portrait. Once it has ended, plays it again.
StopStops, back to the first frame.
ColorPicks the background color.
Portrait fieldsOpens a pop-up with the Line's portrait fields: Portrait, Sprite Frames File, Play Portrait, Portrait Stop, and the portrait overrides, such as Portrait Mode.
The arrowOpens the Portrait field's dropdown, to pick the portrait file. As in the field, hovering a file plays it beside the mouse pointer, and picking an animation also fills Sprite Frames File.
The fields of the pop-up work as in any form, with their help, messages and dropdowns. It opens beside its button, centered vertically on the screen. With Buttons set to Hidden, the arrow and the fields button are displayed over the portrait's top-right corner while the mouse is over the widget. Background What is displayed behind the portrait matters for portraits with transparent parts: use the color or the picture of your dialogue box.
  • The widget has a background color and a background texture of its own. A texture is displayed in preference to a color.
  • An Actor or a Role can have a background of their own, set in Settings > UI > Portrait Backgrounds. It's displayed instead of the widget's, in every Portrait Preview. See Portrait Backgrounds.
Options Right-click the widget and choose Options.
OptionDescription
Background colorDisplayed behind the portrait when there is no background texture.
Background textureAn image on your disk, displayed behind the portrait instead of the color.
Play animated portraits while the mouse is over themOn, an animated portrait displays its first frame until the mouse is over it. Off, it plays as in the game.
ButtonsThe position of the buttons: Hidden, in a row above or below the portrait, or in a column on its left or right.
Button orderThe order of the buttons. Drag them in the list to reorder them.
File nameDisplays the name of the portrait's file above or below the portrait, or hides it. Its tooltip displays the whole path. When no file is found, the Portrait field's value is displayed instead.
Minimum Size, Maximum SizeThe minimum and maximum size of the widget's area.