Skip to content

Commit 29710b7

Browse files
authored
Update API docs (#875)
1 parent 8670b43 commit 29710b7

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/API.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
### Signals
66

7-
- `dialogue_started(resource: DialogueResource)` - emitted when a dialogue balloon is created and dialogue begins.
8-
- `passed_title(title)` - emitted when a title marker is passed through.
7+
- `dialogue_started(resource: DialogueResource)` - emitted when a dialogue balloon is created by `DialogueManager` and dialogue begins.
8+
- `passed_title(title: String)` - emitted when a title marker is passed through.
99
- `got_dialogue(line: DialogueLine)` - emitted when a dialogue line is found.
1010
- `mutated(mutation: Dictionary)` - emitted when a mutation line is about to be run (not including `set` lines).
1111
- `dialogue_ended(resource: DialogueResource)` - emitted when the next line of dialogue is empty and provides the calling resource.
@@ -41,8 +41,9 @@ Returns a `DialogueLine` that looks something like this:
4141
- `responses: Array[DialogueResponse]` - the list of responses to this line (or `[]` if none are available).
4242
- `id: String` - the ID of the response.
4343
- `next_id: String` - the ID of the next line if this response is chosen.
44-
- `is_allowed: bool` - whether this line passed its condition check (useful if you have "include all responses" enabled).
45-
- `character: String` - the character name (if one was provided).
44+
- `is_allowed: bool` - whether this line passed its condition check.
45+
- `condition_as_text: String` - the original condition (as a string) used to check if this response is allowed.
46+
- `character: String` - the character name (or `""`).
4647
- `text: String` - the text for this response.
4748
- `tags: PackedStringArray` - a list of tags.
4849
- `translation_key: String` - the key used to translate the text (or the whole text again if no ID was specified on the response).

0 commit comments

Comments
 (0)