---
# System prepended metadata

title: Daydreamer - Dialogue Command List

---

# Daydreamer - Dialogue Command List

* How to use?
``` <<[cmd] [param1] [param2] [param3] >> ```
For example, ```<<set_var win true>>``` sets a boolean variable named "win" to true.

* There are blocking / non-blocking commands.
    * Blocking: which will stop the dialogue process until the command has returned a finished signal
    * Non-blocking: vice-versa.

# List 
## ([X] means not yet implemented but planned feature)

| cmd | params | description | blocking |
| -------- | -------- | -------- | -------- |
| wait     | [time]     | block the dialogue for [time] seconds.     | O |
| stop     | |  immediately end the dialogue, as though the game had reached the end of a node. Use this if you need to leave a conversation in the middle of an if statement, or a shortcut option. | O |
| lock_mv |      | lock the player's movement.     | X |
| unlock_mv |      | unlock the player's movement.     | X |
| look_at  | [source] [target] | make the dialogue animator with an IK controller to look at an anchor named [target]. Use <<look_at [source] null>> to disable look at IK.     | X |
| rotate_to  | [source] [target]     | make the anchor named [source] to rotate to the direction of an anchor named [target].     | O |
| ch_rotate_to  | [source] [target]     | make the character controller of the anchor named [source] to rotate to the direction of an anchor named [target].     | O |
| txt_time  | [time] | set the display interval time for each character to [time]. Use <<txt_time default>> to set the speed to the default value. (default is 0.025 seconds per character) | X |
| animate | [name] [clipname] | play an animation clip named [clipname] on an animatorHolder named [name]. | X |
| cutscene  | [name] | play a timeline clip named [name] in the table. | X |
| minigame  | [name] | start a minigame named [name]. (currently support jumpman) | O |
| show_image  | [name] | show an image named [name]. | O |
| enable_cam  | [name] | turn on a virtual camera shot named [name]. | X |
| disable_cam  | [name] | turn off a virtual camera shot named [name]. | X |
| set_dialogue_sound | [name] | change the sound of the bubble ui to [name] | X |
| music_play | [time] | play the current music of the music manager with a delayed time of [time] | X |
| music_out | [time] | fade out the current music of the music manager in the duration of [time] | X |
| music_in | [time] | fade in the prev music of the music manager in the duration of [time] | X |
| [X] rhand_on | [source] [target] | make the dialogue animator with an IK controller to put its right hand on an anchor named [target]. Use <<rhand_on [source] null>> to disable look at IK. | X |
| [X] lhand_on | [source] [target] | make the dialogue animator with an IK controller to put its left hand on an anchor named [target]. Use <<rhand_on [source] null>> to disable look at IK. | X |

# Reserved characters in dialogue


| character | description |
| -------- | -------- |
| \\^     | show the next line without waiting for player's input (useful for showing options after a normal line)|
| \\[digit]     | wait for another text time * [digit] |

