You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
516 lines
19 KiB
516 lines
19 KiB
@tool
|
|
class_name DialogicTextEvent
|
|
extends DialogicEvent
|
|
|
|
## Event that stores text. Can be said by a character.
|
|
## Should be shown by a DialogicNode_DialogText.
|
|
|
|
|
|
### Settings
|
|
|
|
## This is the content of the text event.
|
|
## It is supposed to be displayed by a DialogicNode_DialogText node.
|
|
## That means you can use bbcode, but also some custom commands.
|
|
var text: String = ""
|
|
## If this is not null, the given character (as a resource) will be associated with this event.
|
|
## The DialogicNode_NameLabel will show the characters display_name. If a typing sound is setup,
|
|
## it will play.
|
|
var character: DialogicCharacter = null
|
|
## If a character is set, this setting can change the portrait of that character.
|
|
var portrait: String = ""
|
|
|
|
### Helpers
|
|
|
|
## Used to set the character resource from the unique name identifier and vice versa
|
|
var character_identifier: String:
|
|
get:
|
|
if character:
|
|
var identifier := DialogicResourceUtil.get_unique_identifier(character.resource_path)
|
|
if not identifier.is_empty():
|
|
return identifier
|
|
return character_identifier
|
|
set(value):
|
|
character_identifier = value
|
|
character = DialogicResourceUtil.get_character_resource(value)
|
|
|
|
var regex := RegEx.create_from_string(r'\s*((")?(?<name>(?(2)[^"\n]*|[^(: \n]*))(?(2)"|)(\W*(?<portrait>\(.*\)))?\s*(?<!\\):)?(?<text>(.|\n)*)')
|
|
var split_regex := RegEx.create_from_string(r"((\[n\]|\[n\+\])?((?!(\[n\]|\[n\+\]))(.|\n))+)")
|
|
|
|
enum States {REVEALING, IDLE, DONE}
|
|
var state := States.IDLE
|
|
signal advance
|
|
|
|
|
|
#region EXECUTION
|
|
################################################################################
|
|
|
|
func _execute() -> void:
|
|
if text.is_empty():
|
|
finish()
|
|
return
|
|
|
|
if (not character or character.custom_info.get('style', '').is_empty()) and dialogic.has_subsystem('Styles'):
|
|
# if previous characters had a custom style change back to base style
|
|
if dialogic.current_state_info.get('base_style') != dialogic.current_state_info.get('style'):
|
|
dialogic.Styles.load_style(dialogic.current_state_info.get('base_style', 'Default'))
|
|
await dialogic.get_tree().process_frame
|
|
|
|
var character_name_text := dialogic.Text.get_character_name_parsed(character)
|
|
if character:
|
|
if dialogic.has_subsystem('Styles') and character.custom_info.get('style', null):
|
|
dialogic.Styles.load_style(character.custom_info.style, null, false)
|
|
await dialogic.get_tree().process_frame
|
|
|
|
|
|
if portrait and dialogic.has_subsystem('Portraits') and dialogic.Portraits.is_character_joined(character):
|
|
dialogic.Portraits.change_character_portrait(character, portrait)
|
|
dialogic.Portraits.change_speaker(character, portrait)
|
|
var check_portrait: String = portrait if !portrait.is_empty() else dialogic.current_state_info['portraits'].get(character.resource_path, {}).get('portrait', '')
|
|
|
|
if check_portrait and character.portraits.get(check_portrait, {}).get('sound_mood', '') in character.custom_info.get('sound_moods', {}):
|
|
dialogic.Text.update_typing_sound_mood(character.custom_info.get('sound_moods', {}).get(character.portraits[check_portrait].get('sound_mood', {}), {}))
|
|
elif !character.custom_info.get('sound_mood_default', '').is_empty():
|
|
dialogic.Text.update_typing_sound_mood(character.custom_info.get('sound_moods', {}).get(character.custom_info.get('sound_mood_default'), {}))
|
|
else:
|
|
dialogic.Text.update_typing_sound_mood()
|
|
|
|
dialogic.Text.update_name_label(character)
|
|
else:
|
|
dialogic.Portraits.change_speaker(null)
|
|
dialogic.Text.update_name_label(null)
|
|
dialogic.Text.update_typing_sound_mood()
|
|
|
|
_connect_signals()
|
|
|
|
var final_text: String = get_property_translated('text')
|
|
if ProjectSettings.get_setting('dialogic/text/split_at_new_lines', false):
|
|
match ProjectSettings.get_setting('dialogic/text/split_at_new_lines_as', 0):
|
|
0:
|
|
final_text = final_text.replace('\n', '[n]')
|
|
1:
|
|
final_text = final_text.replace('\n', '[n+][br]')
|
|
|
|
var split_text := []
|
|
for i in split_regex.search_all(final_text):
|
|
split_text.append([i.get_string().trim_prefix('[n]').trim_prefix('[n+]')])
|
|
split_text[-1].append(i.get_string().begins_with('[n+]'))
|
|
|
|
dialogic.current_state_info['text_sub_idx'] = dialogic.current_state_info.get('text_sub_idx', 0)
|
|
|
|
var reveal_next_segment := true
|
|
|
|
if dialogic.current_state_info['text_sub_idx'] > 0:
|
|
reveal_next_segment = false
|
|
|
|
for section_idx in range(min(dialogic.current_state_info['text_sub_idx'], len(split_text)-1), len(split_text)):
|
|
dialogic.Inputs.block_input(ProjectSettings.get_setting('dialogic/text/text_reveal_skip_delay', 0.1))
|
|
|
|
if reveal_next_segment:
|
|
dialogic.Text.hide_next_indicators()
|
|
state = States.REVEALING
|
|
|
|
dialogic.current_state_info['text_sub_idx'] = section_idx
|
|
|
|
var segment: String = dialogic.Text.parse_text(split_text[section_idx][0])
|
|
var is_append: bool = split_text[section_idx][1]
|
|
|
|
final_text = segment
|
|
dialogic.Text.about_to_show_text.emit({'text':final_text, 'character':character, 'portrait':portrait, 'append': is_append})
|
|
|
|
await dialogic.Text.update_textbox(final_text, false)
|
|
_try_play_current_line_voice()
|
|
final_text = dialogic.Text.update_dialog_text(final_text, false, is_append)
|
|
|
|
_mark_as_read(character_name_text, final_text)
|
|
|
|
# We must skip text animation before we potentially return when there
|
|
# is a Choice event.
|
|
if dialogic.Inputs.auto_skip.enabled:
|
|
dialogic.Text.skip_text_reveal()
|
|
else:
|
|
await dialogic.Text.text_finished
|
|
|
|
state = States.IDLE
|
|
|
|
# Handling potential Choice Events.
|
|
if section_idx == len(split_text)-1 and dialogic.has_subsystem('Choices') and dialogic.Choices.is_question(dialogic.current_event_idx):
|
|
dialogic.Text.show_next_indicators(true)
|
|
|
|
end_text_event()
|
|
return
|
|
|
|
elif dialogic.Inputs.auto_advance.is_enabled():
|
|
dialogic.Text.show_next_indicators(false, true)
|
|
dialogic.Inputs.auto_advance.start()
|
|
else:
|
|
dialogic.Text.show_next_indicators()
|
|
|
|
if section_idx == len(split_text)-1:
|
|
state = States.DONE
|
|
|
|
# If Auto-Skip is enabled and there are multiple parts of this text
|
|
# we need to skip the text after the defined time per event.
|
|
if dialogic.Inputs.auto_skip.enabled:
|
|
await dialogic.Inputs.start_autoskip_timer()
|
|
|
|
# Check if Auto-Skip is still enabled.
|
|
if not dialogic.Inputs.auto_skip.enabled:
|
|
await advance
|
|
|
|
else:
|
|
await advance
|
|
|
|
|
|
end_text_event()
|
|
|
|
|
|
func end_text_event() -> void:
|
|
dialogic.current_state_info['text_sub_idx'] = 0
|
|
|
|
_disconnect_signals()
|
|
finish()
|
|
|
|
|
|
func _mark_as_read(character_name_text: String, final_text: String) -> void:
|
|
if dialogic.has_subsystem('History'):
|
|
if character:
|
|
dialogic.History.store_simple_history_entry(final_text, event_name, {'character':character_name_text, 'character_color':character.color})
|
|
else:
|
|
dialogic.History.store_simple_history_entry(final_text, event_name)
|
|
dialogic.History.mark_event_as_visited(self)
|
|
|
|
|
|
func _connect_signals() -> void:
|
|
if not dialogic.Inputs.dialogic_action.is_connected(_on_dialogic_input_action):
|
|
dialogic.Inputs.dialogic_action.connect(_on_dialogic_input_action)
|
|
|
|
dialogic.Inputs.auto_skip.toggled.connect(_on_auto_skip_enable)
|
|
|
|
if not dialogic.Inputs.auto_advance.autoadvance.is_connected(_on_dialogic_input_autoadvance):
|
|
dialogic.Inputs.auto_advance.autoadvance.connect(_on_dialogic_input_autoadvance)
|
|
|
|
|
|
## If the event is done, this method can clean-up signal connections.
|
|
func _disconnect_signals() -> void:
|
|
if dialogic.Inputs.dialogic_action.is_connected(_on_dialogic_input_action):
|
|
dialogic.Inputs.dialogic_action.disconnect(_on_dialogic_input_action)
|
|
if dialogic.Inputs.auto_advance.autoadvance.is_connected(_on_dialogic_input_autoadvance):
|
|
dialogic.Inputs.auto_advance.autoadvance.disconnect(_on_dialogic_input_autoadvance)
|
|
if dialogic.Inputs.auto_skip.toggled.is_connected(_on_auto_skip_enable):
|
|
dialogic.Inputs.auto_skip.toggled.disconnect(_on_auto_skip_enable)
|
|
|
|
|
|
## Tries to play the voice clip for the current line.
|
|
func _try_play_current_line_voice() -> void:
|
|
# If Auto-Skip is enabled and we skip voice clips, we don't want to play.
|
|
if (dialogic.Inputs.auto_skip.enabled
|
|
and dialogic.Inputs.auto_skip.skip_voice):
|
|
return
|
|
|
|
# Plays the audio region for the current line.
|
|
if (dialogic.has_subsystem('Voice')
|
|
and dialogic.Voice.is_voiced(dialogic.current_event_idx)):
|
|
dialogic.Voice.play_voice()
|
|
|
|
|
|
func _on_dialogic_input_action() -> void:
|
|
match state:
|
|
States.REVEALING:
|
|
if dialogic.Text.is_text_reveal_skippable():
|
|
dialogic.Text.skip_text_reveal()
|
|
dialogic.Inputs.stop_timers()
|
|
_:
|
|
if dialogic.Inputs.manual_advance.is_enabled():
|
|
advance.emit()
|
|
dialogic.Inputs.stop_timers()
|
|
|
|
|
|
func _on_dialogic_input_autoadvance() -> void:
|
|
if state == States.IDLE or state == States.DONE:
|
|
advance.emit()
|
|
|
|
|
|
func _on_auto_skip_enable(enabled: bool) -> void:
|
|
if not enabled:
|
|
return
|
|
|
|
match state:
|
|
States.DONE:
|
|
await dialogic.Inputs.start_autoskip_timer()
|
|
|
|
# If Auto-Skip is still enabled, advance the text.
|
|
if dialogic.Inputs.auto_skip.enabled:
|
|
advance.emit()
|
|
|
|
States.REVEALING:
|
|
dialogic.Text.skip_text_reveal()
|
|
|
|
#endregion
|
|
|
|
|
|
#region INITIALIZE
|
|
################################################################################
|
|
|
|
func _init() -> void:
|
|
event_name = "Text"
|
|
set_default_color('Color1')
|
|
event_category = "Main"
|
|
event_sorting_index = 0
|
|
expand_by_default = true
|
|
help_page_path = "https://docs.dialogic.pro/writing-text-events.html"
|
|
|
|
|
|
|
|
################################################################################
|
|
## SAVING/LOADING
|
|
################################################################################
|
|
|
|
func to_text() -> String:
|
|
var result := text.replace('\n', '\\\n')
|
|
result = result.replace(':', '\\:')
|
|
if result.is_empty():
|
|
result = "<Empty Text Event>"
|
|
|
|
if character:
|
|
var name := DialogicResourceUtil.get_unique_identifier(character.resource_path)
|
|
if name.count(" ") > 0:
|
|
name = '"' + name + '"'
|
|
if not portrait.is_empty():
|
|
result = name+" ("+portrait+"): "+result
|
|
else:
|
|
result = name+": "+result
|
|
for event in DialogicResourceUtil.get_event_cache():
|
|
if not event is DialogicTextEvent and event.is_valid_event(result):
|
|
result = '\\'+result
|
|
break
|
|
|
|
return result
|
|
|
|
|
|
func from_text(string:String) -> void:
|
|
# Load default character
|
|
# This is only of relevance if the default has been overriden (usually not)
|
|
character = DialogicResourceUtil.get_character_resource(character_identifier)
|
|
|
|
var result := regex.search(string.trim_prefix('\\'))
|
|
if result and not result.get_string('name').is_empty():
|
|
var name := result.get_string('name').strip_edges()
|
|
|
|
if name == '_':
|
|
character = null
|
|
else:
|
|
character = DialogicResourceUtil.get_character_resource(name)
|
|
|
|
if character == null and Engine.is_editor_hint() == false:
|
|
character = DialogicCharacter.new()
|
|
character.display_name = name
|
|
character.resource_path = "user://"+name+".dch"
|
|
DialogicResourceUtil.add_resource_to_directory(character.resource_path, DialogicResourceUtil.get_character_directory())
|
|
|
|
if !result.get_string('portrait').is_empty():
|
|
portrait = result.get_string('portrait').strip_edges().trim_prefix('(').trim_suffix(')')
|
|
|
|
if result:
|
|
text = result.get_string('text').replace("\\\n", "\n").replace('\\:', ':').strip_edges().trim_prefix('\\')
|
|
if text == '<Empty Text Event>':
|
|
text = ""
|
|
|
|
|
|
func is_valid_event(string:String) -> bool:
|
|
return true
|
|
|
|
|
|
func is_string_full_event(string:String) -> bool:
|
|
return !string.ends_with('\\')
|
|
|
|
|
|
# this is only here to provide a list of default values
|
|
# this way the module manager can add custom default overrides to this event.
|
|
func get_shortcode_parameters() -> Dictionary:
|
|
return {
|
|
#param_name : property_info
|
|
"character" : {"property": "character_identifier", "default": ""},
|
|
"portrait" : {"property": "portrait", "default": ""},
|
|
}
|
|
#endregion
|
|
|
|
|
|
#region TRANSLATIONS
|
|
################################################################################
|
|
|
|
func _get_translatable_properties() -> Array:
|
|
return ['text']
|
|
|
|
|
|
func _get_property_original_translation(property:String) -> String:
|
|
match property:
|
|
'text':
|
|
return text
|
|
return ''
|
|
|
|
|
|
#endregion
|
|
|
|
|
|
#region EVENT EDITOR
|
|
################################################################################
|
|
|
|
func _enter_visual_editor(editor:DialogicEditor):
|
|
editor.opened.connect(func(): ui_update_needed.emit())
|
|
|
|
|
|
func build_event_editor():
|
|
add_header_edit('character_identifier', ValueType.DYNAMIC_OPTIONS,
|
|
{'file_extension' : '.dch',
|
|
'mode' : 2,
|
|
'suggestions_func' : get_character_suggestions,
|
|
'empty_text' : '(No one)',
|
|
'icon' : load("res://addons/dialogic/Editor/Images/Resources/character.svg")}, 'do_any_characters_exist()')
|
|
add_header_edit('portrait', ValueType.DYNAMIC_OPTIONS,
|
|
{'suggestions_func' : get_portrait_suggestions,
|
|
'placeholder' : "(Don't change)",
|
|
'icon' : load("res://addons/dialogic/Editor/Images/Resources/portrait.svg"),
|
|
'collapse_when_empty':true,},
|
|
'character != null and !has_no_portraits()')
|
|
add_body_edit('text', ValueType.MULTILINE_TEXT, {'autofocus':true})
|
|
|
|
func do_any_characters_exist() -> bool:
|
|
return !DialogicResourceUtil.get_character_directory().is_empty()
|
|
|
|
func has_no_portraits() -> bool:
|
|
return character and character.portraits.is_empty()
|
|
|
|
|
|
func get_character_suggestions(search_text:String) -> Dictionary:
|
|
var suggestions := {}
|
|
|
|
|
|
var icon = load("res://addons/dialogic/Editor/Images/Resources/character.svg")
|
|
suggestions['(No one)'] = {'value':null, 'editor_icon':["GuiRadioUnchecked", "EditorIcons"]}
|
|
|
|
var character_directory := DialogicResourceUtil.get_character_directory()
|
|
for resource in character_directory.keys():
|
|
suggestions[resource] = {
|
|
'value' : resource,
|
|
'tooltip' : character_directory[resource],
|
|
'icon' : icon.duplicate()}
|
|
return suggestions
|
|
|
|
|
|
func get_portrait_suggestions(search_text:String) -> Dictionary:
|
|
var suggestions := {}
|
|
var icon := load("res://addons/dialogic/Editor/Images/Resources/portrait.svg")
|
|
suggestions["Don't change"] = {'value':'', 'editor_icon':["GuiRadioUnchecked", "EditorIcons"]}
|
|
if "{" in search_text:
|
|
suggestions[search_text] = {'value':search_text, 'editor_icon':["Variant", "EditorIcons"]}
|
|
if character != null:
|
|
for portrait in character.portraits:
|
|
suggestions[portrait] = {'value':portrait, 'icon':icon}
|
|
return suggestions
|
|
|
|
#endregion
|
|
|
|
|
|
#region CODE COMPLETION
|
|
################################################################################
|
|
|
|
var completion_text_character_getter_regex := RegEx.new()
|
|
var completion_text_effects := {}
|
|
func _get_code_completion(CodeCompletionHelper:Node, TextNode:TextEdit, line:String, word:String, symbol:String) -> void:
|
|
if completion_text_character_getter_regex.get_pattern().is_empty():
|
|
completion_text_character_getter_regex.compile("(\"[^\"]*\"|[^\\s:]*)")
|
|
|
|
if completion_text_effects.is_empty():
|
|
for idx in DialogicUtil.get_indexers():
|
|
for effect in idx._get_text_effects():
|
|
completion_text_effects[effect['command']] = effect
|
|
|
|
if not ':' in line.substr(0, TextNode.get_caret_column()) and symbol == '(':
|
|
var character := completion_text_character_getter_regex.search(line).get_string().trim_prefix('"').trim_suffix('"')
|
|
|
|
CodeCompletionHelper.suggest_portraits(TextNode, character)
|
|
if symbol == '[':
|
|
suggest_bbcode(TextNode)
|
|
for effect in completion_text_effects.values():
|
|
if effect.get('arg', false):
|
|
TextNode.add_code_completion_option(CodeEdit.KIND_MEMBER, effect.command, effect.command+'=', TextNode.syntax_highlighter.normal_color, TextNode.get_theme_icon("RichTextEffect", "EditorIcons"))
|
|
else:
|
|
TextNode.add_code_completion_option(CodeEdit.KIND_MEMBER, effect.command, effect.command, TextNode.syntax_highlighter.normal_color, TextNode.get_theme_icon("RichTextEffect", "EditorIcons"), ']')
|
|
if symbol == '{':
|
|
CodeCompletionHelper.suggest_variables(TextNode)
|
|
|
|
if symbol == '=':
|
|
if CodeCompletionHelper.get_line_untill_caret(line).ends_with('[portrait='):
|
|
var character := completion_text_character_getter_regex.search(line).get_string('name')
|
|
CodeCompletionHelper.suggest_portraits(TextNode, character, ']')
|
|
|
|
|
|
func _get_start_code_completion(CodeCompletionHelper:Node, TextNode:TextEdit) -> void:
|
|
CodeCompletionHelper.suggest_characters(TextNode, CodeEdit.KIND_CLASS, true)
|
|
|
|
|
|
func suggest_bbcode(text:CodeEdit):
|
|
for i in [['b (bold)', 'b'], ['i (italics)', 'i'], ['color', 'color='], ['font size','font_size=']]:
|
|
text.add_code_completion_option(CodeEdit.KIND_MEMBER, i[0], i[1], text.syntax_highlighter.normal_color, text.get_theme_icon("RichTextEffect", "EditorIcons"),)
|
|
text.add_code_completion_option(CodeEdit.KIND_CLASS, 'end '+i[0], '/'+i[1], text.syntax_highlighter.normal_color, text.get_theme_icon("RichTextEffect", "EditorIcons"), ']')
|
|
for i in [['new event', 'n'],['new event (same box)', 'n+']]:
|
|
text.add_code_completion_option(CodeEdit.KIND_MEMBER, i[0], i[1], text.syntax_highlighter.normal_color, text.get_theme_icon("ArrowRight", "EditorIcons"),)
|
|
|
|
#endregion
|
|
|
|
|
|
#region SYNTAX HIGHLIGHTING
|
|
################################################################################
|
|
|
|
var text_effects := ""
|
|
var text_effects_regex := RegEx.new()
|
|
func load_text_effects():
|
|
if text_effects.is_empty():
|
|
for idx in DialogicUtil.get_indexers():
|
|
for effect in idx._get_text_effects():
|
|
text_effects+= effect['command']+'|'
|
|
text_effects += "b|i|u|s|code|p|center|left|right|fill|n\\+|n|indent|url|img|font|font_size|opentype_features|color|bg_color|fg_color|outline_size|outline_color|table|cell|ul|ol|lb|rb|br"
|
|
if text_effects_regex.get_pattern().is_empty():
|
|
text_effects_regex.compile("(?<!\\\\)\\[\\s*/?(?<command>"+text_effects+")\\s*(=\\s*(?<value>.+?)\\s*)?\\]")
|
|
|
|
|
|
var text_random_word_regex := RegEx.new()
|
|
var text_effect_color := Color('#898276')
|
|
func _get_syntax_highlighting(Highlighter:SyntaxHighlighter, dict:Dictionary, line:String) -> Dictionary:
|
|
load_text_effects()
|
|
if text_random_word_regex.get_pattern().is_empty():
|
|
text_random_word_regex.compile("(?<!\\\\)\\<[^\\[\\>]+(\\/[^\\>]*)\\>")
|
|
|
|
var result := regex.search(line)
|
|
if !result:
|
|
return dict
|
|
if Highlighter.mode == Highlighter.Modes.FULL_HIGHLIGHTING:
|
|
if result.get_string('name'):
|
|
dict[result.get_start('name')] = {"color":Highlighter.character_name_color}
|
|
dict[result.get_end('name')] = {"color":Highlighter.normal_color}
|
|
if result.get_string('portrait'):
|
|
dict[result.get_start('portrait')] = {"color":Highlighter.character_portrait_color}
|
|
dict[result.get_end('portrait')] = {"color":Highlighter.normal_color}
|
|
if result.get_string('text'):
|
|
var effects_result := text_effects_regex.search_all(line)
|
|
for eff in effects_result:
|
|
dict[eff.get_start()] = {"color":text_effect_color}
|
|
dict[eff.get_end()] = {"color":Highlighter.normal_color}
|
|
dict = Highlighter.color_region(dict, Highlighter.variable_color, line, '{', '}', result.get_start('text'))
|
|
|
|
for replace_mod_match in text_random_word_regex.search_all(result.get_string('text')):
|
|
var color :Color = Highlighter.string_color
|
|
color = color.lerp(Highlighter.normal_color, 0.4)
|
|
dict[replace_mod_match.get_start()+result.get_start('text')] = {'color':Highlighter.string_color}
|
|
var offset := 1
|
|
for b in replace_mod_match.get_string().trim_suffix('>').trim_prefix('<').split('/'):
|
|
color.h = wrap(color.h+0.2, 0, 1)
|
|
dict[replace_mod_match.get_start()+result.get_start('text')+offset] = {'color':color}
|
|
offset += len(b)
|
|
dict[replace_mod_match.get_start()+result.get_start('text')+offset] = {'color':Highlighter.string_color}
|
|
offset += 1
|
|
dict[replace_mod_match.get_end()+result.get_start('text')] = {'color':Highlighter.normal_color}
|
|
return dict
|
|
|
|
#endregion
|