Action reference
|
Story
Displays a paragraph of dialogue in the designated dialogue text object.
| Property | Description |
| Name (optional) | Name of the person talking. |
| Phrase | The phrase/paragraph that should be presented. |
| Append | Check to append existing dialogue, rather than replacing it. |
| On new line | Check to makes sure the appended text is on a new line. |
| Vocal audio asset (optional) | Audio to be played when this paragraph is spoken |
| Volume | Audio volume |
| Balance | Audio balance |
Halt the execution of actions for a set duration of time or until player presses a button.
| Property | Description |
| Wait | Waiting mode. [Timed, Forever, Until mouse button is clicked, Until video ends] |
| Time (sec) | Duration (in seconds) for which the wait will occur. |
| Allow skipping | Allow the player to skip through by clicking or pressing a key. |
Display an interactive menu to the player and act on their selection.
| Property | Description |
| Menu template | Menu asset which will be used to display the menu. |
| Number of options | Number of options to display [2..8] |
| [Option] Phrase | Text phrase for this option |
| [Option] Condition (optional) | Condition for when this option is enabled. |
Change the current page's background image.
| Property | Description |
| Background image | Texture asset to use as background. |
| Fade | Fade in the new background. |
| Time (sec) | Duration (in seconds) of the fade. |
| Wait to complete | Wait for this action to complete before triggering the next. |
Conditional story branch. Act on a condition being true or false.
| Property | Description |
| Condition | Condition to evaluate. |
| When true | Action to perform if the condition is true. |
| When false | Action to perform if the condition is false. |
Make an actor appear in the scene. Once the actor has been instantiated, it can be manipulated by other actions like any other object.
| Property | Description |
| Actor | Actor to enter. |
| Location | Where in the scene the actor should appear. |
| Target layer | The layer in which the actor object should be placed. |
| Fade in | Fade in the actor object. |
| Slide | Slide in the actor object. |
| Distance | Distance (in pixels) that she actor should slide. |
| Direction | Slide direction. |
| Time (sec) | Duration (in seconds) of the fade and/or slide. |
| Wait to complete | Wait for this action to complete before triggering the next. |
| State | Initial state of the actor (if available). |
| Mirror | Actor object should be mirrored. |
Remove an actor from the scene.
| Property | Description |
| Actor | Actor to withdraw. |
| Fade out | Fade out the actor object. |
| Slide | Slide out the actor object. |
| Distance | Distance (in pixels) that she actor should slide. |
| Direction | Slide direction. |
| Time (sec) | Duration (in seconds) of the fade and/or slide. |
| Wait to complete | Wait for this action to complete before triggering the next. |
Change the name of an actor. The change will affect future dialogue.
| Property | Description |
| Actor | Actor to rename. |
| New name | New actor name. |
Objects
Change the current sequence of an animated image.
| Property | Description |
| Object | Target object. |
| Animation | New animation sequence. |
Change the current state of an image set.
| Property | Description |
| Object | Target object. |
| State | New state. |
Change the text content of a text object.
| Property | Description |
| Object | Target text object. |
| Text | New text. |
Toggle the visibility of an object. You can set a time value, for when the object's OnShow or OnHide event will be called, giving you the ability to create custom transitions through scripting.
| Property | Description |
| Object | Target object. |
| Visibility | [Show, Hide] |
| Time (sec) | Duration for which the OnShow or OnHide event should run. |
| Wait to complete | Wait for this action to complete before triggering the next. |
Show an object at one of a number of predefined positions. Useful for displaying characters, mostly.
Remarks: This action is deprecated. Use Enter actor instead.
Fade an object in or out over a set duration of time.
| Property | Description |
| Object | Target object. |
| Fade | [In, Out] |
| Time (sec) | Duration for of fade/slide. |
| Slide | Slide object. |
| Slide distance | Slide distance (in pixels). |
| Wait to complete | Wait for this action to complete before triggering the next. |
Change an object's color.
| Property | Description |
| Object | Target object. |
| Color | Color value. |
| Opacity | Opacity value. |
| Fade | Fade to the new color. |
| Time (sec) | Duration (in seconds) of the fade. |
| Wait to complete | Wait for this action to complete before triggering the next. |
Transform
Change the position, size, scale and rotation of an object.
| Property | Description |
| Object | Target object. |
| Time (sec) | Duration (in seconds) of the transform. |
| Smooth | Smooth (non-linear) interpolation. |
| Wait to complete | Wait for this action to complete before triggering the next. |
| Position | New object position. |
| Size | New object size. |
| Rotation | New object rotation. |
| Scale | New object scale. |
Change the position of an object.
| Property | Description |
| Object | Target object. |
| Time (sec) | Duration (in seconds) of the transform. |
| Smooth | Smooth (non-linear) interpolation. |
| Wait to complete | Wait for this action to complete before triggering the next. |
| Position | New object position. |
Change the scale of an object.
| Property | Description |
| Object | Target object. |
| Time (sec) | Duration (in seconds) of the transform. |
| Smooth | Smooth (non-linear) interpolation. |
| Wait to complete | Wait for this action to complete before triggering the next. |
| Scale | New object scale. |
Change the size of an object.
| Property | Description |
| Object | Target object. |
| Time (sec) | Duration (in seconds) of the transform. |
| Smooth | Smooth (non-linear) interpolation. |
| Wait to complete | Wait for this action to complete before triggering the next. |
| Size | New object size. |
Change the rotation of an object.
| Property | Description |
| Object | Target object. |
| Time (sec) | Duration (in seconds) of the transform. |
| Smooth | Smooth (non-linear) interpolation. |
| Wait to complete | Wait for this action to complete before triggering the next. |
| Rotation | New object rotation. |
Shake an object in the scene for a set duration.
| Property | Description |
| Object | Target object. |
| Magnitude | Magnitude (in pixels) of the shake. |
| Time (sec) | Duration (in seconds) of the shake. |
| Directions | Directions of the shake. [All, Horizontal, Vertical] |
| Wait to complete | Wait for this action to complete before triggering the next. |
Audio/Video
Play audio asset (as background music).
| Property | Description |
| Audio asset | Audio asset to play. |
| Volume | Music volume. |
| Looping | Music should loop. |
| Crossfade | Should crossfade from previously playing music. |
Play audio asset (as vocal).
| Property | Description |
| Audio asset | Audio asset to play. |
| Volume | Music volume. |
| Balance | Audio balance. |
Play audio asset (as sound effect).
| Property | Description |
| Audio asset | Audio asset to play. |
| Volume | Music volume. |
| Balance | Audio balance. |
| Looping | Sound effect should loop. |
Loads and plays a video file. The video is fed into one of three video channels and can only be viewed using a Video object.
| Property | Description |
| Video source | Video source filename (relative to Novelty runtime) |
| Channel | Video channel [0..2]. |
| Volume | Audio volume. |
| Looping | Video should loop. |
Jump to an arbitrary point in a playing video.
| Property | Description |
| Channel | Video channel [0..2]. |
| Minutes | |
| Seconds | |
| Milliseconds |
Camera
Change the panning, rotation and zoom of the camera.
| Property | Description |
| Time (sec) | Duration (in seconds) for the camera transition. |
| Smooth | Smooth transition. |
| Wait to complete | Wait for this action to complete before triggering the next. |
| Panning | Camera pan (position). |
| Rotation | Camera rotation. |
| Zoom | Camera zoom (scale). |
| Target | Entire scene or individual layers. |
Resets the camera to the default settings.
| Property | Description |
| Time (sec) | Duration (in seconds) for the camera transition. |
| Smooth | Smooth transition. |
| Wait to complete | Wait for this action to complete before triggering the next. |
| Target | Entire scene or individual layers. |
Shake the entire scene for a set duration.
| Property | Description |
| Magnitude | Magnitude (in pixels) of the shake. |
| Time (sec) | Duration (in seconds) of the shake. |
| Directions | Directions of the shake. [All, Horizontal, Vertical] |
| Wait to complete | Wait for this action to complete before triggering the next. |
Scripting
Set or change a game variable.
| Property | Description |
| Operator | Assignment operator. |
| Variable name | Name of the game variable to set or change (case sensitive). |
| Value | Value to assign. |
Turn a game switch on or off.
Same as setting a game variable to true or false.
| Property | Description |
| Operator | Set or Toggle |
| Switch variable name | Name of the game variable to set or change (case sensitive). |
| Value | Value On or Off |
Brings up a dialogue where the player may enter text. The response can be assigned to a game variable or be used to change the name of an actor.
| Property | Description |
| Message | Text message to display to the player. |
| Response action | [Store in game variable, Rename actor] |
| Variable name | Name of the game variable to set (case sensitive). |
| Actor name | Name of an Actor. |
| Default value (optional) | A default value for the entry |
| Max length (optional) | Maximum length of the text. (0 = no limit) |
| Allow empty | Allow the player to give an empty entry. |
Execute a piece of script code.
This action can be used to simply call a script function or you may enter a more complex script if you like.
The code you enter will be compiled when the action is triggered. Any errors are reported in the console window.
| Property | Description |
| Code | Script code that should be executed. |
| Comment (optional) | A comment that will be displayed in the Action window. |
