Voice
Playing a recorded line from a blueprint, and the dub language the game is set to.
Five nodes for the game's voice tracks: playing a take, playing the take attached to a choice option, and reading or setting which dub language is in force.
Conventions
- All five are latent. None can back a Blueprint Value, and none is offered to a Story Action blueprint, which has no game host.
- A take is addressed by voice id, which is the line's unit ID, the id its row carries in the translation table.
- Setting the language takes effect from the next spoken line. The game does not restart, and the text language is unaffected; that one is set with the nodes in Localization.
Play Voice
blueprint.voice.play · Latent
Plays the take recorded for one line, in the dub language currently in force.
| Pin | Direction | Type | Notes |
|---|---|---|---|
in | in · exec | — | |
next | out · exec | — | |
voiceId | in · data | string | The line's voice id. |
value | out · data | boolean | Whether a take was found and played. |
Play Choice Voice
blueprint.voice.playChoice · Latent
Plays the take attached to the choice option this graph is running for. Used inside a choice row, where the row is the only thing that knows which option it is. Anywhere else it is an execution error.
| Pin | Direction | Type | Notes |
|---|---|---|---|
in | in · exec | — | |
next | out · exec | — | |
interruptOthers | in · data | boolean | Optional, literal. Stops the take another option is already speaking, so hovering down a list does not stack voices. |
value | out · data | boolean | Whether a take was found and played. |
Get Voice Language
blueprint.voice.getLanguage · Latent
| Pin | Direction | Type | Notes |
|---|---|---|---|
in | in · exec | — | |
next | out · exec | — | |
value | out · data | string | The dub language in force. |
Set Voice Language
blueprint.voice.setLanguage · Latent
| Pin | Direction | Type | Notes |
|---|---|---|---|
in | in · exec | — | |
next | out · exec | — | |
language | in · data | string |
An unknown or empty code is an execution error, and so is running this node in a project with no voice languages.
Get Available Voice Languages
blueprint.voice.getAvailableLanguages · Latent
| Pin | Direction | Type | Notes |
|---|---|---|---|
in | in · exec | — | |
next | out · exec | — | |
value | out · data | array<struct:nl.voiceLanguage> | The dub languages this build ships, as a Voice language list with the fields code and displayName. What a settings page lists. |