diff --git a/docs/2.17/concept-actions-functions.md b/docs/2.17/concept-actions-functions.md index f5d16ae..05c092e 100644 --- a/docs/2.17/concept-actions-functions.md +++ b/docs/2.17/concept-actions-functions.md @@ -92,11 +92,13 @@ The `<>` action defines a special kind of variable - it is a variable who `<>` will put a chatterbox into a "waiting" state. This is used to break up sections of dialogue in non-singleton mode. You can tell a chatterbox to "un-wait" by calling `ChatterboxContinue()`. +If the chatterbox is running in fast-forward mode (see `ChatterboxFastForward()`) then a standard `<>` action will be ignored. To always wait, even when in fast-forward mode, please use `<>`. + You can also specify a name in a wait command. This name is then used to filter continue commands when calling `ChatterboxContinue()`. For example, the command `<>` can only be continued by calling `ChatterboxContinue(chatterbox, "timer")`. A wait command with no name (`<>`) is treated as having an empty string `""` as a name. ?> In singleton mode this action does nothing because `<>` is implicitly and automatically called after every line of dialogue (so long as that dialogue isn't followed immediately by an `->` option). -?> `<>` is analogous to the `ChatterboxWait()` function. +?> `ChatterboxWait()` can be called from a Chatterbox action to cause a chatterbox to forcibly wait. Doing so will ignore fast-forward mode (`ChatterboxWait()` is analogous to `<>`).   @@ -116,6 +118,26 @@ Branching logic is also written in between `<<` and `>>` too, such as `<>` + +`<>` will put a chatterbox into a "waiting" state regardless of whether a chatterbox is fast-forwarding or not. You can tell a chatterbox to "un-wait" by calling `ChatterboxContinue()` as you would with the `<>` action. + +You can also specify a name in a force wait command. This name is then used to filter continue commands when calling `ChatterboxContinue()`. For example, the command `<>` can only be continued by calling `ChatterboxContinue(chatterbox, "timer")`. A force wait command with no name (`<>`) is treated as having an empty string `""` as a name. + +?> `<>` is analogous to the `ChatterboxWait()` function. + +  + +### `v` + +*Example:* `<>` + +`<>` will not pause a chatterbox but it will disable fast-forward mode. Any content after the `<>` action will still be displayed but any content between triggering fast-forward mode and `<>` will not appear. If a chatterbox is not fast-forwarding then this action does nothing. + +  + ## Functions Chatterbox contains one native function: `visited("NodeTitle")`. This function returns the number of times that a particular node has been visited. You can specifiy a node in a particular file by You can specifying the filename first, typing a `:` colon, and then specifying the node in that file. If you don't specify a file then Chatterbox will search in the current file for the desired node.