diff --git a/assets/default-metadata.json b/assets/default-metadata.json
index 3bb37831..81e7d546 100644
--- a/assets/default-metadata.json
+++ b/assets/default-metadata.json
@@ -1 +1 @@
-{"actors":[],"commands":[{"id":"AnimateActor","alias":"animate","localizable":false,"summary":"Animate properties of the actors with the specified IDs via key frames. Key frames for the animated parameters are delimited with commas.","remarks":"It's not recommended to use this command for complex animations. Naniscript is a scenario scripting DSL and not suited for complex automation or specification such as animation. Consider using dedicated animation tools instead, such as Unity's [Animator](https://docs.unity3d.com/Manual/AnimationSection.html).
Be aware, that this command searches for actors with the provided IDs over all the actor managers, and in case multiple actors with the same ID exist (eg, a character and a text printer), this will affect only the first found one.
When running the animate commands in parallel (`wait` is set to false) the affected actors state can mutate unpredictably. This could cause unexpected results when rolling back or performing other commands that affect state of the actor. Make sure to reset affected properties of the animated actors (position, tint, appearance, etc) after the command finishes or use `@animate CharacterId` (without any args) to stop the animation prematurely.","examples":"; Animate `Kohaku` actor over three animation steps (key frames),\n; changing positions: first step will take 1, second — 0.5 and third — 3 seconds.\n@animate Kohaku posX:50,0,85 time:1,0.5,3\n\n; Start loop animations of `Yuko` and `Kohaku` actors; notice, that you can skip\n; key values indicating that the parameter shouldn't change during the animation step.\n@animate Kohaku,Yuko loop:true appearance:Surprise,Sad,Default,Angry transition:DropFade,Ripple,Pixelate posX:15,85,50 posY:0,-25,-85 scale:1,1.25,1.85 tint:#25f1f8,lightblue,#ffffff,olive easing:EaseInBounce,EaseInQuad time:3,2,1,0.5 wait:false\n...\n; Stop the animations.\n@animate Yuko,Kohaku loop:false\n\n; Start a long background animation for `Kohaku`.\n@animate Kohaku posX:90,0,90 scale:1,2,1 time:10 wait:false\n; Do something else while the animation is running.\n...\n; Here we're going to set a specific position for the character,\n; but the animation could still be running in background, so reset it first.\n@animate Kohaku\n; Now it's safe to modify previously animated properties.\n@char Kohaku pos:50 scale:1","parameters":[{"id":"ActorIds","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"IDs of the actors to animate.","label":"actorIds","typeLabel":"string list"},{"id":"Loop","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to loop the animation; make sure to set `wait` to false when loop is enabled, otherwise script playback will loop indefinitely.","label":"loop","typeLabel":"boolean"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Appearances to set for the animated actors.","label":"appearance","typeLabel":"string"},{"id":"Transition","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use when animating appearance change (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"Visibility","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Visibility status to set for the animated actors.","label":"visibility","typeLabel":"string"},{"id":"ScenePositionX","alias":"posX","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Position values over X-axis (in 0 to 100 range, in percents from the left border of the scene) to set for the animated actors.","label":"posX","typeLabel":"string"},{"id":"ScenePositionY","alias":"posY","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Position values over Y-axis (in 0 to 100 range, in percents from the bottom border of the scene) to set for the animated actors.","label":"posY","typeLabel":"string"},{"id":"PositionZ","alias":"posZ","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Position values over Z-axis (in world space) to set for the animated actors; while in ortho mode, can only be used for sorting.","label":"posZ","typeLabel":"string"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Rotation values (over Z-axis) to set for the animated actors.","label":"rotation","typeLabel":"string"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Scale (`x,y,z` or a single uniform value) to set for the animated actors.","label":"scale","typeLabel":"string"},{"id":"TintColor","alias":"tint","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Tint colors to set for the animated actors.
Strings that begin with `#` will be parsed as hexadecimal in the following way: `#RGB` (becomes RRGGBB), `#RRGGBB`, `#RGBA` (becomes RRGGBBAA), `#RRGGBBAA`; when alpha is not specified will default to FF.
Strings that do not begin with `#` will be parsed as literal colors, with the following supported: red, cyan, blue, darkblue, lightblue, purple, yellow, lime, fuchsia, white, silver, grey, black, orange, brown, maroon, green, olive, navy, teal, aqua, magenta.","label":"tint","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Names of the easing functions to use for the animations.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Duration of the animations per key, in seconds. When a key value is missing, will use one from a previous key. When not assigned, will use 0.35 seconds duration for all keys.","label":"time","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"animate"},{"id":"AppendText","alias":"append","localizable":true,"summary":"Appends provided text to a text printer.","remarks":"The entire text will be appended immediately, without triggering reveal effect or any other side-effects.","examples":"; Print first part of the sentence as usual (with gradual reveal),\n; then append the end of the sentence at once.\nLorem ipsum\n@append \" dolor sit amet.\"","parameters":[{"id":"Text","alias":"","nameless":true,"required":true,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"The text to append.","label":"text","typeLabel":"string"},{"id":"PrinterId","alias":"printer","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a a default one when not provided.","label":"printer","typeLabel":"string"},{"id":"AuthorId","alias":"author","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"Characters"},{"type":3,"subType":"Characters"}],"summary":"ID of the actor, which should be associated with the appended text.","label":"author","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"append"},{"id":"ArrangeCharacters","alias":"arrange","localizable":false,"summary":"Arranges specified characters by X-axis. When no parameters provided, will execute an auto-arrange evenly distributing visible characters by X-axis.","examples":"; Evenly distribute all the visible characters.\n@arrange\n\n; Place character with ID `Jenna` 15%, `Felix` 50% and `Mia` 85% away\n; from the left border of the scene.\n@arrange Jenna.15,Felix.50,Mia.85","parameters":[{"id":"CharacterPositions","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":3,"valueType":2,"valueContext":[{"type":3,"subType":"Characters"}],"summary":"A collection of character ID to scene X-axis position (relative to the left scene border, in percents) named values. Position 0 relates to the left border and 100 to the right border of the scene; 50 is the center.","label":"characterPositions","typeLabel":"named decimal list"},{"id":"LookAtOrigin","alias":"look","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"When performing auto-arrange, controls whether to also make the characters look at the scene origin (enabled by default).","label":"look","typeLabel":"boolean"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the arrangement animation.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"arrange"},{"id":"ModifyBackground","alias":"back","localizable":false,"summary":"Modifies a [background actor](https://naninovel.com/guide/backgrounds).","remarks":"Backgrounds are handled a bit differently from characters to better accommodate traditional VN game flow. Most of the time you'll probably have a single background actor on scene, which will constantly transition to different appearances. To remove the hassle of repeating same actor ID in scripts, it's possible to provide only the background appearance and transition type (optional) as a nameless parameter assuming `MainBackground` actor should be affected. When this is not the case, ID of the background actor can be explicitly provided via the `id` parameter.","examples":"; Set `River` as the appearance of the main background.\n@back River\n\n; Same as above, but also use a `RadialBlur` transition effect.\n@back River.RadialBlur\n\n; Position `Smoke` background at the center of the screen\n; and scale it 50% of the original size.\n@back id:Smoke pos:50,50 scale:0.5\n\n; Tint all visible backgrounds on scene.\n@back id:* tint:#ffdc22","parameters":[{"id":"AppearanceAndTransition","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":4,"subType":"MainBackground"},{"type":1,"subType":"TransitionType"}],"summary":"Appearance (or [pose](https://naninovel.com/guide/backgrounds#poses)) to set for the modified background and type of a [transition effect](https://naninovel.com/guide/transition-effects) to use. When transition is not provided, a cross-fade effect will be used by default.","label":"appearanceAndTransition","typeLabel":"named string"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the modified actor. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Id","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"ID of the actor to modify; specify `*` to affect all visible actors.","label":"id","typeLabel":"string"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":4},{"type":4}],"summary":"Appearance to set for the modified actor.","label":"appearance","typeLabel":"string"},{"id":"Pose","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Pose to set for the modified actor.","label":"pose","typeLabel":"string"},{"id":"Transition","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"TransitionType"},{"type":1,"subType":"TransitionType"}],"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"TransitionParams","alias":"params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"summary":"Parameters of the transition effect.","label":"params","typeLabel":"decimal list"},{"id":"DissolveTexturePath","alias":"dissolve","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path to the [custom dissolve](https://naninovel.com/guide/transition-effects#custom-transition-effects) texture (path should be relative to a `Resources` folder). Has effect only when the transition is set to `Custom` mode.","label":"dissolve","typeLabel":"string"},{"id":"Visible","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Visibility status to set for the modified actor.","label":"visible","typeLabel":"boolean"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the modified actor. Use Z-component (third member) to move (sort) by depth while in ortho mode.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the modified actor.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the modified actor.","label":"scale","typeLabel":"decimal list"},{"id":"TintColor","alias":"tint","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":5,"subType":""},{"type":5,"subType":""}],"summary":"Tint color to set for the modified actor.
Strings that begin with `#` will be parsed as hexadecimal in the following way: `#RGB` (becomes RRGGBB), `#RRGGBB`, `#RGBA` (becomes RRGGBBAA), `#RRGGBBAA`; when alpha is not specified will default to FF.
Strings that do not begin with `#` will be parsed as literal colors, with the following supported: red, cyan, blue, darkblue, lightblue, purple, yellow, lime, fuchsia, white, silver, grey, black, orange, brown, maroon, green, olive, navy, teal, aqua, magenta.","label":"tint","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"back"},{"id":"PlayBgm","alias":"bgm","localizable":false,"summary":"Plays or modifies currently played [BGM (background music)](https://naninovel.com/guide/audio#background-music) track with the provided name.","remarks":"Music tracks are looped by default. When music track name (BgmPath) is not specified, will affect all the currently played tracks. When invoked for a track that is already playing, the playback won't be affected (track won't start playing from the start), but the specified parameters (volume and whether the track is looped) will be applied.","examples":"; Starts playing a music track with the name `Sanctuary` in a loop.\n@bgm Sanctuary\n\n; Same as above, but fades-in the volume over 10 seconds and plays once.\n@bgm Sanctuary fade:10 loop:false\n\n; Changes volume of all the played music tracks to 50% over 2.5 seconds\n; and makes them play in a loop.\n@bgm volume:0.5 loop:true time:2.5\n\n; Plays `BattleThemeIntro` once, then loops `BattleThemeMain`.\n@bgm BattleThemeMain intro:BattleThemeIntro","parameters":[{"id":"BgmPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the music track to play.","label":"bgmPath","typeLabel":"string"},{"id":"IntroBgmPath","alias":"intro","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the intro music track to play once before the main track (not affected by the loop parameter).","label":"intro","typeLabel":"string"},{"id":"Volume","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Volume of the music track.","label":"volume","typeLabel":"decimal"},{"id":"Loop","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to play the track from beginning when it finishes.","label":"loop","typeLabel":"boolean"},{"id":"FadeInDuration","alias":"fade","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0","summary":"Duration of the volume fade-in when starting playback, in seconds (0.0 by default); doesn't have effect when modifying a playing track.","label":"fade","typeLabel":"decimal"},{"id":"GroupPath","alias":"group","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Audio mixer [group path](https://docs.unity3d.com/ScriptReference/Audio.AudioMixer.FindMatchingGroups) that should be used when playing the audio.","label":"group","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"bgm"},{"id":"SpawnBlur","alias":"blur","localizable":false,"summary":"Applies [blur effect](https://naninovel.com/guide/special-effects.html#blur) to supported actor: backgrounds and characters of sprite, layered, diced, Live2D, Spine, video and scene implementations.","remarks":"The actor should have `IBlurable` interface implemented in order to support the effect.","examples":"; Blur main background with default parameters.\n@blur\n; Remove blur from the main background.\n@blur power:0\n\n; Blur `Kohaku` actor with max power over 5 seconds.\n@blur Kohaku power:1 time:5\n; Remove blur from `Kohaku` over 3.1 seconds.\n@blur Kohaku power:0 time:3.1","parameters":[{"id":"ActorId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":3,"subType":"*"}],"defaultValue":"MainBackground","summary":"ID of the actor to apply the effect for; in case multiple actors with the same ID found (eg, a character and a printer), will affect only the first found one. When not specified, applies to the main background.","label":"actorId","typeLabel":"string"},{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Intensity of the effect, in 0.0 to 1.0 range. Defaults to 0.5. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"FadeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"How long it will take the parameters to reach the target values, in seconds. Defaults to 1.0.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"blur"},{"id":"SpawnBokeh","alias":"bokeh","localizable":false,"summary":"Simulates [depth of field](https://naninovel.com/guide/special-effects.html#depth-of-field-bokeh) (aka DOF, bokeh) effect, when only the object in focus stays sharp, while others are blurred.","examples":"; Enable the effect with defaults and lock focus on `Kohaku` game object.\n@bokeh focus:Kohaku\n; Fade-off (disable) the effect over 10 seconds.\n@bokeh power:0 time:10\n; Set focus point 10 units away from the camera,\n; focal distance to 0.95 and apply it over 3 seconds.\n@bokeh dist:10 power:0.95 time:3","parameters":[{"id":"FocusObjectName","alias":"focus","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name of the game object to set focus for (optional). When set, the focus will always stay on the game object, while `dist` parameter will be ignored.","label":"focus","typeLabel":"string"},{"id":"FocusDistance","alias":"dist","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Distance (in units) from Naninovel camera to the focus point. Ignored when `focus` parameter is specified. Defaults to 10.","label":"dist","typeLabel":"decimal"},{"id":"FocalLength","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Amount of blur to apply for the de-focused areas; also determines focus sensitivity. Defaults to 3.75. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"How long it will take the parameters to reach the target values, in seconds. Defaults to 1.0.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"bokeh"},{"id":"AppendLineBreak","alias":"br","localizable":false,"summary":"Adds a line break to a text printer.","remarks":"Consider using `
` tag instead with [TMPro printers](https://naninovel.com/guide/text-printers#textmesh-pro).","examples":"; Second sentence will be printed on a new line.\nLorem ipsum dolor sit amet.[br]Consectetur adipiscing elit.\n\n; Second sentence will be printer two lines under the first one.\nLorem ipsum dolor sit amet.[br 2]Consectetur adipiscing elit.","parameters":[{"id":"Count","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":1,"defaultValue":"1","summary":"Number of line breaks to add.","label":"count","typeLabel":"integer"},{"id":"PrinterId","alias":"printer","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printer","typeLabel":"string"},{"id":"AuthorId","alias":"author","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"Characters"},{"type":3,"subType":"Characters"}],"summary":"ID of the actor, which should be associated with the appended line break.","label":"author","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"br"},{"id":"ModifyCamera","alias":"camera","localizable":false,"summary":"Modifies the main camera, changing offset, zoom level and rotation over time. Check [this video](https://youtu.be/zy28jaMss8w) for a quick demonstration of the command effect.","examples":"; Offset the camera by -3 units over X-axis and by 1.5 units Y-axis.\n@camera offset:-3,1.5\n\n; Set camera in perspective mode, zoom-in by 50% and move back by 5 units.\n@camera ortho:false offset:,,-5 zoom:0.5\n\n; Set camera in orthographic mode and roll by 10 degrees clock-wise.\n@camera ortho:true roll:10\n\n; Offset, zoom and roll simultaneously animated over 5 seconds.\n@camera offset:-3,1.5 zoom:0.5 roll:10 time:5\n\n; Instantly reset camera to the default state.\n@camera offset:0,0 zoom:0 rotation:0,0,0 time:0\n\n; Toggle `FancyCameraFilter` and `Bloom` components attached to the camera.\n@camera toggle:FancyCameraFilter,Bloom\n\n; Set `FancyCameraFilter` component enabled and `Bloom` disabled.\n@camera set:FancyCameraFilter.true,Bloom.false\n\n; Disable all components attached to the camera object.\n@camera set:*.false","parameters":[{"id":"Offset","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Local camera position offset in units by X,Y,Z axes.","label":"offset","typeLabel":"decimal list"},{"id":"Roll","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Local camera rotation by Z-axis in angle degrees (0.0 to 360.0 or -180.0 to 180.0). The same as third component of `rotation` parameter; ignored when `rotation` is specified.","label":"roll","typeLabel":"decimal"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Local camera rotation over X,Y,Z-axes in angle degrees (0.0 to 360.0 or -180.0 to 180.0).","label":"rotation","typeLabel":"decimal list"},{"id":"Zoom","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Relative camera zoom (orthographic size or field of view, depending on the render mode), in 0.0 (no zoom) to 1.0 (full zoom) range.","label":"zoom","typeLabel":"decimal"},{"id":"Orthographic","alias":"ortho","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the camera should render in orthographic (true) or perspective (false) mode.","label":"ortho","typeLabel":"boolean"},{"id":"ToggleTypeNames","alias":"toggle","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Names of the components to toggle (enable if disabled and vice-versa). The components should be attached to the same game object as the camera. This can be used to toggle [custom post-processing effects](https://naninovel.com/guide/special-effects#camera-effects). Use `*` to affect all the components attached to the camera object.","label":"toggle","typeLabel":"string list"},{"id":"SetTypeNames","alias":"set","nameless":false,"required":false,"localizable":false,"valueContainerType":3,"valueType":3,"summary":"Names of the components to enable or disable. The components should be attached to the same game object as the camera. This can be used to explicitly enable or disable [custom post-processing effects](https://naninovel.com/guide/special-effects#camera-effects). Specified components enabled state will override effect of `toggle` parameter. Use `*` to affect all the components attached to the camera object.","label":"set","typeLabel":"named boolean list"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the camera configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"camera"},{"id":"ModifyCharacter","alias":"char","localizable":false,"summary":"Modifies a [character actor](https://naninovel.com/guide/characters).","examples":"; Shows character with ID `Sora` with a default appearance.\n@char Sora\n\n; Same as above, but sets appearance to `Happy`.\n@char Sora.Happy\n\n; Same as above, but additionally positions the character 45% away \n; from the left border of the scene and 10% away from the bottom border; \n; also makes it look to the left.\n@char Sora.Happy look:left pos:45,10\n\n; Make Sora appear at the bottom-center and in front of Felix.\n@char Sora pos:50,0,-1\n@char Felix pos:,,0\n\n; Tint all visible characters on scene.\n@char * tint:#ffdc22","parameters":[{"id":"IdAndAppearance","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":3,"subType":"Characters"},{"type":4}],"summary":"ID of the character to modify (specify `*` to affect all visible characters) and an appearance (or [pose](https://naninovel.com/guide/characters#poses)) to set. When appearance is not provided, will use either a `Default` (is exists) or a random one.","label":"idAndAppearance","typeLabel":"named string"},{"id":"LookDirection","alias":"look","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"CharacterLookDirection"},{"type":1,"subType":"CharacterLookDirection"}],"summary":"Look direction of the actor; supported values: left, right, center.","label":"look","typeLabel":"string"},{"id":"AvatarTexturePath","alias":"avatar","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name (path) of the [avatar texture](https://naninovel.com/guide/characters#avatar-textures) to assign for the character. Use `none` to remove (un-assign) avatar texture from the character.","label":"avatar","typeLabel":"string"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the modified actor. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Id","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"ID of the actor to modify; specify `*` to affect all visible actors.","label":"id","typeLabel":"string"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":4},{"type":4}],"summary":"Appearance to set for the modified actor.","label":"appearance","typeLabel":"string"},{"id":"Pose","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Pose to set for the modified actor.","label":"pose","typeLabel":"string"},{"id":"Transition","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"TransitionType"},{"type":1,"subType":"TransitionType"}],"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"TransitionParams","alias":"params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"summary":"Parameters of the transition effect.","label":"params","typeLabel":"decimal list"},{"id":"DissolveTexturePath","alias":"dissolve","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path to the [custom dissolve](https://naninovel.com/guide/transition-effects#custom-transition-effects) texture (path should be relative to a `Resources` folder). Has effect only when the transition is set to `Custom` mode.","label":"dissolve","typeLabel":"string"},{"id":"Visible","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Visibility status to set for the modified actor.","label":"visible","typeLabel":"boolean"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the modified actor. Use Z-component (third member) to move (sort) by depth while in ortho mode.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the modified actor.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the modified actor.","label":"scale","typeLabel":"decimal list"},{"id":"TintColor","alias":"tint","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":5,"subType":""},{"type":5,"subType":""}],"summary":"Tint color to set for the modified actor.
Strings that begin with `#` will be parsed as hexadecimal in the following way: `#RGB` (becomes RRGGBB), `#RRGGBB`, `#RGBA` (becomes RRGGBBAA), `#RRGGBBAA`; when alpha is not specified will default to FF.
Strings that do not begin with `#` will be parsed as literal colors, with the following supported: red, cyan, blue, darkblue, lightblue, purple, yellow, lime, fuchsia, white, silver, grey, black, orange, brown, maroon, green, olive, navy, teal, aqua, magenta.","label":"tint","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"char"},{"id":"AddChoice","alias":"choice","localizable":true,"summary":"Adds a [choice](https://naninovel.com/guide/choices) option to a choice handler with the specified ID (or default one).","remarks":"When `goto`, `gosub` and `do` parameters are not specified, will continue script execution from the next script line.","examples":"; Print the text, then immediately show choices and stop script execution.\nContinue executing this script or ...?[skipInput]\n@choice \"Continue\"\n@choice \"Load another script from start\" goto:Another\n@choice \"Load another script from \\\"Label\\\" label\" goto:Another.Label\n@choice \"Goto to \\\"Sub\\\" subroutine in another script\" gosub:Another.Sub\n@stop\n\n; You can also set custom variables based on choices.\n@choice \"I'm humble, one is enough...\" set:score++\n@choice \"Two, please.\" set:score=score+2\n@choice \"I'll take the entire stock!\" set:karma--;score=999\n\n; Play a sound effect and arrange characters when choice is picked.\n@choice Arrange do:\"@sfx Click, @arrange k.10\\,y.55\"\n\n; Print a text line corresponding to the picked choice.\n@choice \"Ask about color\" do:\"What's your favorite color?\"\n@choice \"Ask about age\" do:\"How old are you?\"\n@choice \"Keep silent\" do:\"...\"\n@stop","parameters":[{"id":"ChoiceSummary","alias":"","nameless":true,"required":false,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"Text to show for the choice. When the text contain spaces, wrap it in double quotes (`\"`). In case you wish to include the double quotes in the text itself, escape them.","label":"choiceSummary","typeLabel":"string"},{"id":"ButtonPath","alias":"button","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path (relative to a `Resources` folder) to a [button prefab](https://naninovel.com/guide/choices#choice-button) representing the choice. The prefab should have a `ChoiceHandlerButton` component attached to the root object. Will use a default button when not provided.","label":"button","typeLabel":"string"},{"id":"ButtonPosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y"},{"type":6,"subType":"X,Y"}],"summary":"Local position of the choice button inside the choice handler (if supported by the handler implementation).","label":"pos","typeLabel":"decimal list"},{"id":"HandlerId","alias":"handler","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"ChoiceHandlers"},{"type":3,"subType":"ChoiceHandlers"}],"summary":"ID of the choice handler to add choice for. Will use a default handler if not provided.","label":"handler","typeLabel":"string"},{"id":"GotoPath","alias":"goto","nameless":false,"required":false,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":2,"subType":"Scripts"},{"type":1,"subType":"Labels/{:GotoPath[0]??$Script}"}],"summary":"Path to go when the choice is selected by user; see [@goto](https://naninovel.com/api/#goto) command for the path format.","label":"goto","typeLabel":"named string"},{"id":"GosubPath","alias":"gosub","nameless":false,"required":false,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":2,"subType":"Scripts"},{"type":1,"subType":"Labels/{:GosubPath[0]??$Script}"}],"summary":"Path to a subroutine to go when the choice is selected by user; see [@gosub](https://naninovel.com/api/#gosub) command for the path format. When `goto` is assigned this parameter will be ignored.","label":"gosub","typeLabel":"named string"},{"id":"SetExpression","alias":"set","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"Set expression to execute when the choice is selected by user; see [@set](https://naninovel.com/api/#set) command for syntax reference.","label":"set","typeLabel":"string"},{"id":"OnSelected","alias":"do","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Script commands to execute when the choice is selected by user. Escape commas inside list values to prevent them being treated as delimiters. The commands will be invoked in order after `set`, `goto` and `gosub` are handled (if assigned).","label":"do","typeLabel":"string list"},{"id":"AutoPlay","alias":"play","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to automatically continue playing script from the next line, when neither `goto` nor `gosub` parameters are specified. Has no effect in case the script is already playing when the choice is processed.","label":"play","typeLabel":"boolean"},{"id":"ShowHandler","alias":"show","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to also show choice handler the choice is added for; enabled by default.","label":"show","typeLabel":"boolean"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade-in (reveal) animation.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"choice"},{"id":"ClearBacklog","localizable":false,"summary":"Removes all the messages from [printer backlog](https://naninovel.com/guide/text-printers#printer-backlog).","examples":"; Printed text will be removed from the backlog.\nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n@clearBacklog","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"clearBacklog"},{"id":"ClearChoiceHandler","alias":"clearChoice","localizable":false,"summary":"Removes all the choice options in the choice handler with the provided ID (or in default one, when ID is not specified; or in all the existing handlers, when `*` is specified as ID) and (optionally) hides it (them).","examples":"; Give the player 2 seconds to pick a choice.\n# Start\nYou have 2 seconds to respond![skipInput]\n@choice Cats goto:.PickedChoice\n@choice Dogs goto:.PickedChoice\n@wait 2\n@clearChoice\nToo late!\n@stop\n# PickedChoice\nGood!","parameters":[{"id":"HandlerId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"ChoiceHandlers"},{"type":3,"subType":"ChoiceHandlers"}],"summary":"ID of the choice handler to clear. Will use a default handler if not provided. Specify `*` to clear all the existing handlers.","label":"handlerId","typeLabel":"string"},{"id":"Hide","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to also hide the affected choice handlers.","label":"hide","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"clearChoice"},{"id":"DestroySpawned","alias":"despawn","localizable":false,"summary":"Destroys an object spawned with [@spawn](https://naninovel.com/api/#spawn) command.","remarks":"If prefab has a `MonoBehaviour` component attached the root object, and the component implements a `IParameterized` interface, will pass the specified `params` values before destroying the object; if the component implements `IAwaitable` interface, command execution will wait for the async completion task returned by the implementation before destroying the object.","examples":"; Given `@spawn Rainbow` command was executed before, de-spawn (destroy) it.\n@despawn Rainbow","parameters":[{"id":"Path","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name (path) of the prefab resource to destroy. A [@spawn](https://naninovel.com/api/#spawn) command with the same parameter is expected to be executed before.","label":"path","typeLabel":"string"},{"id":"Params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Parameters to set before destroying the prefab. Requires the prefab to have a `IParameterized` component attached the root object.","label":"params","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"despawn"},{"id":"DestroyAllSpawned","alias":"despawnAll","localizable":false,"summary":"Destroys all the objects spawned with [@spawn](https://naninovel.com/api/#spawn) command. Equal to invoking [@despawn](https://naninovel.com/api/#despawn) for all the currently spawned objects.","examples":"@spawn Rainbow\n@spawn SunShafts\n; Will de-spawn (destroy) both rainbow and SunShafts.\n@despawnAll","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"despawnAll"},{"id":"Else","localizable":false,"summary":"Marks a branch of a conditional execution block, which is always executed in case conditions of the opening [@if](https://naninovel.com/api/#if) and all the preceding [@elseif](https://naninovel.com/api/#elseif) (if any) commands are not met. For usage examples see [conditional execution](https://naninovel.com/guide/naninovel-scripts#conditional-execution) guide.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"else"},{"id":"ElseIf","localizable":false,"summary":"Marks a branch of a conditional execution block, which is executed in case own condition is met (expression is evaluated to be true), while conditions of the opening [@if](https://naninovel.com/api/#if) and all the preceding [@elseif](https://naninovel.com/api/#elseif) (if any) commands are not met. For usage examples see [conditional execution](https://naninovel.com/guide/naninovel-scripts#conditional-execution) guide.","parameters":[{"id":"Expression","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A [script expression](https://naninovel.com/guide/script-expressions), which should return a boolean value.","label":"expression","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"elseIf"},{"id":"EndIf","localizable":false,"summary":"Closes an [@if](https://naninovel.com/api/#if) conditional execution block. For usage examples see [conditional execution](https://naninovel.com/guide/naninovel-scripts#conditional-execution) guide.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"endIf"},{"id":"FinishSceneTransition","alias":"finishTrans","localizable":false,"summary":"Finishes scene transition started with [@startTrans](https://naninovel.com/api/#starttrans) command; see the start command reference for more information and usage examples.","parameters":[{"id":"Transition","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"TransitionType"},{"type":1,"subType":"TransitionType"}],"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"TransitionParams","alias":"params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"summary":"Parameters of the transition effect.","label":"params","typeLabel":"decimal list"},{"id":"DissolveTexturePath","alias":"dissolve","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path to the [custom dissolve](https://naninovel.com/guide/transition-effects#custom-transition-effects) texture (path should be relative to a `Resources` folder). Has effect only when the transition is set to `Custom` mode.","label":"dissolve","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the transition.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"finishTrans"},{"id":"SpawnGlitch","alias":"glitch","localizable":false,"summary":"Applies [digital glitch](https://naninovel.com/guide/special-effects.html#digital-glitch) post-processing effect to the main camera simulating digital video distortion and artifacts.","examples":"; Apply the glitch effect with default parameters.\n@glitch\n; Apply the effect over 3.33 seconds with a low intensity.\n@glitch time:3.33 power:0.1","parameters":[{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The duration of the effect, in seconds; default is 1.","label":"time","typeLabel":"decimal"},{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The intensity of the effect, in 0.0 to 10.0 range; default is 1.","label":"power","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"glitch"},{"id":"Gosub","localizable":false,"summary":"Navigates naninovel script playback to the provided path and saves that path to global state; [@return](https://naninovel.com/api/#return) commands use this info to redirect to command after the last invoked gosub command.","remarks":"While this command can be used as a function (subroutine) to invoke a common set of script lines, remember that NaniScript is a scenario scripting DSL and is not suited for general programming. It's strongly recommended to use [custom commands](https://naninovel.com/guide/custom-commands) instead.","examples":"; Navigate to `VictoryScene` label in the currently played script, then\n; execute the commands and navigate back to the command after the `gosub`.\n@gosub .VictoryScene\n...\n@stop\n# VictoryScene\n@back Victory\n@sfx Fireworks\n@bgm Fanfares\nYou are victorious!\n@return\n\n; Another example with some branching inside the subroutine.\n@set time=10\n; Here we get one result.\n@gosub .Room\n...\n@set time=3\n; And here we get another.\n@gosub .Room\n@stop\n# Room\n@print \"It's too early, I should visit after sunset.\" if:time<21&time>6\n@print \"I can sense an ominous presence!\" if:time>21|time<6\n@return","parameters":[{"id":"Path","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":2,"subType":"Scripts"},{"type":1,"subType":"Labels/{:Path[0]??$Script}"}],"summary":"Path to navigate into in the following format: `ScriptName.LabelName`. When label name is omitted, will play provided script from the start. When script name is omitted, will attempt to find a label in the currently played script.","label":"path","typeLabel":"named string"},{"id":"ResetState","alias":"reset","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"When specified, will reset the engine services state before loading a script (in case the path is leading to another script). Specify `*` to reset all the services, or specify service names to exclude from reset. By default, the state does not reset.","label":"reset","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"gosub"},{"id":"Goto","localizable":false,"summary":"Navigates naninovel script playback to the provided path.","examples":"; Loads and starts playing `Script001` script from the start.\n@goto Script001\n\n; Save as above, but start playing from the label `AfterStorm`.\n@goto Script001.AfterStorm\n\n; Navigates to `Epilogue` label in the currently played script.\n@goto .Epilogue\n...\n# Epilogue\n...","parameters":[{"id":"Path","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":2,"subType":"Scripts"},{"type":1,"subType":"Labels/{:Path[0]??$Script}"}],"summary":"Path to navigate into in the following format: `ScriptName.LabelName`. When label name is omitted, will play provided script from the start. When script name is omitted, will attempt to find a label in the currently played script.","label":"path","typeLabel":"named string"},{"id":"ResetState","alias":"reset","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"When specified, will control whether to reset the engine services state before loading a script (in case the path is leading to another script):
- Specify `*` to reset all the services, except the ones with `Goto.DontReset` attribute.
- Specify service type names (separated by comma) to exclude from reset; all the other services will be reset, including the ones with `Goto.DontReset` attribute.
- Specify `-` to force no reset (even if it's enabled by default in the configuration).
Notice, that while some services have `Goto.DontReset` attribute applied and are not reset by default, they should still be specified when excluding specific services from reset.","label":"reset","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"goto"},{"id":"HideActors","alias":"hide","localizable":false,"summary":"Hides (removes) actors (character, background, text printer, choice handler) with the specified IDs. In case multiple actors with the same ID found (eg, a character and a printer), will affect only the first found one.","examples":"; Given an actor with ID `Smoke` is visible, hide it over 3 seconds.\n@hide Smoke time:3\n\n; Hide `Kohaku` and `Yuko` actors.\n@hide Kohaku,Yuko\n\n; Hide and remove `Kohaku` actor.\n@hide Kohaku remove:true","parameters":[{"id":"ActorIds","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":1,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":3,"subType":"*"}],"summary":"IDs of the actors to hide.","label":"actorIds","typeLabel":"string list"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade animation.","label":"time","typeLabel":"decimal"},{"id":"Remove","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to remove (destroy) the actor after it's hidden. Use to unload resources associated with the actor and prevent memory leaks.","label":"remove","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hide"},{"id":"HideAllActors","alias":"hideAll","localizable":false,"summary":"Hides (removes) all the actors (characters, backgrounds, text printers, choice handlers) on scene.","examples":"; Hide all the visible actors (chars, backs, printers, etc) on scene.\n@hideAll\n\n; Same as above, but also remove all the actors after they're hidden.\n@hideAll remove:true","parameters":[{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade animation.","label":"time","typeLabel":"decimal"},{"id":"Remove","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to remove (destroy) the actors after they are hidden. Use to unload resources associated with the actors and prevent memory leaks.","label":"remove","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hideAll"},{"id":"HideAllCharacters","alias":"hideChars","localizable":false,"summary":"Hides (removes) all the visible characters on scene.","examples":"; Hide all the visible character actors on scene.\n@hideChars","parameters":[{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade animation.","label":"time","typeLabel":"decimal"},{"id":"Remove","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to remove (destroy) the characters after they are hidden. Use to unload resources associated with the characters and prevent memory leaks.","label":"remove","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hideChars"},{"id":"HidePrinter","localizable":false,"summary":"Hides a text printer.","examples":"; Hide a default printer.\n@hidePrinter\n\n; Hide printer with ID `Wide`.\n@hidePrinter Wide","parameters":[{"id":"PrinterId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printerId","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the hide animation. Default value for each printer is set in the actor configuration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hidePrinter"},{"id":"HideUI","localizable":false,"summary":"Makes [UI elements](https://naninovel.com/guide/user-interface#ui-customization) with the specified names invisible. When no names are specified, will stop rendering (hide) the entire UI (including all the built-in UIs).","remarks":"When hiding the entire UI with this command and `allowToggle` parameter is false (default), user won't be able to re-show the UI back with hotkeys or by clicking anywhere on the screen; use [@showUI](https://naninovel.com/api/#showui) command to make the UI visible again.","examples":"; Given a custom `Calendar` UI, the following command will hide it.\n@hideUI Calendar\n\n; Hide the entire UI, won't allow user to re-show it.\n@hideUI\n...\n; Make the UI visible again.\n@showUI\n\n; Hide the entire UI, but allow the user to toggle it back.\n@hideUI allowToggle:true\n\n; Simultaneously hide built-in `TipsUI` and custom `Calendar` UIs.\n@hideUI TipsUI,Calendar","parameters":[{"id":"UINames","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"valueContext":[{"type":2,"subType":"UI"},{"type":2,"subType":"UI"}],"summary":"Name of the UI elements to hide.","label":"uINames","typeLabel":"string list"},{"id":"AllowToggle","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"When hiding the entire UI, controls whether to allow the user to re-show the UI with hotkeys or by clicking anywhere on the screen (false by default). Has no effect when hiding a particular UI.","label":"allowToggle","typeLabel":"boolean"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the hide animation. When not specified, will use UI-specific duration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hideUI"},{"id":"WaitForInput","alias":"i","localizable":false,"summary":"Holds script execution until user activates a `continue` input. Shortcut for `@wait i`.","examples":"; User will have to activate a `continue` input after the first sentence\n; for the printer to continue printing out the following text.\nLorem ipsum dolor sit amet.[i] Consectetur adipiscing elit.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"i"},{"id":"BeginIf","alias":"if","localizable":false,"summary":"Marks the beginning of a conditional execution block. Should always be closed with an [@endif](https://naninovel.com/api/#endif) command. For usage examples see [conditional execution](https://naninovel.com/guide/naninovel-scripts#conditional-execution) guide.","parameters":[{"id":"Expression","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A [script expression](https://naninovel.com/guide/script-expressions), which should return a boolean value.","label":"expression","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"if"},{"id":"InputCustomVariable","alias":"input","localizable":true,"summary":"Shows an input field UI where user can enter an arbitrary text. Upon submit the entered text will be assigned to the specified custom variable.","remarks":"Check out this [video guide](https://youtu.be/F9meuMzvGJw) on usage example.
To assign a display name for a character using this command consider [binding the name to a custom variable](https://naninovel.com/guide/characters.html#display-names).","examples":"; Prompt to enter an arbitrary text and assign it to `name` custom variable.\n@input name summary:\"Choose your name.\"\n; Halt the playback until player submits the input.\n@stop\n\n; You can then inject the assigned `name` variable in naninovel scripts.\nArchibald: Greetings, {name}!\n\n; ...or use it inside set and conditional expressions.\n@set score=score+1 if:name==\"Felix\"","parameters":[{"id":"VariableName","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name of a custom variable to which the entered text will be assigned.","label":"variableName","typeLabel":"string"},{"id":"Summary","nameless":false,"required":false,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"An optional summary text to show along with input field. When the text contain spaces, wrap it in double quotes (`\"`). In case you wish to include the double quotes in the text itself, escape them.","label":"summary","typeLabel":"string"},{"id":"PredefinedValue","alias":"value","nameless":false,"required":false,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"A predefined value to set for the input field.","label":"value","typeLabel":"string"},{"id":"PlayOnSubmit","alias":"play","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to automatically resume script playback when user submits the input form.","label":"play","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"input"},{"id":"LipSync","localizable":false,"summary":"Allows to force-stop the lip sync mouth animation for a character with the provided ID; when stopped, the animation won't start again, until this command is used again to allow it. The character should be able to receive the lip sync events (currently generic, layered and Live2D implementations only). See [characters guide](https://naninovel.com/guide/characters#lip-sync) for more information on lip sync feature.","examples":"; Given auto voicing is disabled and lip sync is driven by text messages,\n; exclude punctuation from the mouth animation.\nKohaku: Lorem ipsum dolor sit amet[lipSync Kohaku.false]... [lipSync Kohaku.true]Consectetur adipiscing elit.","parameters":[{"id":"CharIdAndAllow","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":3,"valueContext":[{"type":3,"subType":"Characters"}],"summary":"Character ID followed by a boolean (true or false) on whether to halt or allow the lip sync animation.","label":"charIdAndAllow","typeLabel":"named boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"lipSync"},{"id":"LoadScene","localizable":false,"summary":"Loads a [Unity scene](https://docs.unity3d.com/Manual/CreatingScenes.html) with the provided name. Don't forget to add the required scenes to the [build settings](https://docs.unity3d.com/Manual/BuildSettings.html) to make them available for loading.","examples":"; Load scene `TestScene1` in single mode.\n@loadScene TestScene1\n\n; Load scene `TestScene2` in additive mode.\n@loadScene TestScene2 additive:true","parameters":[{"id":"SceneName","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name of the scene to load.","label":"sceneName","typeLabel":"string"},{"id":"Additive","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to load the scene additively, or unload any currently loaded scenes before loading the new one (default). See the [load scene documentation](https://docs.unity3d.com/ScriptReference/SceneManagement.SceneManager.LoadScene.html) for more information.","label":"additive","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"loadScene"},{"id":"Lock","localizable":false,"summary":"Sets an [unlockable item](https://naninovel.com/guide/unlockable-items) with the provided ID to `locked` state.","remarks":"The unlocked state of the items is stored in [global scope](https://naninovel.com/guide/state-management#global-state).
In case item with the provided ID is not registered in the global state map, the corresponding record will automatically be added.","examples":"; Lock an unlockable CG record with ID `FightScene1`.\n@lock CG/FightScene1","parameters":[{"id":"Id","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Unlockables"},{"type":2,"subType":"Unlockables"}],"summary":"ID of the unlockable item. Use `*` to lock all the registered unlockable items.","label":"id","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"lock"},{"id":"CameraLook","alias":"look","localizable":false,"summary":"Activates/disables camera look mode, when player can offset the main camera with input devices (eg, by moving a mouse or using gamepad analog stick). Check [this video](https://youtu.be/rC6C9mA7Szw) for a quick demonstration of the command.","remarks":"It's also possible to control the look by rotating a mobile device (in case it has a gyroscope). This requires using Unity's new input system and manually [enabling gyroscope](https://docs.unity3d.com/Packages/com.unity.inputsystem@1.0/manual/Sensors.html) device. Check out [input example project](https://github.com/Naninovel/Input) for a reference on how to setup camera look with gyroscope.","examples":"; Activate camera look mode with default parameters.\n@look\n\n; Activate camera look mode with custom parameters.\n@look zone:6.5,4 speed:3,2.5 gravity:true\n\n; Disable look mode and instantly reset the offset.\n@look false\n\n; Disable look, but reset gradually, with 0.25 speed.\n@look false gravity:true speed:0.25","parameters":[{"id":"Enable","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to enable or disable the camera look mode. Default: true.","label":"enable","typeLabel":"boolean"},{"id":"LookZone","alias":"zone","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y"},{"type":6,"subType":"X,Y"}],"summary":"A bound box with X,Y sizes in units from the initial camera position, describing how far the camera can be moved. Default: 5,3.","label":"zone","typeLabel":"decimal list"},{"id":"LookSpeed","alias":"speed","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y"},{"type":6,"subType":"X,Y"}],"summary":"Camera movement speed (sensitivity) by X,Y axes. Default: 1.5,1.","label":"speed","typeLabel":"decimal list"},{"id":"Gravity","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to automatically move camera to the initial position when the look input is not active (eg, mouse is not moving or analog stick is in default position). Default: false.","label":"gravity","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"look"},{"id":"PlayMovie","alias":"movie","localizable":false,"summary":"Plays a movie with the provided name (path).","remarks":"Will fade-out the screen before playing the movie and fade back in after the play. Playback can be canceled by activating a `cancel` input (`Esc` key by default).","examples":"; Given an `Opening` video clip is added to the movie resources, plays it.\n@movie Opening","parameters":[{"id":"MovieName","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Movies"},{"type":2,"subType":"Movies"}],"summary":"Name of the movie resource to play.","label":"movieName","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the fade animation. When not specified, will use fade duration set in the movie configuration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"movie"},{"id":"OpenURL","localizable":false,"summary":"Opens specified URL (web address) with default web browser.","remarks":"When outside of WebGL or in editor, Unity's `Application.OpenURL` method is used to handle the command; consult the [documentation](https://docs.unity3d.com/ScriptReference/Application.OpenURL.html) for behaviour details and limitations. Under WebGL native `window.open()` JS function is invoked: https://developer.mozilla.org/en-US/docs/Web/API/Window/open.","examples":"; Open blank page in the current tab.\n@openURL \"about:blank\"\n\n; Open Naninovel website in new tab.\n@openURL \"https://naninovel.com\" target:_blank","parameters":[{"id":"URL","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"URL to open.","label":"uRL","typeLabel":"string"},{"id":"Target","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"defaultValue":"_self","summary":"Browsing context: _self (current tab), _blank (new tab), _parent, _top.","label":"target","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"openURL"},{"id":"PrintText","alias":"print","localizable":true,"summary":"Prints (reveals over time) specified text message using a text printer actor.","remarks":"This command is used under the hood when processing generic text lines, eg generic line `Kohaku: Hello World!` will be automatically transformed into `@print \"Hello World!\" author:Kohaku` when parsing the naninovel scripts.
Will reset (clear) the printer before printing the new message by default; set `reset` parameter to *false* or disable `Auto Reset` in the printer actor configuration to prevent that and append the text instead.
Will make the printer default and hide other printers by default; set `default` parameter to *false* or disable `Auto Default` in the printer actor configuration to prevent that.
Will wait for user input before finishing the task by default; set `waitInput` parameter to *false* or disable `Auto Wait` in the printer actor configuration to return as soon as the text is fully revealed.
","examples":"; Will print the phrase with a default printer.\n@print \"Lorem ipsum dolor sit amet.\"\n\n; To include quotes in the text itself, escape them.\n@print \"Shouting \\\"Stop the car!\\\" was a mistake.\"\n\n; Reveal message with half of the normal speed and\n; don't wait for user input to continue.\n@print \"Lorem ipsum dolor sit amet.\" speed:0.5 waitInput:false","parameters":[{"id":"Text","alias":"","nameless":true,"required":true,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"Text of the message to print. When the text contain spaces, wrap it in double quotes (`\"`). In case you wish to include the double quotes in the text itself, escape them.","label":"text","typeLabel":"string"},{"id":"PrinterId","alias":"printer","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printer","typeLabel":"string"},{"id":"AuthorId","alias":"author","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"Characters"},{"type":3,"subType":"Characters"}],"summary":"ID of the actor, which should be associated with the printed message.","label":"author","typeLabel":"string"},{"id":"RevealSpeed","alias":"speed","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Text reveal speed multiplier; should be positive or zero. Setting to one will yield the default speed.","label":"speed","typeLabel":"decimal"},{"id":"ResetPrinter","alias":"reset","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to reset text of the printer before executing the printing task. Default value is controlled via `Auto Reset` property in the printer actor configuration menu.","label":"reset","typeLabel":"boolean"},{"id":"DefaultPrinter","alias":"default","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to make the printer default and hide other printers before executing the printing task. Default value is controlled via `Auto Default` property in the printer actor configuration menu.","label":"default","typeLabel":"boolean"},{"id":"WaitForInput","alias":"waitInput","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to wait for user input after finishing the printing task. Default value is controlled via `Auto Wait` property in the printer actor configuration menu.","label":"waitInput","typeLabel":"boolean"},{"id":"LineBreaks","alias":"br","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":1,"summary":"Number of line breaks to prepend before the printed text. Default value is controlled via `Auto Line Break` property in the printer actor configuration menu.","label":"br","typeLabel":"integer"},{"id":"ChangeVisibilityDuration","alias":"fadeTime","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Controls duration (in seconds) of the printers show and hide animations associated with this command. Default value for each printer is set in the actor configuration.","label":"fadeTime","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"print"},{"id":"ModifyTextPrinter","alias":"printer","localizable":false,"summary":"Modifies a [text printer actor](https://naninovel.com/guide/text-printers).","examples":"; Will make `Wide` printer default and hide any other visible printers.\n@printer Wide\n\n; Will assign `Right` appearance to `Bubble` printer, make is default,\n; position at the center of the scene and won't hide other printers.\n@printer Bubble.Right pos:50,50 hideOther:false","parameters":[{"id":"IdAndAppearance","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":4}],"summary":"ID of the printer to modify and the appearance to set. When ID or appearance are not provided, will use default ones.","label":"idAndAppearance","typeLabel":"named string"},{"id":"MakeDefault","alias":"default","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to make the printer the default one. Default printer will be subject of all the printer-related commands when `printer` parameter is not specified.","label":"default","typeLabel":"boolean"},{"id":"HideOther","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to hide all the other printers.","label":"hideOther","typeLabel":"boolean"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the modified actor. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Id","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"ID of the actor to modify; specify `*` to affect all visible actors.","label":"id","typeLabel":"string"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":4},{"type":4}],"summary":"Appearance to set for the modified actor.","label":"appearance","typeLabel":"string"},{"id":"Pose","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Pose to set for the modified actor.","label":"pose","typeLabel":"string"},{"id":"Transition","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"TransitionType"},{"type":1,"subType":"TransitionType"}],"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"TransitionParams","alias":"params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"summary":"Parameters of the transition effect.","label":"params","typeLabel":"decimal list"},{"id":"DissolveTexturePath","alias":"dissolve","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path to the [custom dissolve](https://naninovel.com/guide/transition-effects#custom-transition-effects) texture (path should be relative to a `Resources` folder). Has effect only when the transition is set to `Custom` mode.","label":"dissolve","typeLabel":"string"},{"id":"Visible","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Visibility status to set for the modified actor.","label":"visible","typeLabel":"boolean"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the modified actor. Use Z-component (third member) to move (sort) by depth while in ortho mode.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the modified actor.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the modified actor.","label":"scale","typeLabel":"decimal list"},{"id":"TintColor","alias":"tint","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":5,"subType":""},{"type":5,"subType":""}],"summary":"Tint color to set for the modified actor.
Strings that begin with `#` will be parsed as hexadecimal in the following way: `#RGB` (becomes RRGGBB), `#RRGGBB`, `#RGBA` (becomes RRGGBBAA), `#RRGGBBAA`; when alpha is not specified will default to FF.
Strings that do not begin with `#` will be parsed as literal colors, with the following supported: red, cyan, blue, darkblue, lightblue, purple, yellow, lime, fuchsia, white, silver, grey, black, orange, brown, maroon, green, olive, navy, teal, aqua, magenta.","label":"tint","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"printer"},{"id":"ProcessInput","localizable":false,"summary":"Allows halting and resuming user input processing (eg, reacting to pressing keyboard keys). The effect of the action is persistent and saved with the game.","examples":"; Halt input processing of all the samplers.\n@processInput false\n\n; Resume input processing of all the samplers.\n@processInput true\n\n; Mute `Rollback` and `Pause` inputs and un-mute `Continue` input.\n@processInput set:Rollback.false,Pause.false,Continue.true","parameters":[{"id":"InputEnabled","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to enable input processing of all the samplers.","label":"inputEnabled","typeLabel":"boolean"},{"id":"SetEnabled","alias":"set","nameless":false,"required":false,"localizable":false,"valueContainerType":3,"valueType":3,"summary":"Allows muting and un-muting individual input samplers.","label":"set","typeLabel":"named boolean list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"processInput"},{"id":"PurgeRollback","localizable":false,"summary":"Prevents player from rolling back to the previous state snapshots.","examples":"; Prevent player from rolling back to try picking another choice.\n\nPick a choice. You won't be able to rollback.\n@choice One goto:.One\n@choice Two goto:.Two\n@stop\n\n# One\n@purgeRollback\nYou've picked one.\n@stop\n\n# Two\n@purgeRollback\nYou've picked two.\n@stop","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"purgeRollback"},{"id":"SpawnRain","alias":"rain","localizable":false,"summary":"Spawns particle system simulating [rain](https://naninovel.com/guide/special-effects.html#rain).","examples":"; Start intensive rain over 10 seconds.\n@rain power:1500 time:10\n; Stop the rain over 30 seconds.\n@rain power:0 time:30","parameters":[{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The intensity of the rain (particles spawn rate per second); defaults to 500. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"FadeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The particle system will gradually grow the spawn rate to the target level over the specified time, in seconds.","label":"time","typeLabel":"decimal"},{"id":"XVelocity","alias":"xSpeed","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Multiplier to the horizontal speed of the particles. Use to change angle of the rain drops.","label":"xSpeed","typeLabel":"decimal"},{"id":"YVelocity","alias":"ySpeed","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Multiplier to the vertical speed of the particles.","label":"ySpeed","typeLabel":"decimal"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the spawned effect game object. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the spawned effect game object.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the spawned effect game object.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the spawned effect game object.","label":"scale","typeLabel":"decimal list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"rain"},{"id":"ResetState","localizable":false,"summary":"Resets state of the [engine services](https://naninovel.com/guide/engine-services) and unloads (disposes) all the resources loaded by Naninovel (textures, audio, video, etc); will basically revert to an empty initial engine state.","remarks":"The process is asynchronous and is masked with a loading screen ([ILoadingUI](https://naninovel.com/guide/user-interface#ui-customization)).
Be aware, that this command can not be undone (rewound back).","examples":"; Reset all the services (script will stop playing).\n@resetState\n\n; Reset all the services except script player, custom variable and\n; audio managers, allowing current script and audio tracks\n; continue playing and preserving values of the custom variables.\n@resetState IScriptPlayer,ICustomVariableManager,IAudioManager\n\n; Reset only `ICharacterManager` and `IBackgroundManager` services\n; removing all the character and background actors from scene\n; and unloading associated resources from memory.\n@resetState only:ICharacterManager,IBackgroundManager","parameters":[{"id":"Exclude","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Names of the [engine services](https://naninovel.com/guide/engine-services) (interfaces) to exclude from reset. Consider adding `ICustomVariableManager` to preserve the local variables.","label":"exclude","typeLabel":"string list"},{"id":"Only","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Names of the [engine services](https://naninovel.com/guide/engine-services) (interfaces) to reset; other services won't be affected. Doesn't have effect when the nameless (exclude) parameter is assigned.","label":"only","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"resetState"},{"id":"ResetText","localizable":false,"summary":"Resets (clears) the contents of a text printer and optionally resets author ID.","examples":"; Print and then clear contents of the default printer.\nThis line will disappear.\n@resetText\n\n; Same as above, but with `Wide` printer.\n@print \"This line will disappear.\" printer:Wide\n@resetText Wide","parameters":[{"id":"PrinterId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printerId","typeLabel":"string"},{"id":"ResetAuthor","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to also reset author of the currently printed text message.","label":"resetAuthor","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"resetText"},{"id":"Return","localizable":false,"summary":"Attempts to navigate naninovel script playback to a command after the last used [@gosub](https://naninovel.com/api/#gosub). See [@gosub](https://naninovel.com/api/#gosub) command summary for more info and usage examples.","parameters":[{"id":"ResetState","alias":"reset","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"When specified, will reset the engine services state before returning to the initial script from which the gosub was entered (in case it's not the currently played script). Specify `*` to reset all the services, or specify service names to exclude from reset. By default, the state does not reset.","label":"reset","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"return"},{"id":"AutoSave","alias":"save","localizable":false,"summary":"Automatically save the game to a quick save slot.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"save"},{"id":"SetCustomVariable","alias":"set","localizable":false,"summary":"Assigns result of a [script expression](https://naninovel.com/guide/script-expressions) to a [custom variable](https://naninovel.com/guide/custom-variables).","remarks":"If a variable with the provided name doesn't exist, it will be automatically created.
It's possible to define multiple set expressions in one line by separating them with `;`. The expressions will be executed in sequence by the order of declaration.
In case variable name starts with `T_` or `t_` it's considered a reference to a value stored in 'Script' [managed text](https://naninovel.com/guide/managed-text) document. Such variables can't be assigned and mostly used for referencing localizable text values.","examples":"; Assign `foo` variable a `bar` string value.\n@set foo=\"bar\"\n\n; Assign `foo` variable a 1 number value.\n@set foo=1\n\n; Assign `foo` variable a `true` boolean value.\n@set foo=true\n\n; If `foo` is a number, add 0.5 to its value.\n@set foo+=0.5\n\n; If `angle` is a number, assign its cosine to `foo` variable.\n@set foo=Cos(angle)\n\n; Get random number between -100 and 100, then raise to power of 4 \n; and assign to `foo` variable. Quotes are required when whitespace \n; is present inside the expression.\n@set \"foo = Pow(Random(-100, 100), 4)\"\n\n; If `foo` is a number, add 1 to its value (increment).\n@set foo++\n\n; If `foo` is a number, subtract 1 from its value (decrement).\n@set foo--\n\n; Assign `foo` variable value of the `bar` variable, \n; which is `Hello World!` string.\n@set bar=\"Hello World!\"\n@set foo=bar\n\n; Defining multiple set expressions in one line; \n; the result will be the same as above.\n@set bar=\"Hello World!\";foo=bar\n\n; It's possible to inject variables to naninovel script command parameters.\n@set scale=0\n# EnlargeLoop\n@char Kohaku.Default scale:{scale}\n@set scale+=0.1\n@goto .EnlargeLoop if:scale<1\n\n; ...and generic text lines.\n@set drink=\"Dr. Pepper\"\nMy favourite drink is {drink}!\n\n; When using double quotes inside text expression value, escape them.\n@set remark=\"Shouting \\\"Stop the car!\\\" was a mistake.\"\n\n; Use global variable to indicate player reaching `Ending 001`.\n; The variable will remain true even when the game is restarted.\n@set g_Ending001Reached=true\n\n; Increment the global variable only once, even when re-played.\n@set g_GlobalCounter++ if:!HasPlayed()","parameters":[{"id":"Expression","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"Set expression.
The expression should be in the following format: `VariableName=ExpressionBody`, where `VariableName` is the name of the custom variable to assign and `ExpressionBody` is a [script expression](https://naninovel.com/guide/script-expressions), the result of which should be assigned to the variable.
It's also possible to use increment and decrement unary operators (`@set foo++`, `@set foo--`) and compound assignment (`@set foo+=10`, `@set foo-=3`, `@set foo*=0.1`, `@set foo/=2`).","label":"expression","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"set"},{"id":"PlaySfx","alias":"sfx","localizable":false,"summary":"Plays or modifies currently played [SFX (sound effect)](https://naninovel.com/guide/audio#sound-effects) track with the provided name.","remarks":"Sound effect tracks are not looped by default. When sfx track name (SfxPath) is not specified, will affect all the currently played tracks. When invoked for a track that is already playing, the playback won't be affected (track won't start playing from the start), but the specified parameters (volume and whether the track is looped) will be applied.","examples":"; Plays an SFX with the name `Explosion` once.\n@sfx Explosion\n\n; Plays an SFX with the name `Rain` in a loop and fades-in over 30 seconds.\n@sfx Rain loop:true fade:30\n\n; Changes volume of all the played SFX tracks to 75% over 2.5 seconds\n; and disables looping for all of them.\n@sfx volume:0.75 loop:false time:2.5","parameters":[{"id":"SfxPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the sound effect asset to play.","label":"sfxPath","typeLabel":"string"},{"id":"Volume","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Volume of the sound effect.","label":"volume","typeLabel":"decimal"},{"id":"Loop","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to play the sound effect in a loop.","label":"loop","typeLabel":"boolean"},{"id":"FadeInDuration","alias":"fade","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0","summary":"Duration of the volume fade-in when starting playback, in seconds (0.0 by default); doesn't have effect when modifying a playing track.","label":"fade","typeLabel":"decimal"},{"id":"GroupPath","alias":"group","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Audio mixer [group path](https://docs.unity3d.com/ScriptReference/Audio.AudioMixer.FindMatchingGroups) that should be used when playing the audio.","label":"group","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"sfx"},{"id":"PlaySfxFast","alias":"sfxFast","localizable":false,"summary":"Plays an [SFX (sound effect)](https://naninovel.com/guide/audio#sound-effects) track with the provided name. Unlike [@sfx](https://naninovel.com/api/#sfx) command, the clip is played with minimum delay and is not serialized with the game state (won't be played after loading a game, even if it was played when saved). The command can be used to play various transient audio clips, such as UI-related sounds (eg, on button click with [`Play Script` component](https://naninovel.com/guide/user-interface#play-script-on-unity-event)).","examples":"; Plays an SFX with the name `Click` once.\n@sfxFast Click\n\n; Same as above, but allow concurrent playbacks of the same clip.\n@sfxFast Click restart:false","parameters":[{"id":"SfxPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the sound effect asset to play.","label":"sfxPath","typeLabel":"string"},{"id":"Volume","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Volume of the sound effect.","label":"volume","typeLabel":"decimal"},{"id":"Restart","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to start playing the audio from start in case it's already playing.","label":"restart","typeLabel":"boolean"},{"id":"Additive","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to allow playing multiple instances of the same clip; has no effect when `restart` is enabled.","label":"additive","typeLabel":"boolean"},{"id":"GroupPath","alias":"group","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Audio mixer [group path](https://docs.unity3d.com/ScriptReference/Audio.AudioMixer.FindMatchingGroups) that should be used when playing the audio.","label":"group","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"sfxFast"},{"id":"SpawnShake","alias":"shake","localizable":false,"summary":"Applies [shake effect](https://naninovel.com/guide/special-effects.html#shake) for the actor with the specified ID or main camera.","examples":"; Shake `Dialogue` text printer with default params.\n@shake Dialogue\n;\n; Start shaking `Kohaku` character, show choice to stop and act accordingly.\n@shake Kohaku count:0 wait:false\n@choice \"Continue shaking\" goto:.Continue\n@choice \"Stop shaking\" goto:.Stop\n@stop\n# Stop\n@shake Kohaku count:-1\n# Continue\n...\n\n; Shake main Naninovel camera horizontally 5 times.\n@shake Camera count:5 hor:true ver:false","parameters":[{"id":"ActorId","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":3,"subType":"*"}],"summary":"ID of the actor to shake. In case multiple actors with the same ID found (eg, a character and a printer), will affect only the first found one. To shake main camera, use \"Camera\" keyword.","label":"actorId","typeLabel":"string"},{"id":"ShakeCount","alias":"count","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":1,"summary":"The number of shake iterations. When set to 0, will loop until stopped with -1.","label":"count","typeLabel":"integer"},{"id":"ShakeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The base duration of each shake iteration, in seconds.","label":"time","typeLabel":"decimal"},{"id":"DurationVariation","alias":"deltaTime","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The randomizer modifier applied to the base duration of the effect.","label":"deltaTime","typeLabel":"decimal"},{"id":"ShakeAmplitude","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The base displacement amplitude of each shake iteration, in units.","label":"power","typeLabel":"decimal"},{"id":"AmplitudeVariation","alias":"deltaPower","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The randomized modifier applied to the base displacement amplitude.","label":"deltaPower","typeLabel":"decimal"},{"id":"ShakeHorizontally","alias":"hor","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to displace the actor horizontally (by x-axis).","label":"hor","typeLabel":"boolean"},{"id":"ShakeVertically","alias":"ver","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to displace the actor vertically (by y-axis).","label":"ver","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"shake"},{"id":"ShowActors","alias":"show","localizable":false,"summary":"Shows (makes visible) actors (character, background, text printer, choice handler, etc) with the specified IDs. In case multiple actors with the same ID found (eg, a character and a printer), will affect only the first found one.","examples":"; Given an actor with ID `Smoke` is hidden, reveal it over 3 seconds.\n@show Smoke time:3\n\n; Show `Kohaku` and `Yuko` actors.\n@show Kohaku,Yuko","parameters":[{"id":"ActorIds","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":1,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":3,"subType":"*"}],"summary":"IDs of the actors to show.","label":"actorIds","typeLabel":"string list"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade animation.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"show"},{"id":"ShowPrinter","localizable":false,"summary":"Shows a text printer.","examples":"; Show a default printer.\n@showPrinter\n\n; Show printer with ID `Wide`.\n@showPrinter Wide","parameters":[{"id":"PrinterId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printerId","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the show animation. Default value for each printer is set in the actor configuration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"showPrinter"},{"id":"ShowUI","localizable":false,"summary":"Makes [UI elements](https://naninovel.com/guide/user-interface) with the specified resource names visible. When no names are specified, will reveal the entire UI (in case it was hidden with [@hideUI](https://naninovel.com/api/#hideui)).","examples":"; Given you've added a custom UI with `Calendar` name,\n; the following will make it visible on the scene.\n@showUI Calendar\n\n; Given you've hidden the entire UI with @hideUI, show it back.\n@showUI\n\n; Simultaneously reveal built-in `TipsUI` and custom `Calendar` UIs.\n@showUI TipsUI,Calendar","parameters":[{"id":"UINames","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"valueContext":[{"type":2,"subType":"UI"},{"type":2,"subType":"UI"}],"summary":"Name of the UI resource to make visible.","label":"uINames","typeLabel":"string list"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the show animation. When not specified, will use UI-specific duration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"showUI"},{"id":"Skip","localizable":false,"summary":"Allows to enable or disable script player \"skip\" mode.","examples":"; Enable skip mode.\n@skip\n\n; Disable skip mode.\n@skip false","parameters":[{"id":"Enable","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to enable (default) or disable the skip mode.","label":"enable","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"skip"},{"id":"SkipInput","localizable":false,"summary":"Can be used in generic text lines to prevent activating `wait for input` mode when the text is printed.","examples":"; Script player won't wait for continue input before executing @sfx command.\nAnd the rain starts.[skipInput]\n@sfx Rain","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"skipInput"},{"id":"SlideActor","alias":"slide","localizable":false,"summary":"Slides (moves between two positions) an actor (character, background, text printer or choice handler) with the provided ID and optionally changes actor visibility and appearance. Can be used instead of multiple [@char](https://naninovel.com/api/#char) or [@back](https://naninovel.com/api/#back) commands to reveal or hide an actor with a slide animation.","remarks":"Be aware, that this command searches for an existing actor with the provided ID over all the actor managers, and in case multiple actors with the same ID exist (eg, a character and a text printer), this will affect only the first found one. Make sure the actor exist on scene before referencing it with this command; eg, if it's a character, you can add it on scene imperceptibly to player with `@char CharID visible:false time:0`.","examples":"; Given `Jenna` actor is not visible, reveal it with an `Angry` appearance\n; and slide to the center from either left or right border of the scene.\n@slide Jenna.Angry to:50\n\n; Given `Sheba` actor is currently visible,\n; hide and slide it out of the scene over the left border.\n@slide Sheba to:-10 visible:false\n\n\n; Slide `Mia` actor from left-center side of the scene to the right-bottom\n; over 5 seconds using `EaseOutBounce` animation easing.\n@slide Sheba from:15,50 to:85,0 time:5 easing:EaseOutBounce","parameters":[{"id":"IdAndAppearance","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":4}],"summary":"ID of the actor to slide and (optionally) appearance to set.","label":"idAndAppearance","typeLabel":"named string"},{"id":"FromPosition","alias":"from","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position in scene space to slide the actor from (slide start position). Described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene; Z-component (depth) is in world space. When not provided, will use current actor position in case it's visible and a random off-scene position otherwise (could slide-in from left or right borders).","label":"from","typeLabel":"decimal list"},{"id":"ToPosition","alias":"to","nameless":false,"required":true,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position in scene space to slide the actor to (slide finish position).","label":"to","typeLabel":"decimal list"},{"id":"Visible","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Change visibility status of the actor (show or hide). When not set and target actor is hidden, will still automatically show it.","label":"visible","typeLabel":"boolean"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modifications.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the slide animation.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"slide"},{"id":"SpawnSnow","alias":"snow","localizable":false,"summary":"Spawns particle system simulating [snow](https://naninovel.com/guide/special-effects.html#snow).","examples":"; Start intensive snow over 10 seconds.\n@snow power:300 time:10\n; Stop the snow over 30 seconds.\n@snow power:0 time:30","parameters":[{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The intensity of the snow (particles spawn rate per second); defaults to 100. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"FadeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The particle system will gradually grow the spawn rate to the target level over the specified time, in seconds.","label":"time","typeLabel":"decimal"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the spawned effect game object. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the spawned effect game object.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the spawned effect game object.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the spawned effect game object.","label":"scale","typeLabel":"decimal list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"snow"},{"id":"Spawn","localizable":false,"summary":"Instantiates a prefab or a [special effect](https://naninovel.com/guide/special-effects); when performed over an already spawned object, will update the spawn parameters instead.","remarks":"If prefab has a `MonoBehaviour` component attached the root object, and the component implements a `IParameterized` interface, will pass the specified `params` values after the spawn; if the component implements `IAwaitable` interface, command execution will wait for the async completion task returned by the implementation.","examples":"; Given a `Rainbow` prefab is assigned in spawn resources, instantiate it.\n@spawn Rainbow","parameters":[{"id":"Path","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Spawn"},{"type":2,"subType":"Spawn"}],"summary":"Name (path) of the prefab resource to spawn.","label":"path","typeLabel":"string"},{"id":"Params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Parameters to set when spawning the prefab. Requires the prefab to have a `IParameterized` component attached the root object.","label":"params","typeLabel":"string list"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the spawned object. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the spawned object.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the spawned object.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the spawned object.","label":"scale","typeLabel":"decimal list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"spawn"},{"id":"StartSceneTransition","alias":"startTrans","localizable":false,"summary":"Begins scene transition masking the real scene content with anything that is visible at the moment (except the UI). When the new scene is ready, finish with [@finishTrans](https://naninovel.com/api/#finishtrans) command.","remarks":"The UI will be hidden and user input blocked while the transition is in progress. You can change that by overriding the `ISceneTransitionUI`, which handles the transition process.
For the list of available transition effect options see [transition effects](https://naninovel.com/guide/transition-effects) guide.","examples":"; Transition Felix on sunny day with Jenna on rainy day.\n@char Felix\n@back SunnyDay\n@spawn SunShafts\n@startTrans\n; Following modifications won't be visible until the transition is finished.\n@hideChars time:0\n@char Jenna time:0\n@back RainyDay time:0\n@despawn SunShafts params:0\n@spawn Rain params:,0\n; Transition the initially captured scene to the new one\n; with `DropFade` effect over 3 seconds.\n@finishTrans DropFade time:3","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"startTrans"},{"id":"Stop","localizable":false,"summary":"Stops the naninovel script execution.","examples":"Show the choices and halt script execution until the player picks one.\n@choice \"Choice 1\"\n@choice \"Choice 2\"\n@stop\nWe'll get here after player will make a choice.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"stop"},{"id":"StopBgm","localizable":false,"summary":"Stops playing a BGM (background music) track with the provided name.","remarks":"When music track name (BgmPath) is not specified, will stop all the currently played tracks.","examples":"; Fades-out `Sanctuary` bgm track over 10 seconds and stops the playback.\n@stopBgm Sanctuary fade:10\n\n; Stops all the currently played music tracks.\n@stopBgm","parameters":[{"id":"BgmPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the music track to stop.","label":"bgmPath","typeLabel":"string"},{"id":"FadeOutDuration","alias":"fade","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration of the volume fade-out before stopping playback, in seconds (0.35 by default).","label":"fade","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"stopBgm"},{"id":"StopSfx","localizable":false,"summary":"Stops playing an SFX (sound effect) track with the provided name.","remarks":"When sound effect track name (SfxPath) is not specified, will stop all the currently played tracks.","examples":"; Stop playing an SFX with the name `Rain`, fading-out for 15 seconds.\n@stopSfx Rain fade:15\n\n; Stops all the currently played sound effect tracks.\n@stopSfx","parameters":[{"id":"SfxPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the sound effect to stop.","label":"sfxPath","typeLabel":"string"},{"id":"FadeOutDuration","alias":"fade","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration of the volume fade-out before stopping playback, in seconds (0.35 by default).","label":"fade","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"stopSfx"},{"id":"StopVoice","localizable":false,"summary":"Stops playback of the currently played voice clip.","examples":"; Given a voice is being played, stop it.\n@stopVoice","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"stopVoice"},{"id":"SetTextStyle","alias":"style","localizable":false,"summary":"Permanently applies [text styles](https://naninovel.com/guide/text-printers#text-styles) to the contents of a text printer.","remarks":"You can also use rich text tags inside text messages to apply the styles selectively.","examples":"; Print first two sentences in bold red text with 45px size,\n; then reset the style and print the last sentence using default style.\n@style color=#ff0000,b,size=45\nLorem ipsum dolor sit amet.\nCras ut nisi eget ex viverra egestas in nec magna.\n@style default\nConsectetur adipiscing elit.\n\n; Print starting part of the sentence normally, but the last one in bold.\nLorem ipsum sit amet. Consectetur adipiscing elit.","parameters":[{"id":"TextStyles","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Text formatting tags to apply. Angle brackets should be omitted, eg use `b` for `` and `size=100` for ``. Use `default` keyword to reset the style.","label":"textStyles","typeLabel":"string list"},{"id":"PrinterId","alias":"printer","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printer","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"style"},{"id":"SpawnSun","alias":"sun","localizable":false,"summary":"Spawns particle system simulating [sun shafts](https://naninovel.com/guide/special-effects.html#sun-shafts) aka god rays.","examples":"; Start intensive sunshine over 10 seconds.\n@sun power:1 time:10\n; Stop the sunshine over 30 seconds.\n@sun power:0 time:30","parameters":[{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The intensity of the rays (opacity), in 0.0 to 1.0 range; default is 0.85. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"FadeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The particle system will gradually grow the spawn rate to the target level over the specified time, in seconds.","label":"time","typeLabel":"decimal"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the spawned effect game object. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the spawned effect game object.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the spawned effect game object.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the spawned effect game object.","label":"scale","typeLabel":"decimal list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"sun"},{"id":"ExitToTitle","alias":"title","localizable":false,"summary":"Resets engine state and shows `ITitleUI` UI (main menu).","examples":"; Exit to title UI, no matter which script is playing.\n@title","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"title"},{"id":"ShowToastUI","alias":"toast","localizable":true,"summary":"Shows a UI for general-purpose self-hiding popup notification (aka \"toast\") with the provided text and (optionally) appearance and duration. The UI is automatically hidden after the specified (or default) duration.","remarks":"Appearance name is the name of a game object with `Toast Appearance` component inside the `ToastUI` UI prefab (case-insensitive).","examples":"; Shows a default toast with `Hello World!` content.\n@toast \"Hello World!\"\n\n; Shows a toast with a `warning` appearance.\n@toast \"You're in danger!\" appearance:warning\n\n; The toast will disappear in one second.\n@toast \"I'll disappear in 1 second.\" time:1","parameters":[{"id":"Text","alias":"","nameless":true,"required":false,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"The text content to set for the toast.","label":"text","typeLabel":"string"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Appearance variant (game object name) of the toast. When not specified, will use default appearance set in Toast UI prefab.","label":"appearance","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Seconds to wait before hiding the toast. When not specified, will use duration set by default in Toast UI prefab.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"toast"},{"id":"UnloadScene","localizable":false,"summary":"Unloads a [Unity scene](https://docs.unity3d.com/Manual/CreatingScenes.html) with the provided name. Don't forget to add the required scenes to the [build settings](https://docs.unity3d.com/Manual/BuildSettings.html) to make them available for loading. Be aware, that only scenes loaded additively can be then unloaded (at least one scene should always remain loaded).","examples":"; Load scene `TestScene2` in additive mode and then unload it.\n@loadScene TestScene2 additive:true\n@unloadScene TestScene2","parameters":[{"id":"SceneName","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name of the scene to unload.","label":"sceneName","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"unloadScene"},{"id":"Unlock","localizable":false,"summary":"Sets an [unlockable item](https://naninovel.com/guide/unlockable-items) with the provided ID to `unlocked` state.","remarks":"The unlocked state of the items is stored in [global scope](https://naninovel.com/guide/state-management#global-state).
In case item with the provided ID is not registered in the global state map, the corresponding record will automatically be added.","examples":"; Unlocks an unlockable CG record with ID `FightScene1`.\n@unlock CG/FightScene1","parameters":[{"id":"Id","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Unlockables"},{"type":2,"subType":"Unlockables"}],"summary":"ID of the unlockable item. Use `*` to unlock all the registered unlockable items.","label":"id","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"unlock"},{"id":"PlayVoice","alias":"voice","localizable":false,"summary":"Plays a voice clip at the provided path.","examples":"; Given a `Rawr` voice resource is available, play it.\n@voice Rawr","parameters":[{"id":"VoicePath","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Voice"},{"type":2,"subType":"Voice"}],"summary":"Path to the voice clip to play.","label":"voicePath","typeLabel":"string"},{"id":"Volume","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Volume of the playback.","label":"volume","typeLabel":"decimal"},{"id":"GroupPath","alias":"group","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Audio mixer [group path](https://docs.unity3d.com/ScriptReference/Audio.AudioMixer.FindMatchingGroups) that should be used when playing the audio.","label":"group","typeLabel":"string"},{"id":"AuthorId","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"ID of the character actor this voice belongs to. When provided and [per-author volume](https://naninovel.com/guide/voicing#author-volume) is used, volume will be adjusted accordingly.","label":"authorId","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"voice"},{"id":"Wait","localizable":false,"summary":"Holds script execution until the specified wait condition.","examples":"; Thunder SFX will play 0.5 seconds after shake background effect finishes.\n@spawn ShakeBackground\n@wait 0.5\n@sfx Thunder\n\n; Print first 2 words, then wait for input before printing the rest.\nLorem ipsum[wait i] dolor sit amet.\n; You can also use the following shortcut (@i command) for this wait mode.\nLorem ipsum[i] dolor sit amet.\n\n; Start looped SFX, print message and wait for a skippable 5 seconds delay,\n; then stop the SFX.\n@sfx Noise loop:true\nJeez, what a disgusting noise. Shut it down![wait i5][skipInput]\n@stopSfx Noise\n\n; The text is printed without delay, as the `wait` command is not awaited.\n; The thunder effects are played after a random delay of 3 to 8 seconds.\n@wait {Random(3,8)} do:\"@sfx Thunder, @shake Camera\" wait:false\nThe thunder might go off any second...","parameters":[{"id":"WaitMode","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Wait conditions:
- `i` user press continue or skip input key;
- `0.0` timer (seconds);
- `i0.0` timer, that is skip-able by continue or skip input keys.","label":"waitMode","typeLabel":"string"},{"id":"OnFinished","alias":"do","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Script commands to execute when the wait is over. Escape commas inside list values to prevent them being treated as delimiters.","label":"do","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"wait"}],"resources":[],"constants":[{"name":"TransitionType","values":["Crossfade","BandedSwirl","Blinds","CircleReveal","CircleStretch","CloudReveal","Crumble","Dissolve","DropFade","LineReveal","Pixelate","RadialBlur","RadialWiggle","RandomCircleReveal","Ripple","RotateCrumble","Saturate","Shrink","SlideIn","SwirlGrid","Swirl","Water","Waterfall","Wave","Custom"]},{"name":"EasingType","values":["Linear","SmoothStep","Spring","EaseInQuad","EaseOutQuad","EaseInOutQuad","EaseInCubic","EaseOutCubic","EaseInOutCubic","EaseInQuart","EaseOutQuart","EaseInOutQuart","EaseInQuint","EaseOutQuint","EaseInOutQuint","EaseInSine","EaseOutSine","EaseInOutSine","EaseInExpo","EaseOutExpo","EaseInOutExpo","EaseInCirc","EaseOutCirc","EaseInOutCirc","EaseInBounce","EaseOutBounce","EaseInOutBounce","EaseInBack","EaseOutBack","EaseInOutBack","EaseInElastic","EaseOutElastic","EaseInOutElastic"]},{"name":"CharacterLookDirection","values":["Center","Left","Right"]}],"variables":[],"functions":["Random","CalculateProgress","IsUnlocked","HasPlayed","GetName"]}
\ No newline at end of file
+{"actors":[],"commands":[{"id":"AnimateActor","alias":"animate","localizable":false,"summary":"Animate properties of the actors with the specified IDs via key frames. Key frames for the animated parameters are delimited with commas.","remarks":"It's not recommended to use this command for complex animations. Naniscript is a scenario scripting DSL and not suited for complex automation or specification such as animation. Consider using dedicated animation tools instead, such as Unity's [Animator](https://docs.unity3d.com/Manual/AnimationSection.html).
Be aware, that this command searches for actors with the provided IDs over all the actor managers, and in case multiple actors with the same ID exist (eg, a character and a text printer), this will affect only the first found one.
When running the animate commands in parallel (`wait` is set to false) the affected actors state can mutate unpredictably. This could cause unexpected results when rolling back or performing other commands that affect state of the actor. Make sure to reset affected properties of the animated actors (position, tint, appearance, etc) after the command finishes or use `@animate CharacterId` (without any args) to stop the animation prematurely.","examples":"; Animate `Kohaku` actor over three animation steps (key frames),\n; changing positions: first step will take 1, second — 0.5 and third — 3 seconds.\n@animate Kohaku posX:50,0,85 time:1,0.5,3\n\n; Start loop animations of `Yuko` and `Kohaku` actors; notice, that you can skip\n; key values indicating that the parameter shouldn't change during the animation step.\n@animate Kohaku,Yuko loop:true appearance:Surprise,Sad,Default,Angry transition:DropFade,Ripple,Pixelate posX:15,85,50 posY:0,-25,-85 scale:1,1.25,1.85 tint:#25f1f8,lightblue,#ffffff,olive easing:EaseInBounce,EaseInQuad time:3,2,1,0.5 wait:false\n...\n; Stop the animations.\n@animate Yuko,Kohaku loop:false\n\n; Start a long background animation for `Kohaku`.\n@animate Kohaku posX:90,0,90 scale:1,2,1 time:10 wait:false\n; Do something else while the animation is running.\n...\n; Here we're going to set a specific position for the character,\n; but the animation could still be running in background, so reset it first.\n@animate Kohaku\n; Now it's safe to modify previously animated properties.\n@char Kohaku pos:50 scale:1","parameters":[{"id":"ActorIds","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"IDs of the actors to animate.","label":"actorIds","typeLabel":"string list"},{"id":"Loop","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to loop the animation; make sure to set `wait` to false when loop is enabled, otherwise script playback will loop indefinitely.","label":"loop","typeLabel":"boolean"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Appearances to set for the animated actors.","label":"appearance","typeLabel":"string"},{"id":"Transition","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use when animating appearance change (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"Visibility","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Visibility status to set for the animated actors.","label":"visibility","typeLabel":"string"},{"id":"ScenePositionX","alias":"posX","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Position values over X-axis (in 0 to 100 range, in percents from the left border of the scene) to set for the animated actors.","label":"posX","typeLabel":"string"},{"id":"ScenePositionY","alias":"posY","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Position values over Y-axis (in 0 to 100 range, in percents from the bottom border of the scene) to set for the animated actors.","label":"posY","typeLabel":"string"},{"id":"PositionZ","alias":"posZ","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Position values over Z-axis (in world space) to set for the animated actors; while in ortho mode, can only be used for sorting.","label":"posZ","typeLabel":"string"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Rotation values (over Z-axis) to set for the animated actors.","label":"rotation","typeLabel":"string"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Scale (`x,y,z` or a single uniform value) to set for the animated actors.","label":"scale","typeLabel":"string"},{"id":"TintColor","alias":"tint","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Tint colors to set for the animated actors.
Strings that begin with `#` will be parsed as hexadecimal in the following way: `#RGB` (becomes RRGGBB), `#RRGGBB`, `#RGBA` (becomes RRGGBBAA), `#RRGGBBAA`; when alpha is not specified will default to FF.
Strings that do not begin with `#` will be parsed as literal colors, with the following supported: red, cyan, blue, darkblue, lightblue, purple, yellow, lime, fuchsia, white, silver, grey, black, orange, brown, maroon, green, olive, navy, teal, aqua, magenta.","label":"tint","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Names of the easing functions to use for the animations.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Duration of the animations per key, in seconds. When a key value is missing, will use one from a previous key. When not assigned, will use 0.35 seconds duration for all keys.","label":"time","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"animate"},{"id":"AppendText","alias":"append","localizable":true,"summary":"Appends provided text to a text printer.","remarks":"The entire text will be appended immediately, without triggering reveal effect or any other side-effects.","examples":"; Print first part of the sentence as usual (with gradual reveal),\n; then append the end of the sentence at once.\nLorem ipsum\n@append \" dolor sit amet.\"","parameters":[{"id":"Text","alias":"","nameless":true,"required":true,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"The text to append.","label":"text","typeLabel":"string"},{"id":"PrinterId","alias":"printer","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a a default one when not provided.","label":"printer","typeLabel":"string"},{"id":"AuthorId","alias":"author","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"Characters"},{"type":3,"subType":"Characters"}],"summary":"ID of the actor, which should be associated with the appended text.","label":"author","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"append"},{"id":"ArrangeCharacters","alias":"arrange","localizable":false,"summary":"Arranges specified characters by X-axis. When no parameters provided, will execute an auto-arrange evenly distributing visible characters by X-axis.","examples":"; Evenly distribute all the visible characters.\n@arrange\n\n; Place character with ID `Jenna` 15%, `Felix` 50% and `Mia` 85% away\n; from the left border of the scene.\n@arrange Jenna.15,Felix.50,Mia.85","parameters":[{"id":"CharacterPositions","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":3,"valueType":2,"valueContext":[{"type":3,"subType":"Characters"}],"summary":"A collection of character ID to scene X-axis position (relative to the left scene border, in percents) named values. Position 0 relates to the left border and 100 to the right border of the scene; 50 is the center.","label":"characterPositions","typeLabel":"named decimal list"},{"id":"LookAtOrigin","alias":"look","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"When performing auto-arrange, controls whether to also make the characters look at the scene origin (enabled by default).","label":"look","typeLabel":"boolean"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the arrangement animation.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"arrange"},{"id":"ModifyBackground","alias":"back","localizable":false,"summary":"Modifies a [background actor](https://naninovel.com/guide/backgrounds).","remarks":"Backgrounds are handled a bit differently from characters to better accommodate traditional VN game flow. Most of the time you'll probably have a single background actor on scene, which will constantly transition to different appearances. To remove the hassle of repeating same actor ID in scripts, it's possible to provide only the background appearance and transition type (optional) as a nameless parameter assuming `MainBackground` actor should be affected. When this is not the case, ID of the background actor can be explicitly provided via the `id` parameter.","examples":"; Set `River` as the appearance of the main background.\n@back River\n\n; Same as above, but also use a `RadialBlur` transition effect.\n@back River.RadialBlur\n\n; Position `Smoke` background at the center of the screen\n; and scale it 50% of the original size.\n@back id:Smoke pos:50,50 scale:0.5\n\n; Tint all visible backgrounds on scene.\n@back id:* tint:#ffdc22","parameters":[{"id":"AppearanceAndTransition","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":4,"subType":"MainBackground"},{"type":1,"subType":"TransitionType"}],"summary":"Appearance (or [pose](https://naninovel.com/guide/backgrounds#poses)) to set for the modified background and type of a [transition effect](https://naninovel.com/guide/transition-effects) to use. When transition is not provided, a cross-fade effect will be used by default.","label":"appearanceAndTransition","typeLabel":"named string"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the modified actor. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Id","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"ID of the actor to modify; specify `*` to affect all visible actors.","label":"id","typeLabel":"string"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":4},{"type":4}],"summary":"Appearance to set for the modified actor.","label":"appearance","typeLabel":"string"},{"id":"Pose","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Pose to set for the modified actor.","label":"pose","typeLabel":"string"},{"id":"Transition","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"TransitionType"},{"type":1,"subType":"TransitionType"}],"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"TransitionParams","alias":"params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"summary":"Parameters of the transition effect.","label":"params","typeLabel":"decimal list"},{"id":"DissolveTexturePath","alias":"dissolve","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path to the [custom dissolve](https://naninovel.com/guide/transition-effects#custom-transition-effects) texture (path should be relative to a `Resources` folder). Has effect only when the transition is set to `Custom` mode.","label":"dissolve","typeLabel":"string"},{"id":"Visible","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Visibility status to set for the modified actor.","label":"visible","typeLabel":"boolean"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the modified actor. Use Z-component (third member) to move (sort) by depth while in ortho mode.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the modified actor.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the modified actor.","label":"scale","typeLabel":"decimal list"},{"id":"TintColor","alias":"tint","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":5,"subType":""},{"type":5,"subType":""}],"summary":"Tint color to set for the modified actor.
Strings that begin with `#` will be parsed as hexadecimal in the following way: `#RGB` (becomes RRGGBB), `#RRGGBB`, `#RGBA` (becomes RRGGBBAA), `#RRGGBBAA`; when alpha is not specified will default to FF.
Strings that do not begin with `#` will be parsed as literal colors, with the following supported: red, cyan, blue, darkblue, lightblue, purple, yellow, lime, fuchsia, white, silver, grey, black, orange, brown, maroon, green, olive, navy, teal, aqua, magenta.","label":"tint","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"back"},{"id":"PlayBgm","alias":"bgm","localizable":false,"summary":"Plays or modifies currently played [BGM (background music)](https://naninovel.com/guide/audio#background-music) track with the provided name.","remarks":"Music tracks are looped by default. When music track name (BgmPath) is not specified, will affect all the currently played tracks. When invoked for a track that is already playing, the playback won't be affected (track won't start playing from the start), but the specified parameters (volume and whether the track is looped) will be applied.","examples":"; Starts playing a music track with the name `Sanctuary` in a loop.\n@bgm Sanctuary\n\n; Same as above, but fades-in the volume over 10 seconds and plays once.\n@bgm Sanctuary fade:10 loop:false\n\n; Changes volume of all the played music tracks to 50% over 2.5 seconds\n; and makes them play in a loop.\n@bgm volume:0.5 loop:true time:2.5\n\n; Plays `BattleThemeIntro` once, then loops `BattleThemeMain`.\n@bgm BattleThemeMain intro:BattleThemeIntro","parameters":[{"id":"BgmPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the music track to play.","label":"bgmPath","typeLabel":"string"},{"id":"IntroBgmPath","alias":"intro","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the intro music track to play once before the main track (not affected by the loop parameter).","label":"intro","typeLabel":"string"},{"id":"Volume","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Volume of the music track.","label":"volume","typeLabel":"decimal"},{"id":"Loop","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to play the track from beginning when it finishes.","label":"loop","typeLabel":"boolean"},{"id":"FadeInDuration","alias":"fade","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0","summary":"Duration of the volume fade-in when starting playback, in seconds (0.0 by default); doesn't have effect when modifying a playing track.","label":"fade","typeLabel":"decimal"},{"id":"GroupPath","alias":"group","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Audio mixer [group path](https://docs.unity3d.com/ScriptReference/Audio.AudioMixer.FindMatchingGroups) that should be used when playing the audio.","label":"group","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"bgm"},{"id":"SpawnBlur","alias":"blur","localizable":false,"summary":"Applies [blur effect](https://naninovel.com/guide/special-effects.html#blur) to supported actor: backgrounds and characters of sprite, layered, diced, Live2D, Spine, video and scene implementations.","remarks":"The actor should have `IBlurable` interface implemented in order to support the effect.","examples":"; Blur main background with default parameters.\n@blur\n; Remove blur from the main background.\n@blur power:0\n\n; Blur `Kohaku` actor with max power over 5 seconds.\n@blur Kohaku power:1 time:5\n; Remove blur from `Kohaku` over 3.1 seconds.\n@blur Kohaku power:0 time:3.1","parameters":[{"id":"ActorId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":3,"subType":"*"}],"defaultValue":"MainBackground","summary":"ID of the actor to apply the effect for; in case multiple actors with the same ID found (eg, a character and a printer), will affect only the first found one. When not specified, applies to the main background.","label":"actorId","typeLabel":"string"},{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Intensity of the effect, in 0.0 to 1.0 range. Defaults to 0.5. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"FadeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"How long it will take the parameters to reach the target values, in seconds. Defaults to 1.0.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"blur"},{"id":"SpawnBokeh","alias":"bokeh","localizable":false,"summary":"Simulates [depth of field](https://naninovel.com/guide/special-effects.html#depth-of-field-bokeh) (aka DOF, bokeh) effect, when only the object in focus stays sharp, while others are blurred.","examples":"; Enable the effect with defaults and lock focus on `Kohaku` game object.\n@bokeh focus:Kohaku\n; Fade-off (disable) the effect over 10 seconds.\n@bokeh power:0 time:10\n; Set focus point 10 units away from the camera,\n; focal distance to 0.95 and apply it over 3 seconds.\n@bokeh dist:10 power:0.95 time:3","parameters":[{"id":"FocusObjectName","alias":"focus","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name of the game object to set focus for (optional). When set, the focus will always stay on the game object, while `dist` parameter will be ignored.","label":"focus","typeLabel":"string"},{"id":"FocusDistance","alias":"dist","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Distance (in units) from Naninovel camera to the focus point. Ignored when `focus` parameter is specified. Defaults to 10.","label":"dist","typeLabel":"decimal"},{"id":"FocalLength","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Amount of blur to apply for the de-focused areas; also determines focus sensitivity. Defaults to 3.75. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"How long it will take the parameters to reach the target values, in seconds. Defaults to 1.0.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"bokeh"},{"id":"AppendLineBreak","alias":"br","localizable":false,"summary":"Adds a line break to a text printer.","remarks":"Consider using `
` tag instead with [TMPro printers](https://naninovel.com/guide/text-printers#textmesh-pro).","examples":"; Second sentence will be printed on a new line.\nLorem ipsum dolor sit amet.[br]Consectetur adipiscing elit.\n\n; Second sentence will be printer two lines under the first one.\nLorem ipsum dolor sit amet.[br 2]Consectetur adipiscing elit.","parameters":[{"id":"Count","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":1,"defaultValue":"1","summary":"Number of line breaks to add.","label":"count","typeLabel":"integer"},{"id":"PrinterId","alias":"printer","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printer","typeLabel":"string"},{"id":"AuthorId","alias":"author","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"Characters"},{"type":3,"subType":"Characters"}],"summary":"ID of the actor, which should be associated with the appended line break.","label":"author","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"br"},{"id":"ModifyCamera","alias":"camera","localizable":false,"summary":"Modifies the main camera, changing offset, zoom level and rotation over time. Check [this video](https://youtu.be/zy28jaMss8w) for a quick demonstration of the command effect.","examples":"; Offset the camera by -3 units over X-axis and by 1.5 units Y-axis.\n@camera offset:-3,1.5\n\n; Set camera in perspective mode, zoom-in by 50% and move back by 5 units.\n@camera ortho:false offset:,,-5 zoom:0.5\n\n; Set camera in orthographic mode and roll by 10 degrees clock-wise.\n@camera ortho:true roll:10\n\n; Offset, zoom and roll simultaneously animated over 5 seconds.\n@camera offset:-3,1.5 zoom:0.5 roll:10 time:5\n\n; Instantly reset camera to the default state.\n@camera offset:0,0 zoom:0 rotation:0,0,0 time:0\n\n; Toggle `FancyCameraFilter` and `Bloom` components attached to the camera.\n@camera toggle:FancyCameraFilter,Bloom\n\n; Set `FancyCameraFilter` component enabled and `Bloom` disabled.\n@camera set:FancyCameraFilter.true,Bloom.false\n\n; Disable all components attached to the camera object.\n@camera set:*.false","parameters":[{"id":"Offset","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Local camera position offset in units by X,Y,Z axes.","label":"offset","typeLabel":"decimal list"},{"id":"Roll","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Local camera rotation by Z-axis in angle degrees (0.0 to 360.0 or -180.0 to 180.0). The same as third component of `rotation` parameter; ignored when `rotation` is specified.","label":"roll","typeLabel":"decimal"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Local camera rotation over X,Y,Z-axes in angle degrees (0.0 to 360.0 or -180.0 to 180.0).","label":"rotation","typeLabel":"decimal list"},{"id":"Zoom","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Relative camera zoom (orthographic size or field of view, depending on the render mode), in 0.0 (no zoom) to 1.0 (full zoom) range.","label":"zoom","typeLabel":"decimal"},{"id":"Orthographic","alias":"ortho","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the camera should render in orthographic (true) or perspective (false) mode.","label":"ortho","typeLabel":"boolean"},{"id":"ToggleTypeNames","alias":"toggle","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Names of the components to toggle (enable if disabled and vice-versa). The components should be attached to the same game object as the camera. This can be used to toggle [custom post-processing effects](https://naninovel.com/guide/special-effects#camera-effects). Use `*` to affect all the components attached to the camera object.","label":"toggle","typeLabel":"string list"},{"id":"SetTypeNames","alias":"set","nameless":false,"required":false,"localizable":false,"valueContainerType":3,"valueType":3,"summary":"Names of the components to enable or disable. The components should be attached to the same game object as the camera. This can be used to explicitly enable or disable [custom post-processing effects](https://naninovel.com/guide/special-effects#camera-effects). Specified components enabled state will override effect of `toggle` parameter. Use `*` to affect all the components attached to the camera object.","label":"set","typeLabel":"named boolean list"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the camera configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"camera"},{"id":"ModifyCharacter","alias":"char","localizable":false,"summary":"Modifies a [character actor](https://naninovel.com/guide/characters).","examples":"; Shows character with ID `Sora` with a default appearance.\n@char Sora\n\n; Same as above, but sets appearance to `Happy`.\n@char Sora.Happy\n\n; Same as above, but additionally positions the character 45% away \n; from the left border of the scene and 10% away from the bottom border; \n; also makes it look to the left.\n@char Sora.Happy look:left pos:45,10\n\n; Make Sora appear at the bottom-center and in front of Felix.\n@char Sora pos:50,0,-1\n@char Felix pos:,,0\n\n; Tint all visible characters on scene.\n@char * tint:#ffdc22","parameters":[{"id":"IdAndAppearance","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":3,"subType":"Characters"},{"type":4}],"summary":"ID of the character to modify (specify `*` to affect all visible characters) and an appearance (or [pose](https://naninovel.com/guide/characters#poses)) to set. When appearance is not provided, will use either a `Default` (is exists) or a random one.","label":"idAndAppearance","typeLabel":"named string"},{"id":"LookDirection","alias":"look","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"CharacterLookDirection"},{"type":1,"subType":"CharacterLookDirection"}],"summary":"Look direction of the actor; supported values: left, right, center.","label":"look","typeLabel":"string"},{"id":"AvatarTexturePath","alias":"avatar","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name (path) of the [avatar texture](https://naninovel.com/guide/characters#avatar-textures) to assign for the character. Use `none` to remove (un-assign) avatar texture from the character.","label":"avatar","typeLabel":"string"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the modified actor. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Id","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"ID of the actor to modify; specify `*` to affect all visible actors.","label":"id","typeLabel":"string"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":4},{"type":4}],"summary":"Appearance to set for the modified actor.","label":"appearance","typeLabel":"string"},{"id":"Pose","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Pose to set for the modified actor.","label":"pose","typeLabel":"string"},{"id":"Transition","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"TransitionType"},{"type":1,"subType":"TransitionType"}],"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"TransitionParams","alias":"params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"summary":"Parameters of the transition effect.","label":"params","typeLabel":"decimal list"},{"id":"DissolveTexturePath","alias":"dissolve","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path to the [custom dissolve](https://naninovel.com/guide/transition-effects#custom-transition-effects) texture (path should be relative to a `Resources` folder). Has effect only when the transition is set to `Custom` mode.","label":"dissolve","typeLabel":"string"},{"id":"Visible","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Visibility status to set for the modified actor.","label":"visible","typeLabel":"boolean"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the modified actor. Use Z-component (third member) to move (sort) by depth while in ortho mode.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the modified actor.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the modified actor.","label":"scale","typeLabel":"decimal list"},{"id":"TintColor","alias":"tint","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":5,"subType":""},{"type":5,"subType":""}],"summary":"Tint color to set for the modified actor.
Strings that begin with `#` will be parsed as hexadecimal in the following way: `#RGB` (becomes RRGGBB), `#RRGGBB`, `#RGBA` (becomes RRGGBBAA), `#RRGGBBAA`; when alpha is not specified will default to FF.
Strings that do not begin with `#` will be parsed as literal colors, with the following supported: red, cyan, blue, darkblue, lightblue, purple, yellow, lime, fuchsia, white, silver, grey, black, orange, brown, maroon, green, olive, navy, teal, aqua, magenta.","label":"tint","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"char"},{"id":"AddChoice","alias":"choice","localizable":true,"summary":"Adds a [choice](https://naninovel.com/guide/choices) option to a choice handler with the specified ID (or default one).","remarks":"When `goto`, `gosub` and `do` parameters are not specified, will continue script execution from the next script line.","examples":"; Print the text, then immediately show choices and stop script execution.\nContinue executing this script or ...?[skipInput]\n@choice \"Continue\"\n@choice \"Load another script from start\" goto:Another\n@choice \"Load another script from \\\"Label\\\" label\" goto:Another.Label\n@choice \"Goto to \\\"Sub\\\" subroutine in another script\" gosub:Another.Sub\n@stop\n\n; You can also set custom variables based on choices.\n@choice \"I'm humble, one is enough...\" set:score++\n@choice \"Two, please.\" set:score=score+2\n@choice \"I'll take the entire stock!\" set:karma--;score=999\n\n; Play a sound effect and arrange characters when choice is picked.\n@choice Arrange do:\"@sfx Click, @arrange k.10\\,y.55\"\n\n; Print a text line corresponding to the picked choice.\n@choice \"Ask about color\" do:\"What's your favorite color?\"\n@choice \"Ask about age\" do:\"How old are you?\"\n@choice \"Keep silent\" do:\"...\"\n@stop\n\n; Make choice disabled/locked when 'score' variable is below 10.\n@choice \"Secret option\" lock:{score<10}","parameters":[{"id":"ChoiceSummary","alias":"","nameless":true,"required":false,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"Text to show for the choice. When the text contain spaces, wrap it in double quotes (`\"`). In case you wish to include the double quotes in the text itself, escape them.","label":"choiceSummary","typeLabel":"string"},{"id":"Lock","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether the choice should be disabled or otherwise not accessible for player to pick; see [choice docs](https://naninovel.com/guide/choices#locked-choice) for more info. Disabled by default.","label":"lock","typeLabel":"boolean"},{"id":"ButtonPath","alias":"button","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path (relative to a `Resources` folder) to a [button prefab](https://naninovel.com/guide/choices#choice-button) representing the choice. The prefab should have a `ChoiceHandlerButton` component attached to the root object. Will use a default button when not provided.","label":"button","typeLabel":"string"},{"id":"ButtonPosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y"},{"type":6,"subType":"X,Y"}],"summary":"Local position of the choice button inside the choice handler (if supported by the handler implementation).","label":"pos","typeLabel":"decimal list"},{"id":"HandlerId","alias":"handler","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"ChoiceHandlers"},{"type":3,"subType":"ChoiceHandlers"}],"summary":"ID of the choice handler to add choice for. Will use a default handler if not provided.","label":"handler","typeLabel":"string"},{"id":"GotoPath","alias":"goto","nameless":false,"required":false,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":2,"subType":"Scripts"},{"type":1,"subType":"Labels/{:GotoPath[0]??$Script}"}],"summary":"Path to go when the choice is selected by user; see [@goto](https://naninovel.com/api/#goto) command for the path format.","label":"goto","typeLabel":"named string"},{"id":"GosubPath","alias":"gosub","nameless":false,"required":false,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":2,"subType":"Scripts"},{"type":1,"subType":"Labels/{:GosubPath[0]??$Script}"}],"summary":"Path to a subroutine to go when the choice is selected by user; see [@gosub](https://naninovel.com/api/#gosub) command for the path format. When `goto` is assigned this parameter will be ignored.","label":"gosub","typeLabel":"named string"},{"id":"SetExpression","alias":"set","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"Set expression to execute when the choice is selected by user; see [@set](https://naninovel.com/api/#set) command for syntax reference.","label":"set","typeLabel":"string"},{"id":"OnSelected","alias":"do","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Script commands to execute when the choice is selected by user. Escape commas inside list values to prevent them being treated as delimiters. The commands will be invoked in order after `set`, `goto` and `gosub` are handled (if assigned).","label":"do","typeLabel":"string list"},{"id":"AutoPlay","alias":"play","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to automatically continue playing script from the next line, when neither `goto` nor `gosub` parameters are specified. Has no effect in case the script is already playing when the choice is processed.","label":"play","typeLabel":"boolean"},{"id":"ShowHandler","alias":"show","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to also show choice handler the choice is added for; enabled by default.","label":"show","typeLabel":"boolean"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade-in (reveal) animation.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"choice"},{"id":"ClearBacklog","localizable":false,"summary":"Removes all the messages from [printer backlog](https://naninovel.com/guide/text-printers#printer-backlog).","examples":"; Printed text will be removed from the backlog.\nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n@clearBacklog","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"clearBacklog"},{"id":"ClearChoiceHandler","alias":"clearChoice","localizable":false,"summary":"Removes all the choice options in the choice handler with the provided ID (or in default one, when ID is not specified; or in all the existing handlers, when `*` is specified as ID) and (optionally) hides it (them).","examples":"; Give the player 2 seconds to pick a choice.\n# Start\nYou have 2 seconds to respond![skipInput]\n@choice Cats goto:.PickedChoice\n@choice Dogs goto:.PickedChoice\n@wait 2\n@clearChoice\nToo late!\n@stop\n# PickedChoice\nGood!","parameters":[{"id":"HandlerId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"ChoiceHandlers"},{"type":3,"subType":"ChoiceHandlers"}],"summary":"ID of the choice handler to clear. Will use a default handler if not provided. Specify `*` to clear all the existing handlers.","label":"handlerId","typeLabel":"string"},{"id":"Hide","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to also hide the affected choice handlers.","label":"hide","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"clearChoice"},{"id":"DestroySpawned","alias":"despawn","localizable":false,"summary":"Destroys an object spawned with [@spawn](https://naninovel.com/api/#spawn) command.","remarks":"If prefab has a `MonoBehaviour` component attached the root object, and the component implements a `IParameterized` interface, will pass the specified `params` values before destroying the object; if the component implements `IAwaitable` interface, command execution will wait for the async completion task returned by the implementation before destroying the object.","examples":"; Given `@spawn Rainbow` command was executed before, de-spawn (destroy) it.\n@despawn Rainbow","parameters":[{"id":"Path","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name (path) of the prefab resource to destroy. A [@spawn](https://naninovel.com/api/#spawn) command with the same parameter is expected to be executed before.","label":"path","typeLabel":"string"},{"id":"Params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Parameters to set before destroying the prefab. Requires the prefab to have a `IParameterized` component attached the root object.","label":"params","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"despawn"},{"id":"DestroyAllSpawned","alias":"despawnAll","localizable":false,"summary":"Destroys all the objects spawned with [@spawn](https://naninovel.com/api/#spawn) command. Equal to invoking [@despawn](https://naninovel.com/api/#despawn) for all the currently spawned objects.","examples":"@spawn Rainbow\n@spawn SunShafts\n; Will de-spawn (destroy) both rainbow and SunShafts.\n@despawnAll","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"despawnAll"},{"id":"Else","localizable":false,"summary":"Marks a branch of a conditional execution block, which is always executed in case conditions of the opening [@if](https://naninovel.com/api/#if) and all the preceding [@elseif](https://naninovel.com/api/#elseif) (if any) commands are not met. For usage examples see [conditional execution](https://naninovel.com/guide/naninovel-scripts#conditional-execution) guide.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"else"},{"id":"ElseIf","localizable":false,"summary":"Marks a branch of a conditional execution block, which is executed in case own condition is met (expression is evaluated to be true), while conditions of the opening [@if](https://naninovel.com/api/#if) and all the preceding [@elseif](https://naninovel.com/api/#elseif) (if any) commands are not met. For usage examples see [conditional execution](https://naninovel.com/guide/naninovel-scripts#conditional-execution) guide.","parameters":[{"id":"Expression","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A [script expression](https://naninovel.com/guide/script-expressions), which should return a boolean value.","label":"expression","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"elseIf"},{"id":"EndIf","localizable":false,"summary":"Closes an [@if](https://naninovel.com/api/#if) conditional execution block. For usage examples see [conditional execution](https://naninovel.com/guide/naninovel-scripts#conditional-execution) guide.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"endIf"},{"id":"FinishSceneTransition","alias":"finishTrans","localizable":false,"summary":"Finishes scene transition started with [@startTrans](https://naninovel.com/api/#starttrans) command; see the start command reference for more information and usage examples.","parameters":[{"id":"Transition","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"TransitionType"},{"type":1,"subType":"TransitionType"}],"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"TransitionParams","alias":"params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"summary":"Parameters of the transition effect.","label":"params","typeLabel":"decimal list"},{"id":"DissolveTexturePath","alias":"dissolve","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path to the [custom dissolve](https://naninovel.com/guide/transition-effects#custom-transition-effects) texture (path should be relative to a `Resources` folder). Has effect only when the transition is set to `Custom` mode.","label":"dissolve","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the transition.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"finishTrans"},{"id":"SpawnGlitch","alias":"glitch","localizable":false,"summary":"Applies [digital glitch](https://naninovel.com/guide/special-effects.html#digital-glitch) post-processing effect to the main camera simulating digital video distortion and artifacts.","examples":"; Apply the glitch effect with default parameters.\n@glitch\n; Apply the effect over 3.33 seconds with a low intensity.\n@glitch time:3.33 power:0.1","parameters":[{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The duration of the effect, in seconds; default is 1.","label":"time","typeLabel":"decimal"},{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The intensity of the effect, in 0.0 to 10.0 range; default is 1.","label":"power","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"glitch"},{"id":"Gosub","localizable":false,"summary":"Navigates naninovel script playback to the provided path and saves that path to global state; [@return](https://naninovel.com/api/#return) commands use this info to redirect to command after the last invoked gosub command.","remarks":"While this command can be used as a function (subroutine) to invoke a common set of script lines, remember that NaniScript is a scenario scripting DSL and is not suited for general programming. It's strongly recommended to use [custom commands](https://naninovel.com/guide/custom-commands) instead.","examples":"; Navigate to `VictoryScene` label in the currently played script, then\n; execute the commands and navigate back to the command after the `gosub`.\n@gosub .VictoryScene\n...\n@stop\n# VictoryScene\n@back Victory\n@sfx Fireworks\n@bgm Fanfares\nYou are victorious!\n@return\n\n; Another example with some branching inside the subroutine.\n@set time=10\n; Here we get one result.\n@gosub .Room\n...\n@set time=3\n; And here we get another.\n@gosub .Room\n@stop\n# Room\n@print \"It's too early, I should visit after sunset.\" if:time<21&time>6\n@print \"I can sense an ominous presence!\" if:time>21|time<6\n@return","parameters":[{"id":"Path","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":2,"subType":"Scripts"},{"type":1,"subType":"Labels/{:Path[0]??$Script}"}],"summary":"Path to navigate into in the following format: `ScriptName.LabelName`. When label name is omitted, will play provided script from the start. When script name is omitted, will attempt to find a label in the currently played script.","label":"path","typeLabel":"named string"},{"id":"ResetState","alias":"reset","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"When specified, will reset the engine services state before loading a script (in case the path is leading to another script). Specify `*` to reset all the services, or specify service names to exclude from reset. By default, the state does not reset.","label":"reset","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"gosub"},{"id":"Goto","localizable":false,"summary":"Navigates naninovel script playback to the provided path.","examples":"; Loads and starts playing `Script001` script from the start.\n@goto Script001\n\n; Save as above, but start playing from the label `AfterStorm`.\n@goto Script001.AfterStorm\n\n; Navigates to `Epilogue` label in the currently played script.\n@goto .Epilogue\n...\n# Epilogue\n...","parameters":[{"id":"Path","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":2,"subType":"Scripts"},{"type":1,"subType":"Labels/{:Path[0]??$Script}"}],"summary":"Path to navigate into in the following format: `ScriptName.LabelName`. When label name is omitted, will play provided script from the start. When script name is omitted, will attempt to find a label in the currently played script.","label":"path","typeLabel":"named string"},{"id":"ResetState","alias":"reset","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"When specified, will control whether to reset the engine services state before loading a script (in case the path is leading to another script):
- Specify `*` to reset all the services, except the ones with `Goto.DontReset` attribute.
- Specify service type names (separated by comma) to exclude from reset; all the other services will be reset, including the ones with `Goto.DontReset` attribute.
- Specify `-` to force no reset (even if it's enabled by default in the configuration).
Notice, that while some services have `Goto.DontReset` attribute applied and are not reset by default, they should still be specified when excluding specific services from reset.","label":"reset","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"goto"},{"id":"HideActors","alias":"hide","localizable":false,"summary":"Hides (removes) actors (character, background, text printer, choice handler) with the specified IDs. In case multiple actors with the same ID found (eg, a character and a printer), will affect only the first found one.","examples":"; Given an actor with ID `Smoke` is visible, hide it over 3 seconds.\n@hide Smoke time:3\n\n; Hide `Kohaku` and `Yuko` actors.\n@hide Kohaku,Yuko\n\n; Hide and remove `Kohaku` actor.\n@hide Kohaku remove:true","parameters":[{"id":"ActorIds","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":1,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":3,"subType":"*"}],"summary":"IDs of the actors to hide.","label":"actorIds","typeLabel":"string list"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade animation.","label":"time","typeLabel":"decimal"},{"id":"Remove","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to remove (destroy) the actor after it's hidden. Use to unload resources associated with the actor and prevent memory leaks.","label":"remove","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hide"},{"id":"HideAllActors","alias":"hideAll","localizable":false,"summary":"Hides (removes) all the actors (characters, backgrounds, text printers, choice handlers) on scene.","examples":"; Hide all the visible actors (chars, backs, printers, etc) on scene.\n@hideAll\n\n; Same as above, but also remove all the actors after they're hidden.\n@hideAll remove:true","parameters":[{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade animation.","label":"time","typeLabel":"decimal"},{"id":"Remove","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to remove (destroy) the actors after they are hidden. Use to unload resources associated with the actors and prevent memory leaks.","label":"remove","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hideAll"},{"id":"HideAllCharacters","alias":"hideChars","localizable":false,"summary":"Hides (removes) all the visible characters on scene.","examples":"; Hide all the visible character actors on scene.\n@hideChars","parameters":[{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade animation.","label":"time","typeLabel":"decimal"},{"id":"Remove","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to remove (destroy) the characters after they are hidden. Use to unload resources associated with the characters and prevent memory leaks.","label":"remove","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hideChars"},{"id":"HidePrinter","localizable":false,"summary":"Hides a text printer.","examples":"; Hide a default printer.\n@hidePrinter\n\n; Hide printer with ID `Wide`.\n@hidePrinter Wide","parameters":[{"id":"PrinterId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printerId","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the hide animation. Default value for each printer is set in the actor configuration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hidePrinter"},{"id":"HideUI","localizable":false,"summary":"Makes [UI elements](https://naninovel.com/guide/user-interface#ui-customization) with the specified names invisible. When no names are specified, will stop rendering (hide) the entire UI (including all the built-in UIs).","remarks":"When hiding the entire UI with this command and `allowToggle` parameter is false (default), user won't be able to re-show the UI back with hotkeys or by clicking anywhere on the screen; use [@showUI](https://naninovel.com/api/#showui) command to make the UI visible again.","examples":"; Given a custom `Calendar` UI, the following command will hide it.\n@hideUI Calendar\n\n; Hide the entire UI, won't allow user to re-show it.\n@hideUI\n...\n; Make the UI visible again.\n@showUI\n\n; Hide the entire UI, but allow the user to toggle it back.\n@hideUI allowToggle:true\n\n; Simultaneously hide built-in `TipsUI` and custom `Calendar` UIs.\n@hideUI TipsUI,Calendar","parameters":[{"id":"UINames","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"valueContext":[{"type":2,"subType":"UI"},{"type":2,"subType":"UI"}],"summary":"Name of the UI elements to hide.","label":"uINames","typeLabel":"string list"},{"id":"AllowToggle","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"When hiding the entire UI, controls whether to allow the user to re-show the UI with hotkeys or by clicking anywhere on the screen (false by default). Has no effect when hiding a particular UI.","label":"allowToggle","typeLabel":"boolean"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the hide animation. When not specified, will use UI-specific duration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"hideUI"},{"id":"WaitForInput","alias":"i","localizable":false,"summary":"Holds script execution until user activates a `continue` input. Shortcut for `@wait i`.","examples":"; User will have to activate a `continue` input after the first sentence\n; for the printer to continue printing out the following text.\nLorem ipsum dolor sit amet.[i] Consectetur adipiscing elit.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"i"},{"id":"BeginIf","alias":"if","localizable":false,"summary":"Marks the beginning of a conditional execution block. Should always be closed with an [@endif](https://naninovel.com/api/#endif) command. For usage examples see [conditional execution](https://naninovel.com/guide/naninovel-scripts#conditional-execution) guide.","parameters":[{"id":"Expression","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A [script expression](https://naninovel.com/guide/script-expressions), which should return a boolean value.","label":"expression","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"if"},{"id":"InputCustomVariable","alias":"input","localizable":true,"summary":"Shows an input field UI where user can enter an arbitrary text. Upon submit the entered text will be assigned to the specified custom variable.","remarks":"Check out this [video guide](https://youtu.be/F9meuMzvGJw) on usage example.
To assign a display name for a character using this command consider [binding the name to a custom variable](https://naninovel.com/guide/characters.html#display-names).","examples":"; Prompt to enter an arbitrary text and assign it to `name` custom variable.\n@input name summary:\"Choose your name.\"\n; Halt the playback until player submits the input.\n@stop\n\n; You can then inject the assigned `name` variable in naninovel scripts.\nArchibald: Greetings, {name}!\n\n; ...or use it inside set and conditional expressions.\n@set score=score+1 if:name==\"Felix\"","parameters":[{"id":"VariableName","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name of a custom variable to which the entered text will be assigned.","label":"variableName","typeLabel":"string"},{"id":"Summary","nameless":false,"required":false,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"An optional summary text to show along with input field. When the text contain spaces, wrap it in double quotes (`\"`). In case you wish to include the double quotes in the text itself, escape them.","label":"summary","typeLabel":"string"},{"id":"PredefinedValue","alias":"value","nameless":false,"required":false,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"A predefined value to set for the input field.","label":"value","typeLabel":"string"},{"id":"PlayOnSubmit","alias":"play","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to automatically resume script playback when user submits the input form.","label":"play","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"input"},{"id":"LipSync","localizable":false,"summary":"Allows to force-stop the lip sync mouth animation for a character with the provided ID; when stopped, the animation won't start again, until this command is used again to allow it. The character should be able to receive the lip sync events (currently generic, layered and Live2D implementations only). See [characters guide](https://naninovel.com/guide/characters#lip-sync) for more information on lip sync feature.","examples":"; Given auto voicing is disabled and lip sync is driven by text messages,\n; exclude punctuation from the mouth animation.\nKohaku: Lorem ipsum dolor sit amet[lipSync Kohaku.false]... [lipSync Kohaku.true]Consectetur adipiscing elit.","parameters":[{"id":"CharIdAndAllow","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":3,"valueContext":[{"type":3,"subType":"Characters"}],"summary":"Character ID followed by a boolean (true or false) on whether to halt or allow the lip sync animation.","label":"charIdAndAllow","typeLabel":"named boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"lipSync"},{"id":"LoadScene","localizable":false,"summary":"Loads a [Unity scene](https://docs.unity3d.com/Manual/CreatingScenes.html) with the provided name. Don't forget to add the required scenes to the [build settings](https://docs.unity3d.com/Manual/BuildSettings.html) to make them available for loading.","examples":"; Load scene `TestScene1` in single mode.\n@loadScene TestScene1\n\n; Load scene `TestScene2` in additive mode.\n@loadScene TestScene2 additive:true","parameters":[{"id":"SceneName","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name of the scene to load.","label":"sceneName","typeLabel":"string"},{"id":"Additive","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to load the scene additively, or unload any currently loaded scenes before loading the new one (default). See the [load scene documentation](https://docs.unity3d.com/ScriptReference/SceneManagement.SceneManager.LoadScene.html) for more information.","label":"additive","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"loadScene"},{"id":"Lock","localizable":false,"summary":"Sets an [unlockable item](https://naninovel.com/guide/unlockable-items) with the provided ID to `locked` state.","remarks":"The unlocked state of the items is stored in [global scope](https://naninovel.com/guide/state-management#global-state).
In case item with the provided ID is not registered in the global state map, the corresponding record will automatically be added.","examples":"; Lock an unlockable CG record with ID `FightScene1`.\n@lock CG/FightScene1","parameters":[{"id":"Id","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Unlockables"},{"type":2,"subType":"Unlockables"}],"summary":"ID of the unlockable item. Use `*` to lock all the registered unlockable items.","label":"id","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"lock"},{"id":"CameraLook","alias":"look","localizable":false,"summary":"Activates/disables camera look mode, when player can offset the main camera with input devices (eg, by moving a mouse or using gamepad analog stick). Check [this video](https://youtu.be/rC6C9mA7Szw) for a quick demonstration of the command.","remarks":"It's also possible to control the look by rotating a mobile device (in case it has a gyroscope). This requires using Unity's new input system and manually [enabling gyroscope](https://docs.unity3d.com/Packages/com.unity.inputsystem@1.0/manual/Sensors.html) device. Check out [input example project](https://github.com/Naninovel/Input) for a reference on how to setup camera look with gyroscope.","examples":"; Activate camera look mode with default parameters.\n@look\n\n; Activate camera look mode with custom parameters.\n@look zone:6.5,4 speed:3,2.5 gravity:true\n\n; Disable look mode and instantly reset the offset.\n@look false\n\n; Disable look, but reset gradually, with 0.25 speed.\n@look false gravity:true speed:0.25","parameters":[{"id":"Enable","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to enable or disable the camera look mode. Default: true.","label":"enable","typeLabel":"boolean"},{"id":"LookZone","alias":"zone","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y"},{"type":6,"subType":"X,Y"}],"summary":"A bound box with X,Y sizes in units from the initial camera position, describing how far the camera can be moved. Default: 5,3.","label":"zone","typeLabel":"decimal list"},{"id":"LookSpeed","alias":"speed","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y"},{"type":6,"subType":"X,Y"}],"summary":"Camera movement speed (sensitivity) by X,Y axes. Default: 1.5,1.","label":"speed","typeLabel":"decimal list"},{"id":"Gravity","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to automatically move camera to the initial position when the look input is not active (eg, mouse is not moving or analog stick is in default position). Default: false.","label":"gravity","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"look"},{"id":"PlayMovie","alias":"movie","localizable":false,"summary":"Plays a movie with the provided name (path).","remarks":"Will fade-out the screen before playing the movie and fade back in after the play. Playback can be canceled by activating a `cancel` input (`Esc` key by default).","examples":"; Given an `Opening` video clip is added to the movie resources, plays it.\n@movie Opening","parameters":[{"id":"MovieName","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Movies"},{"type":2,"subType":"Movies"}],"summary":"Name of the movie resource to play.","label":"movieName","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the fade animation. When not specified, will use fade duration set in the movie configuration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"movie"},{"id":"OpenURL","localizable":false,"summary":"Opens specified URL (web address) with default web browser.","remarks":"When outside of WebGL or in editor, Unity's `Application.OpenURL` method is used to handle the command; consult the [documentation](https://docs.unity3d.com/ScriptReference/Application.OpenURL.html) for behaviour details and limitations. Under WebGL native `window.open()` JS function is invoked: https://developer.mozilla.org/en-US/docs/Web/API/Window/open.","examples":"; Open blank page in the current tab.\n@openURL \"about:blank\"\n\n; Open Naninovel website in new tab.\n@openURL \"https://naninovel.com\" target:_blank","parameters":[{"id":"URL","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"URL to open.","label":"uRL","typeLabel":"string"},{"id":"Target","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"defaultValue":"_self","summary":"Browsing context: _self (current tab), _blank (new tab), _parent, _top.","label":"target","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"openURL"},{"id":"PrintText","alias":"print","localizable":true,"summary":"Prints (reveals over time) specified text message using a text printer actor.","remarks":"This command is used under the hood when processing generic text lines, eg generic line `Kohaku: Hello World!` will be automatically transformed into `@print \"Hello World!\" author:Kohaku` when parsing the naninovel scripts.
Will reset (clear) the printer before printing the new message by default; set `reset` parameter to *false* or disable `Auto Reset` in the printer actor configuration to prevent that and append the text instead.
Will make the printer default and hide other printers by default; set `default` parameter to *false* or disable `Auto Default` in the printer actor configuration to prevent that.
Will wait for user input before finishing the task by default; set `waitInput` parameter to *false* or disable `Auto Wait` in the printer actor configuration to return as soon as the text is fully revealed.
","examples":"; Will print the phrase with a default printer.\n@print \"Lorem ipsum dolor sit amet.\"\n\n; To include quotes in the text itself, escape them.\n@print \"Shouting \\\"Stop the car!\\\" was a mistake.\"\n\n; Reveal message with half of the normal speed and\n; don't wait for user input to continue.\n@print \"Lorem ipsum dolor sit amet.\" speed:0.5 waitInput:false","parameters":[{"id":"Text","alias":"","nameless":true,"required":true,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"Text of the message to print. When the text contain spaces, wrap it in double quotes (`\"`). In case you wish to include the double quotes in the text itself, escape them.","label":"text","typeLabel":"string"},{"id":"PrinterId","alias":"printer","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printer","typeLabel":"string"},{"id":"AuthorId","alias":"author","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"Characters"},{"type":3,"subType":"Characters"}],"summary":"ID of the actor, which should be associated with the printed message.","label":"author","typeLabel":"string"},{"id":"RevealSpeed","alias":"speed","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Text reveal speed multiplier; should be positive or zero. Setting to one will yield the default speed.","label":"speed","typeLabel":"decimal"},{"id":"ResetPrinter","alias":"reset","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to reset text of the printer before executing the printing task. Default value is controlled via `Auto Reset` property in the printer actor configuration menu.","label":"reset","typeLabel":"boolean"},{"id":"DefaultPrinter","alias":"default","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to make the printer default and hide other printers before executing the printing task. Default value is controlled via `Auto Default` property in the printer actor configuration menu.","label":"default","typeLabel":"boolean"},{"id":"WaitForInput","alias":"waitInput","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to wait for user input after finishing the printing task. Default value is controlled via `Auto Wait` property in the printer actor configuration menu.","label":"waitInput","typeLabel":"boolean"},{"id":"LineBreaks","alias":"br","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":1,"summary":"Number of line breaks to prepend before the printed text. Default value is controlled via `Auto Line Break` property in the printer actor configuration menu.","label":"br","typeLabel":"integer"},{"id":"ChangeVisibilityDuration","alias":"fadeTime","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Controls duration (in seconds) of the printers show and hide animations associated with this command. Default value for each printer is set in the actor configuration.","label":"fadeTime","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"print"},{"id":"ModifyTextPrinter","alias":"printer","localizable":false,"summary":"Modifies a [text printer actor](https://naninovel.com/guide/text-printers).","examples":"; Will make `Wide` printer default and hide any other visible printers.\n@printer Wide\n\n; Will assign `Right` appearance to `Bubble` printer, make is default,\n; position at the center of the scene and won't hide other printers.\n@printer Bubble.Right pos:50,50 hideOther:false","parameters":[{"id":"IdAndAppearance","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":4}],"summary":"ID of the printer to modify and the appearance to set. When ID or appearance are not provided, will use default ones.","label":"idAndAppearance","typeLabel":"named string"},{"id":"MakeDefault","alias":"default","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to make the printer the default one. Default printer will be subject of all the printer-related commands when `printer` parameter is not specified.","label":"default","typeLabel":"boolean"},{"id":"HideOther","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to hide all the other printers.","label":"hideOther","typeLabel":"boolean"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the modified actor. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Id","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"ID of the actor to modify; specify `*` to affect all visible actors.","label":"id","typeLabel":"string"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":4},{"type":4}],"summary":"Appearance to set for the modified actor.","label":"appearance","typeLabel":"string"},{"id":"Pose","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Pose to set for the modified actor.","label":"pose","typeLabel":"string"},{"id":"Transition","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"TransitionType"},{"type":1,"subType":"TransitionType"}],"summary":"Type of the [transition effect](https://naninovel.com/guide/transition-effects) to use (crossfade is used by default).","label":"transition","typeLabel":"string"},{"id":"TransitionParams","alias":"params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"summary":"Parameters of the transition effect.","label":"params","typeLabel":"decimal list"},{"id":"DissolveTexturePath","alias":"dissolve","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Path to the [custom dissolve](https://naninovel.com/guide/transition-effects#custom-transition-effects) texture (path should be relative to a `Resources` folder). Has effect only when the transition is set to `Custom` mode.","label":"dissolve","typeLabel":"string"},{"id":"Visible","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Visibility status to set for the modified actor.","label":"visible","typeLabel":"boolean"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the modified actor. Use Z-component (third member) to move (sort) by depth while in ortho mode.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the modified actor.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the modified actor.","label":"scale","typeLabel":"decimal list"},{"id":"TintColor","alias":"tint","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":5,"subType":""},{"type":5,"subType":""}],"summary":"Tint color to set for the modified actor.
Strings that begin with `#` will be parsed as hexadecimal in the following way: `#RGB` (becomes RRGGBB), `#RRGGBB`, `#RGBA` (becomes RRGGBBAA), `#RRGGBBAA`; when alpha is not specified will default to FF.
Strings that do not begin with `#` will be parsed as literal colors, with the following supported: red, cyan, blue, darkblue, lightblue, purple, yellow, lime, fuchsia, white, silver, grey, black, orange, brown, maroon, green, olive, navy, teal, aqua, magenta.","label":"tint","typeLabel":"string"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modification.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"printer"},{"id":"ProcessInput","localizable":false,"summary":"Allows halting and resuming user input processing (eg, reacting to pressing keyboard keys). The effect of the action is persistent and saved with the game.","examples":"; Halt input processing of all the samplers.\n@processInput false\n\n; Resume input processing of all the samplers.\n@processInput true\n\n; Mute `Rollback` and `Pause` inputs and un-mute `Continue` input.\n@processInput set:Rollback.false,Pause.false,Continue.true","parameters":[{"id":"InputEnabled","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to enable input processing of all the samplers.","label":"inputEnabled","typeLabel":"boolean"},{"id":"SetEnabled","alias":"set","nameless":false,"required":false,"localizable":false,"valueContainerType":3,"valueType":3,"summary":"Allows muting and un-muting individual input samplers.","label":"set","typeLabel":"named boolean list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"processInput"},{"id":"PurgeRollback","localizable":false,"summary":"Prevents player from rolling back to the previous state snapshots.","examples":"; Prevent player from rolling back to try picking another choice.\n\nPick a choice. You won't be able to rollback.\n@choice One goto:.One\n@choice Two goto:.Two\n@stop\n\n# One\n@purgeRollback\nYou've picked one.\n@stop\n\n# Two\n@purgeRollback\nYou've picked two.\n@stop","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"purgeRollback"},{"id":"SpawnRain","alias":"rain","localizable":false,"summary":"Spawns particle system simulating [rain](https://naninovel.com/guide/special-effects.html#rain).","examples":"; Start intensive rain over 10 seconds.\n@rain power:1500 time:10\n; Stop the rain over 30 seconds.\n@rain power:0 time:30","parameters":[{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The intensity of the rain (particles spawn rate per second); defaults to 500. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"FadeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The particle system will gradually grow the spawn rate to the target level over the specified time, in seconds.","label":"time","typeLabel":"decimal"},{"id":"XVelocity","alias":"xSpeed","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Multiplier to the horizontal speed of the particles. Use to change angle of the rain drops.","label":"xSpeed","typeLabel":"decimal"},{"id":"YVelocity","alias":"ySpeed","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Multiplier to the vertical speed of the particles.","label":"ySpeed","typeLabel":"decimal"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the spawned effect game object. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the spawned effect game object.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the spawned effect game object.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the spawned effect game object.","label":"scale","typeLabel":"decimal list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"rain"},{"id":"ResetState","localizable":false,"summary":"Resets state of the [engine services](https://naninovel.com/guide/engine-services) and unloads (disposes) all the resources loaded by Naninovel (textures, audio, video, etc); will basically revert to an empty initial engine state.","remarks":"The process is asynchronous and is masked with a loading screen ([ILoadingUI](https://naninovel.com/guide/user-interface#ui-customization)).
Be aware, that this command can not be undone (rewound back).","examples":"; Reset all the services (script will stop playing).\n@resetState\n\n; Reset all the services except script player, custom variable and\n; audio managers, allowing current script and audio tracks\n; continue playing and preserving values of the custom variables.\n@resetState IScriptPlayer,ICustomVariableManager,IAudioManager\n\n; Reset only `ICharacterManager` and `IBackgroundManager` services\n; removing all the character and background actors from scene\n; and unloading associated resources from memory.\n@resetState only:ICharacterManager,IBackgroundManager","parameters":[{"id":"Exclude","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Names of the [engine services](https://naninovel.com/guide/engine-services) (interfaces) to exclude from reset. Consider adding `ICustomVariableManager` to preserve the local variables.","label":"exclude","typeLabel":"string list"},{"id":"Only","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Names of the [engine services](https://naninovel.com/guide/engine-services) (interfaces) to reset; other services won't be affected. Doesn't have effect when the nameless (exclude) parameter is assigned.","label":"only","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"resetState"},{"id":"ResetText","localizable":false,"summary":"Resets (clears) the contents of a text printer and optionally resets author ID.","examples":"; Print and then clear contents of the default printer.\nThis line will disappear.\n@resetText\n\n; Same as above, but with `Wide` printer.\n@print \"This line will disappear.\" printer:Wide\n@resetText Wide","parameters":[{"id":"PrinterId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printerId","typeLabel":"string"},{"id":"ResetAuthor","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to also reset author of the currently printed text message.","label":"resetAuthor","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"resetText"},{"id":"Return","localizable":false,"summary":"Attempts to navigate naninovel script playback to a command after the last used [@gosub](https://naninovel.com/api/#gosub). See [@gosub](https://naninovel.com/api/#gosub) command summary for more info and usage examples.","parameters":[{"id":"ResetState","alias":"reset","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"When specified, will reset the engine services state before returning to the initial script from which the gosub was entered (in case it's not the currently played script). Specify `*` to reset all the services, or specify service names to exclude from reset. By default, the state does not reset.","label":"reset","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"return"},{"id":"AutoSave","alias":"save","localizable":false,"summary":"Automatically save the game to a quick save slot.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"save"},{"id":"SetCustomVariable","alias":"set","localizable":false,"summary":"Assigns result of a [script expression](https://naninovel.com/guide/script-expressions) to a [custom variable](https://naninovel.com/guide/custom-variables).","remarks":"If a variable with the provided name doesn't exist, it will be automatically created.
It's possible to define multiple set expressions in one line by separating them with `;`. The expressions will be executed in sequence by the order of declaration.
In case variable name starts with `T_` or `t_` it's considered a reference to a value stored in 'Script' [managed text](https://naninovel.com/guide/managed-text) document. Such variables can't be assigned and mostly used for referencing localizable text values.","examples":"; Assign `foo` variable a `bar` string value.\n@set foo=\"bar\"\n\n; Assign `foo` variable a 1 number value.\n@set foo=1\n\n; Assign `foo` variable a `true` boolean value.\n@set foo=true\n\n; If `foo` is a number, add 0.5 to its value.\n@set foo+=0.5\n\n; If `angle` is a number, assign its cosine to `foo` variable.\n@set foo=Cos(angle)\n\n; Get random number between -100 and 100, then raise to power of 4 \n; and assign to `foo` variable. Quotes are required when whitespace \n; is present inside the expression.\n@set \"foo = Pow(Random(-100, 100), 4)\"\n\n; If `foo` is a number, add 1 to its value (increment).\n@set foo++\n\n; If `foo` is a number, subtract 1 from its value (decrement).\n@set foo--\n\n; Assign `foo` variable value of the `bar` variable, \n; which is `Hello World!` string.\n@set bar=\"Hello World!\"\n@set foo=bar\n\n; Defining multiple set expressions in one line; \n; the result will be the same as above.\n@set bar=\"Hello World!\";foo=bar\n\n; It's possible to inject variables to naninovel script command parameters.\n@set scale=0\n# EnlargeLoop\n@char Kohaku.Default scale:{scale}\n@set scale+=0.1\n@goto .EnlargeLoop if:scale<1\n\n; ...and generic text lines.\n@set drink=\"Dr. Pepper\"\nMy favourite drink is {drink}!\n\n; When using double quotes inside text expression value, escape them.\n@set remark=\"Shouting \\\"Stop the car!\\\" was a mistake.\"\n\n; Use global variable to indicate player reaching `Ending 001`.\n; The variable will remain true even when the game is restarted.\n@set g_Ending001Reached=true\n\n; Increment the global variable only once, even when re-played.\n@set g_GlobalCounter++ if:!HasPlayed()","parameters":[{"id":"Expression","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"Set expression.
The expression should be in the following format: `VariableName=ExpressionBody`, where `VariableName` is the name of the custom variable to assign and `ExpressionBody` is a [script expression](https://naninovel.com/guide/script-expressions), the result of which should be assigned to the variable.
It's also possible to use increment and decrement unary operators (`@set foo++`, `@set foo--`) and compound assignment (`@set foo+=10`, `@set foo-=3`, `@set foo*=0.1`, `@set foo/=2`).","label":"expression","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"set"},{"id":"PlaySfx","alias":"sfx","localizable":false,"summary":"Plays or modifies currently played [SFX (sound effect)](https://naninovel.com/guide/audio#sound-effects) track with the provided name.","remarks":"Sound effect tracks are not looped by default. When sfx track name (SfxPath) is not specified, will affect all the currently played tracks. When invoked for a track that is already playing, the playback won't be affected (track won't start playing from the start), but the specified parameters (volume and whether the track is looped) will be applied.","examples":"; Plays an SFX with the name `Explosion` once.\n@sfx Explosion\n\n; Plays an SFX with the name `Rain` in a loop and fades-in over 30 seconds.\n@sfx Rain loop:true fade:30\n\n; Changes volume of all the played SFX tracks to 75% over 2.5 seconds\n; and disables looping for all of them.\n@sfx volume:0.75 loop:false time:2.5","parameters":[{"id":"SfxPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the sound effect asset to play.","label":"sfxPath","typeLabel":"string"},{"id":"Volume","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Volume of the sound effect.","label":"volume","typeLabel":"decimal"},{"id":"Loop","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"false","summary":"Whether to play the sound effect in a loop.","label":"loop","typeLabel":"boolean"},{"id":"FadeInDuration","alias":"fade","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0","summary":"Duration of the volume fade-in when starting playback, in seconds (0.0 by default); doesn't have effect when modifying a playing track.","label":"fade","typeLabel":"decimal"},{"id":"GroupPath","alias":"group","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Audio mixer [group path](https://docs.unity3d.com/ScriptReference/Audio.AudioMixer.FindMatchingGroups) that should be used when playing the audio.","label":"group","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the modification.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"sfx"},{"id":"PlaySfxFast","alias":"sfxFast","localizable":false,"summary":"Plays an [SFX (sound effect)](https://naninovel.com/guide/audio#sound-effects) track with the provided name. Unlike [@sfx](https://naninovel.com/api/#sfx) command, the clip is played with minimum delay and is not serialized with the game state (won't be played after loading a game, even if it was played when saved). The command can be used to play various transient audio clips, such as UI-related sounds (eg, on button click with [`Play Script` component](https://naninovel.com/guide/user-interface#play-script-on-unity-event)).","examples":"; Plays an SFX with the name `Click` once.\n@sfxFast Click\n\n; Same as above, but allow concurrent playbacks of the same clip.\n@sfxFast Click restart:false","parameters":[{"id":"SfxPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the sound effect asset to play.","label":"sfxPath","typeLabel":"string"},{"id":"Volume","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Volume of the sound effect.","label":"volume","typeLabel":"decimal"},{"id":"Restart","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to start playing the audio from start in case it's already playing.","label":"restart","typeLabel":"boolean"},{"id":"Additive","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to allow playing multiple instances of the same clip; has no effect when `restart` is enabled.","label":"additive","typeLabel":"boolean"},{"id":"GroupPath","alias":"group","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Audio mixer [group path](https://docs.unity3d.com/ScriptReference/Audio.AudioMixer.FindMatchingGroups) that should be used when playing the audio.","label":"group","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"sfxFast"},{"id":"SpawnShake","alias":"shake","localizable":false,"summary":"Applies [shake effect](https://naninovel.com/guide/special-effects.html#shake) for the actor with the specified ID or main camera.","examples":"; Shake `Dialogue` text printer with default params.\n@shake Dialogue\n;\n; Start shaking `Kohaku` character, show choice to stop and act accordingly.\n@shake Kohaku count:0 wait:false\n@choice \"Continue shaking\" goto:.Continue\n@choice \"Stop shaking\" goto:.Stop\n@stop\n# Stop\n@shake Kohaku count:-1\n# Continue\n...\n\n; Shake main Naninovel camera horizontally 5 times.\n@shake Camera count:5 hor:true ver:false","parameters":[{"id":"ActorId","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":3,"subType":"*"}],"summary":"ID of the actor to shake. In case multiple actors with the same ID found (eg, a character and a printer), will affect only the first found one. To shake main camera, use \"Camera\" keyword.","label":"actorId","typeLabel":"string"},{"id":"ShakeCount","alias":"count","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":1,"summary":"The number of shake iterations. When set to 0, will loop until stopped with -1.","label":"count","typeLabel":"integer"},{"id":"ShakeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The base duration of each shake iteration, in seconds.","label":"time","typeLabel":"decimal"},{"id":"DurationVariation","alias":"deltaTime","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The randomizer modifier applied to the base duration of the effect.","label":"deltaTime","typeLabel":"decimal"},{"id":"ShakeAmplitude","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The base displacement amplitude of each shake iteration, in units.","label":"power","typeLabel":"decimal"},{"id":"AmplitudeVariation","alias":"deltaPower","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The randomized modifier applied to the base displacement amplitude.","label":"deltaPower","typeLabel":"decimal"},{"id":"ShakeHorizontally","alias":"hor","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to displace the actor horizontally (by x-axis).","label":"hor","typeLabel":"boolean"},{"id":"ShakeVertically","alias":"ver","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether to displace the actor vertically (by y-axis).","label":"ver","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"shake"},{"id":"ShowActors","alias":"show","localizable":false,"summary":"Shows (makes visible) actors (character, background, text printer, choice handler, etc) with the specified IDs. In case multiple actors with the same ID found (eg, a character and a printer), will affect only the first found one.","examples":"; Given an actor with ID `Smoke` is hidden, reveal it over 3 seconds.\n@show Smoke time:3\n\n; Show `Kohaku` and `Yuko` actors.\n@show Kohaku,Yuko","parameters":[{"id":"ActorIds","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":1,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":3,"subType":"*"}],"summary":"IDs of the actors to show.","label":"actorIds","typeLabel":"string list"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the fade animation.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"show"},{"id":"ShowPrinter","localizable":false,"summary":"Shows a text printer.","examples":"; Show a default printer.\n@showPrinter\n\n; Show printer with ID `Wide`.\n@showPrinter Wide","parameters":[{"id":"PrinterId","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printerId","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the show animation. Default value for each printer is set in the actor configuration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"showPrinter"},{"id":"ShowUI","localizable":false,"summary":"Makes [UI elements](https://naninovel.com/guide/user-interface) with the specified resource names visible. When no names are specified, will reveal the entire UI (in case it was hidden with [@hideUI](https://naninovel.com/api/#hideui)).","examples":"; Given you've added a custom UI with `Calendar` name,\n; the following will make it visible on the scene.\n@showUI Calendar\n\n; Given you've hidden the entire UI with @hideUI, show it back.\n@showUI\n\n; Simultaneously reveal built-in `TipsUI` and custom `Calendar` UIs.\n@showUI TipsUI,Calendar","parameters":[{"id":"UINames","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"valueContext":[{"type":2,"subType":"UI"},{"type":2,"subType":"UI"}],"summary":"Name of the UI resource to make visible.","label":"uINames","typeLabel":"string list"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Duration (in seconds) of the show animation. When not specified, will use UI-specific duration.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"showUI"},{"id":"Skip","localizable":false,"summary":"Allows to enable or disable script player \"skip\" mode.","examples":"; Enable skip mode.\n@skip\n\n; Disable skip mode.\n@skip false","parameters":[{"id":"Enable","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"defaultValue":"true","summary":"Whether to enable (default) or disable the skip mode.","label":"enable","typeLabel":"boolean"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"skip"},{"id":"SkipInput","localizable":false,"summary":"Can be used in generic text lines to prevent activating `wait for input` mode when the text is printed.","examples":"; Script player won't wait for continue input before executing @sfx command.\nAnd the rain starts.[skipInput]\n@sfx Rain","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"skipInput"},{"id":"SlideActor","alias":"slide","localizable":false,"summary":"Slides (moves between two positions) an actor (character, background, text printer or choice handler) with the provided ID and optionally changes actor visibility and appearance. Can be used instead of multiple [@char](https://naninovel.com/api/#char) or [@back](https://naninovel.com/api/#back) commands to reveal or hide an actor with a slide animation.","remarks":"Be aware, that this command searches for an existing actor with the provided ID over all the actor managers, and in case multiple actors with the same ID exist (eg, a character and a text printer), this will affect only the first found one. Make sure the actor exist on scene before referencing it with this command; eg, if it's a character, you can add it on scene imperceptibly to player with `@char CharID visible:false time:0`.","examples":"; Given `Jenna` actor is not visible, reveal it with an `Angry` appearance\n; and slide to the center from either left or right border of the scene.\n@slide Jenna.Angry to:50\n\n; Given `Sheba` actor is currently visible,\n; hide and slide it out of the scene over the left border.\n@slide Sheba to:-10 visible:false\n\n\n; Slide `Mia` actor from left-center side of the scene to the right-bottom\n; over 5 seconds using `EaseOutBounce` animation easing.\n@slide Sheba from:15,50 to:85,0 time:5 easing:EaseOutBounce","parameters":[{"id":"IdAndAppearance","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":2,"valueType":0,"valueContext":[{"type":3,"subType":"*"},{"type":4}],"summary":"ID of the actor to slide and (optionally) appearance to set.","label":"idAndAppearance","typeLabel":"named string"},{"id":"FromPosition","alias":"from","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position in scene space to slide the actor from (slide start position). Described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene; Z-component (depth) is in world space. When not provided, will use current actor position in case it's visible and a random off-scene position otherwise (could slide-in from left or right borders).","label":"from","typeLabel":"decimal list"},{"id":"ToPosition","alias":"to","nameless":false,"required":true,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position in scene space to slide the actor to (slide finish position).","label":"to","typeLabel":"decimal list"},{"id":"Visible","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Change visibility status of the actor (show or hide). When not set and target actor is hidden, will still automatically show it.","label":"visible","typeLabel":"boolean"},{"id":"EasingTypeName","alias":"easing","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":1,"subType":"EasingType"},{"type":1,"subType":"EasingType"}],"summary":"Name of the easing function to use for the modifications.
Available options: Linear, SmoothStep, Spring, EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic, EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart, EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint, EaseInSine, EaseOutSine, EaseInOutSine, EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc, EaseOutCirc, EaseInOutCirc, EaseInBounce, EaseOutBounce, EaseInOutBounce, EaseInBack, EaseOutBack, EaseInOutBack, EaseInElastic, EaseOutElastic, EaseInOutElastic.
When not specified, will use a default easing function set in the actor's manager configuration settings.","label":"easing","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration (in seconds) of the slide animation.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"slide"},{"id":"SpawnSnow","alias":"snow","localizable":false,"summary":"Spawns particle system simulating [snow](https://naninovel.com/guide/special-effects.html#snow).","examples":"; Start intensive snow over 10 seconds.\n@snow power:300 time:10\n; Stop the snow over 30 seconds.\n@snow power:0 time:30","parameters":[{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The intensity of the snow (particles spawn rate per second); defaults to 100. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"FadeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The particle system will gradually grow the spawn rate to the target level over the specified time, in seconds.","label":"time","typeLabel":"decimal"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the spawned effect game object. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the spawned effect game object.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the spawned effect game object.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the spawned effect game object.","label":"scale","typeLabel":"decimal list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"snow"},{"id":"Spawn","localizable":false,"summary":"Instantiates a prefab or a [special effect](https://naninovel.com/guide/special-effects); when performed over an already spawned object, will update the spawn parameters instead.","remarks":"If prefab has a `MonoBehaviour` component attached the root object, and the component implements a `IParameterized` interface, will pass the specified `params` values after the spawn; if the component implements `IAwaitable` interface, command execution will wait for the async completion task returned by the implementation.","examples":"; Given a `Rainbow` prefab is assigned in spawn resources, instantiate it.\n@spawn Rainbow","parameters":[{"id":"Path","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Spawn"},{"type":2,"subType":"Spawn"}],"summary":"Name (path) of the prefab resource to spawn.","label":"path","typeLabel":"string"},{"id":"Params","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Parameters to set when spawning the prefab. Requires the prefab to have a `IParameterized` component attached the root object.","label":"params","typeLabel":"string list"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the spawned object. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the spawned object.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the spawned object.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the spawned object.","label":"scale","typeLabel":"decimal list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"spawn"},{"id":"StartSceneTransition","alias":"startTrans","localizable":false,"summary":"Begins scene transition masking the real scene content with anything that is visible at the moment (except the UI). When the new scene is ready, finish with [@finishTrans](https://naninovel.com/api/#finishtrans) command.","remarks":"The UI will be hidden and user input blocked while the transition is in progress. You can change that by overriding the `ISceneTransitionUI`, which handles the transition process.
For the list of available transition effect options see [transition effects](https://naninovel.com/guide/transition-effects) guide.","examples":"; Transition Felix on sunny day with Jenna on rainy day.\n@char Felix\n@back SunnyDay\n@spawn SunShafts\n@startTrans\n; Following modifications won't be visible until the transition is finished.\n@hideChars time:0\n@char Jenna time:0\n@back RainyDay time:0\n@despawn SunShafts params:0\n@spawn Rain params:,0\n; Transition the initially captured scene to the new one\n; with `DropFade` effect over 3 seconds.\n@finishTrans DropFade time:3","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"startTrans"},{"id":"Stop","localizable":false,"summary":"Stops the naninovel script execution.","examples":"Show the choices and halt script execution until the player picks one.\n@choice \"Choice 1\"\n@choice \"Choice 2\"\n@stop\nWe'll get here after player will make a choice.","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"stop"},{"id":"StopBgm","localizable":false,"summary":"Stops playing a BGM (background music) track with the provided name.","remarks":"When music track name (BgmPath) is not specified, will stop all the currently played tracks.","examples":"; Fades-out `Sanctuary` bgm track over 10 seconds and stops the playback.\n@stopBgm Sanctuary fade:10\n\n; Stops all the currently played music tracks.\n@stopBgm","parameters":[{"id":"BgmPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the music track to stop.","label":"bgmPath","typeLabel":"string"},{"id":"FadeOutDuration","alias":"fade","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration of the volume fade-out before stopping playback, in seconds (0.35 by default).","label":"fade","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"stopBgm"},{"id":"StopSfx","localizable":false,"summary":"Stops playing an SFX (sound effect) track with the provided name.","remarks":"When sound effect track name (SfxPath) is not specified, will stop all the currently played tracks.","examples":"; Stop playing an SFX with the name `Rain`, fading-out for 15 seconds.\n@stopSfx Rain fade:15\n\n; Stops all the currently played sound effect tracks.\n@stopSfx","parameters":[{"id":"SfxPath","alias":"","nameless":true,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Audio"},{"type":2,"subType":"Audio"}],"summary":"Path to the sound effect to stop.","label":"sfxPath","typeLabel":"string"},{"id":"FadeOutDuration","alias":"fade","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"0.35","summary":"Duration of the volume fade-out before stopping playback, in seconds (0.35 by default).","label":"fade","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"stopSfx"},{"id":"StopVoice","localizable":false,"summary":"Stops playback of the currently played voice clip.","examples":"; Given a voice is being played, stop it.\n@stopVoice","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"stopVoice"},{"id":"SetTextStyle","alias":"style","localizable":false,"summary":"Permanently applies [text styles](https://naninovel.com/guide/text-printers#text-styles) to the contents of a text printer.","remarks":"You can also use rich text tags inside text messages to apply the styles selectively.","examples":"; Print first two sentences in bold red text with 45px size,\n; then reset the style and print the last sentence using default style.\n@style color=#ff0000,b,size=45\nLorem ipsum dolor sit amet.\nCras ut nisi eget ex viverra egestas in nec magna.\n@style default\nConsectetur adipiscing elit.\n\n; Print starting part of the sentence normally, but the last one in bold.\nLorem ipsum sit amet. Consectetur adipiscing elit.","parameters":[{"id":"TextStyles","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Text formatting tags to apply. Angle brackets should be omitted, eg use `b` for `` and `size=100` for ``. Use `default` keyword to reset the style.","label":"textStyles","typeLabel":"string list"},{"id":"PrinterId","alias":"printer","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":3,"subType":"TextPrinters"},{"type":3,"subType":"TextPrinters"}],"summary":"ID of the printer actor to use. Will use a default one when not provided.","label":"printer","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"style"},{"id":"SpawnSun","alias":"sun","localizable":false,"summary":"Spawns particle system simulating [sun shafts](https://naninovel.com/guide/special-effects.html#sun-shafts) aka god rays.","examples":"; Start intensive sunshine over 10 seconds.\n@sun power:1 time:10\n; Stop the sunshine over 30 seconds.\n@sun power:0 time:30","parameters":[{"id":"Intensity","alias":"power","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The intensity of the rays (opacity), in 0.0 to 1.0 range; default is 0.85. Set to 0 to disable (de-spawn) the effect.","label":"power","typeLabel":"decimal"},{"id":"FadeDuration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"The particle system will gradually grow the spawn rate to the target level over the specified time, in seconds.","label":"time","typeLabel":"decimal"},{"id":"ScenePosition","alias":"pos","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (relative to the scene borders, in percents) to set for the spawned effect game object. Position is described as follows: `0,0` is the bottom left, `50,50` is the center and `100,100` is the top right corner of the scene. Use Z-component (third member, eg `,,10`) to move (sort) by depth while in ortho mode.","label":"pos","typeLabel":"decimal list"},{"id":"Position","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Position (in world space) to set for the spawned effect game object.","label":"position","typeLabel":"decimal list"},{"id":"Rotation","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Rotation to set for the spawned effect game object.","label":"rotation","typeLabel":"decimal list"},{"id":"Scale","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":2,"valueContext":[{"type":6,"subType":"X,Y,Z"},{"type":6,"subType":"X,Y,Z"}],"summary":"Scale to set for the spawned effect game object.","label":"scale","typeLabel":"decimal list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"sun"},{"id":"ExitToTitle","alias":"title","localizable":false,"summary":"Resets engine state and shows `ITitleUI` UI (main menu).","examples":"; Exit to title UI, no matter which script is playing.\n@title","parameters":[{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"title"},{"id":"ShowToastUI","alias":"toast","localizable":true,"summary":"Shows a UI for general-purpose self-hiding popup notification (aka \"toast\") with the provided text and (optionally) appearance and duration. The UI is automatically hidden after the specified (or default) duration.","remarks":"Appearance name is the name of a game object with `Toast Appearance` component inside the `ToastUI` UI prefab (case-insensitive).","examples":"; Shows a default toast with `Hello World!` content.\n@toast \"Hello World!\"\n\n; Shows a toast with a `warning` appearance.\n@toast \"You're in danger!\" appearance:warning\n\n; The toast will disappear in one second.\n@toast \"I'll disappear in 1 second.\" time:1","parameters":[{"id":"Text","alias":"","nameless":true,"required":false,"localizable":true,"valueContainerType":0,"valueType":0,"summary":"The text content to set for the toast.","label":"text","typeLabel":"string"},{"id":"Appearance","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Appearance variant (game object name) of the toast. When not specified, will use default appearance set in Toast UI prefab.","label":"appearance","typeLabel":"string"},{"id":"Duration","alias":"time","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"summary":"Seconds to wait before hiding the toast. When not specified, will use duration set by default in Toast UI prefab.","label":"time","typeLabel":"decimal"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"toast"},{"id":"UnloadScene","localizable":false,"summary":"Unloads a [Unity scene](https://docs.unity3d.com/Manual/CreatingScenes.html) with the provided name. Don't forget to add the required scenes to the [build settings](https://docs.unity3d.com/Manual/BuildSettings.html) to make them available for loading. Be aware, that only scenes loaded additively can be then unloaded (at least one scene should always remain loaded).","examples":"; Load scene `TestScene2` in additive mode and then unload it.\n@loadScene TestScene2 additive:true\n@unloadScene TestScene2","parameters":[{"id":"SceneName","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Name of the scene to unload.","label":"sceneName","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"unloadScene"},{"id":"Unlock","localizable":false,"summary":"Sets an [unlockable item](https://naninovel.com/guide/unlockable-items) with the provided ID to `unlocked` state.","remarks":"The unlocked state of the items is stored in [global scope](https://naninovel.com/guide/state-management#global-state).
In case item with the provided ID is not registered in the global state map, the corresponding record will automatically be added.","examples":"; Unlocks an unlockable CG record with ID `FightScene1`.\n@unlock CG/FightScene1","parameters":[{"id":"Id","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Unlockables"},{"type":2,"subType":"Unlockables"}],"summary":"ID of the unlockable item. Use `*` to unlock all the registered unlockable items.","label":"id","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"unlock"},{"id":"PlayVoice","alias":"voice","localizable":false,"summary":"Plays a voice clip at the provided path.","examples":"; Given a `Rawr` voice resource is available, play it.\n@voice Rawr","parameters":[{"id":"VoicePath","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":2,"subType":"Voice"},{"type":2,"subType":"Voice"}],"summary":"Path to the voice clip to play.","label":"voicePath","typeLabel":"string"},{"id":"Volume","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":2,"defaultValue":"1","summary":"Volume of the playback.","label":"volume","typeLabel":"decimal"},{"id":"GroupPath","alias":"group","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Audio mixer [group path](https://docs.unity3d.com/ScriptReference/Audio.AudioMixer.FindMatchingGroups) that should be used when playing the audio.","label":"group","typeLabel":"string"},{"id":"AuthorId","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"ID of the character actor this voice belongs to. When provided and [per-author volume](https://naninovel.com/guide/voicing#author-volume) is used, volume will be adjusted accordingly.","label":"authorId","typeLabel":"string"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"voice"},{"id":"Wait","localizable":false,"summary":"Holds script execution until the specified wait condition.","examples":"; Thunder SFX will play 0.5 seconds after shake background effect finishes.\n@spawn ShakeBackground\n@wait 0.5\n@sfx Thunder\n\n; Print first 2 words, then wait for input before printing the rest.\nLorem ipsum[wait i] dolor sit amet.\n; You can also use the following shortcut (@i command) for this wait mode.\nLorem ipsum[i] dolor sit amet.\n\n; Start looped SFX, print message and wait for a skippable 5 seconds delay,\n; then stop the SFX.\n@sfx Noise loop:true\nJeez, what a disgusting noise. Shut it down![wait i5][skipInput]\n@stopSfx Noise\n\n; The text is printed without delay, as the `wait` command is not awaited.\n; The thunder effects are played after a random delay of 3 to 8 seconds.\n@wait {Random(3,8)} do:\"@sfx Thunder, @shake Camera\" wait:false\nThe thunder might go off any second...","parameters":[{"id":"WaitMode","alias":"","nameless":true,"required":true,"localizable":false,"valueContainerType":0,"valueType":0,"summary":"Wait conditions:
- `i` user press continue or skip input key;
- `0.0` timer (seconds);
- `i0.0` timer, that is skip-able by continue or skip input keys.","label":"waitMode","typeLabel":"string"},{"id":"OnFinished","alias":"do","nameless":false,"required":false,"localizable":false,"valueContainerType":1,"valueType":0,"summary":"Script commands to execute when the wait is over. Escape commas inside list values to prevent them being treated as delimiters.","label":"do","typeLabel":"string list"},{"id":"Wait","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":3,"summary":"Whether the script player should wait for the async command execution before playing next command.","label":"wait","typeLabel":"boolean"},{"id":"ConditionalExpression","alias":"if","nameless":false,"required":false,"localizable":false,"valueContainerType":0,"valueType":0,"valueContext":[{"type":0},{"type":0}],"summary":"A boolean [script expression](https://naninovel.com/guide/script-expressions), controlling whether this command should execute.","label":"if","typeLabel":"string"}],"label":"wait"}],"resources":[],"constants":[{"name":"TransitionType","values":["Crossfade","BandedSwirl","Blinds","CircleReveal","CircleStretch","CloudReveal","Crumble","Dissolve","DropFade","LineReveal","Pixelate","RadialBlur","RadialWiggle","RandomCircleReveal","Ripple","RotateCrumble","Saturate","Shrink","SlideIn","SwirlGrid","Swirl","Water","Waterfall","Wave","Custom"]},{"name":"EasingType","values":["Linear","SmoothStep","Spring","EaseInQuad","EaseOutQuad","EaseInOutQuad","EaseInCubic","EaseOutCubic","EaseInOutCubic","EaseInQuart","EaseOutQuart","EaseInOutQuart","EaseInQuint","EaseOutQuint","EaseInOutQuint","EaseInSine","EaseOutSine","EaseInOutSine","EaseInExpo","EaseOutExpo","EaseInOutExpo","EaseInCirc","EaseOutCirc","EaseInOutCirc","EaseInBounce","EaseOutBounce","EaseInOutBounce","EaseInBack","EaseOutBack","EaseInOutBack","EaseInElastic","EaseOutElastic","EaseInOutElastic"]},{"name":"CharacterLookDirection","values":["Center","Left","Right"]}],"variables":[],"functions":["Random","CalculateProgress","IsUnlocked","HasPlayed","GetName"]}
\ No newline at end of file