Response Replacement - NenyaBit/Dynamic-Dialogue-Replacer GitHub Wiki
Response replacement focuses entirely on editing the NPC responses of a Dialogue Topic. As such, their area of operation are TopicInfo objects.
File Structure
The .yml
section for this editing type is topicInfos
:
topicInfos:
- Response1
- Response2
- ...
Each Response object is defined as follows:
id: 0x2ABB7|Skyrim.esm
responses:
- keep: false
subtitle: "This is your new Subtitle Line for the first response in this Topic Info"
path: path/to/voice/file
- keep: false
subtitle: "This is your new Subtitle Line for the second response in this Topic Info"
path: path/to/voice/file
conditions:
- GetIsReference Player == 0 AND
voices:
- 0x3924E|Skyrim.esm
- 0xABCDEF|SomeMod.esp
random: false
cut: false
Let's break things down:
- id: The Form ID of the Topic Info you want to edit.
- responses: Editing information, counting from the first to the last. That is, the first definition edits the first NPC response, the second the second, and so forth. The individual properties of such an response object as as follows:
- keep: If the original response should be kept, effectively skipping any editing on this n'th response.
- Default:
false
- Default:
- subtitle: The new subtitle of the response. This fully replaces the original text.
- Default:
""
- Default:
- path: The path to the root of the voice line that should play instead of the original.
- This can either be a total path (
my/path/file.fuz
) or a variable one ($my/path/[VOICE_TYPE]/file.fuz
). Variable paths have to be prefixed with$
and support the following insertion keys:[VOICE_TYPE]
: The Form Editor ID of the Voice. E.g.MaleUniqueSheogorath
orCrWolfVoice
[TOPIC_MOD_FILE]
: The name of the plugin that the topic belongs to. E.g.Skyrim.esm
[TOPIC_INFO_MOD_FILE]
: The name of the plugin that the topic info belongs to. E.g.Skyrim.esm
[VOICE_MOD_FILE]
: The name of the plugin that last edited this voice type. E.g.Skyrim.esm
- Default:
""
- This can either be a total path (
- keep: If the original response should be kept, effectively skipping any editing on this n'th response.
- conditions: The conditions to run against the speaker.
- More info on conditions can be found on the Conditions Wiki-Page.
- Default:
[]
- voices: Shorthand for GetIsVoiceType condition
- Default:
[]
- Default:
- random: If the replacement consumes the call or will be selected randomly among all valid replacements
- Default:
false
- Default:
- cut: In case your replacement has less responses listed than the original topic includes, if additional Responses should be removed.
- For example, if the Topic Info you edit has 3 sentences/responses, but your configuration only lists 2 replacements, should the third response be removed or preserved?
- Default:
true