simple dialog plugin naming changed to avoid collision with the core

This commit is contained in:
2023-08-28 16:57:21 +02:00
parent 5949f0713b
commit 59384da8ac
5 changed files with 46 additions and 64 deletions

View File

@@ -4,79 +4,61 @@ extends EditorPlugin
class_name RTMISimpleDialogPlugin class_name RTMISimpleDialogPlugin
const MANAGER_CLASS="res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/esc_dialog_simple.gd" const MANAGER_CLASS="res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/rtmi_dialog_simple.gd"
const SETTINGS_ROOT="escoria/dialog_simple" const SETTINGS_ROOT="escoria/rtmi_dialog_simple"
const AVATARS_PATH = "%s/avatars_path" % SETTINGS_ROOT
const TEXT_TIME_PER_LETTER_MS = "%s/text_time_per_letter_ms" % SETTINGS_ROOT
const TEXT_TIME_PER_LETTER_MS_FAST = "%s/text_time_per_fast_letter_ms" % SETTINGS_ROOT
const READING_SPEED_IN_WPM = "%s/reading_speed_in_wpm" % SETTINGS_ROOT
const CLEAR_TEXT_BY_CLICK_ONLY = "%s/clear_text_by_click_only" % SETTINGS_ROOT
const LEFT_CLICK_ACTION = "%s/left_click_action" % SETTINGS_ROOT
const STOP_TALKING_ANIMATION_ON = "%s/stop_talking_animation_on" % SETTINGS_ROOT
const LEFT_CLICK_ACTION_SPEED_UP = "Speed up"
const LEFT_CLICK_ACTION_INSTANT_FINISH = "Instant finish"
const LEFT_CLICK_ACTION_NOTHING = "None"
const STOP_TALKING_ANIMATION_ON_END_OF_TEXT = "End of text"
const STOP_TALKING_ANIMATION_ON_END_OF_AUDIO = "End of audio"
const READING_SPEED_IN_WPM_DEFAULT_VALUE = 200 const READING_SPEED_IN_WPM_DEFAULT_VALUE = 200
const TEXT_TIME_PER_LETTER_MS_DEFAULT_VALUE = 100 const TEXT_TIME_PER_LETTER_MS_DEFAULT_VALUE = 100
const TEXT_TIME_PER_LETTER_MS_FAST_DEFAULT_VALUE = 25 const TEXT_TIME_PER_LETTER_MS_FAST_DEFAULT_VALUE = 25
var left_click_actions: PoolStringArray = [ var left_click_actions: PoolStringArray = [
LEFT_CLICK_ACTION_SPEED_UP, RTMISimpleDialogSettings.LEFT_CLICK_ACTION_SPEED_UP,
LEFT_CLICK_ACTION_INSTANT_FINISH, RTMISimpleDialogSettings.LEFT_CLICK_ACTION_INSTANT_FINISH,
LEFT_CLICK_ACTION_NOTHING RTMISimpleDialogSettings.LEFT_CLICK_ACTION_NOTHING
] ]
var stop_talking_animation_on_options: PoolStringArray = [ var stop_talking_animation_on_options: PoolStringArray = [
STOP_TALKING_ANIMATION_ON_END_OF_TEXT, RTMISimpleDialogSettings.STOP_TALKING_ANIMATION_ON_END_OF_TEXT,
STOP_TALKING_ANIMATION_ON_END_OF_AUDIO RTMISimpleDialogSettings.STOP_TALKING_ANIMATION_ON_END_OF_AUDIO
] ]
# Override function to return the plugin name. # Override function to return the plugin name.
func get_plugin_name(): func get_plugin_name():
return "escoria-rtmi-dialog-simple" return "escoria-rtmi-dialog-simple"
# Unregister ourselves # Unregister ourselves
func disable_plugin(): func disable_plugin():
print("Disabling plugin Escoria Return to the Monkey Island Dialog Simple") print("Disabling plugin Escoria Dialog Simple")
ESCProjectSettingsManager.remove_setting( ESCProjectSettingsManager.remove_setting(
ESCProjectSettingsManager.DEFAULT_DIALOG_TYPE ESCProjectSettingsManager.DEFAULT_DIALOG_TYPE
) )
ESCProjectSettingsManager.remove_setting( ESCProjectSettingsManager.remove_setting(
AVATARS_PATH RTMISimpleDialogSettings.AVATARS_PATH
) )
ESCProjectSettingsManager.remove_setting( ESCProjectSettingsManager.remove_setting(
TEXT_TIME_PER_LETTER_MS RTMISimpleDialogSettings.TEXT_TIME_PER_LETTER_MS
) )
ESCProjectSettingsManager.remove_setting( ESCProjectSettingsManager.remove_setting(
TEXT_TIME_PER_LETTER_MS_FAST RTMISimpleDialogSettings.TEXT_TIME_PER_LETTER_MS_FAST
) )
ESCProjectSettingsManager.remove_setting( ESCProjectSettingsManager.remove_setting(
CLEAR_TEXT_BY_CLICK_ONLY RTMISimpleDialogSettings.CLEAR_TEXT_BY_CLICK_ONLY
) )
ESCProjectSettingsManager.remove_setting( ESCProjectSettingsManager.remove_setting(
READING_SPEED_IN_WPM RTMISimpleDialogSettings.READING_SPEED_IN_WPM
) )
ESCProjectSettingsManager.remove_setting( ESCProjectSettingsManager.remove_setting(
LEFT_CLICK_ACTION RTMISimpleDialogSettings.LEFT_CLICK_ACTION
) )
ESCProjectSettingsManager.remove_setting( ESCProjectSettingsManager.remove_setting(
STOP_TALKING_ANIMATION_ON RTMISimpleDialogSettings.STOP_TALKING_ANIMATION_ON
) )
EscoriaPlugin.deregister_dialog_manager(MANAGER_CLASS) EscoriaPlugin.deregister_dialog_manager(MANAGER_CLASS)
@@ -84,7 +66,7 @@ func disable_plugin():
# Add ourselves to the list of dialog managers # Add ourselves to the list of dialog managers
func enable_plugin(): func enable_plugin():
print("Enabling plugin Escoria Return to the Monkey Island Dialog Simple") print("Enabling plugin Escoria Dialog Simple")
if EscoriaPlugin.register_dialog_manager(self, MANAGER_CLASS): if EscoriaPlugin.register_dialog_manager(self, MANAGER_CLASS):
ESCProjectSettingsManager.register_setting( ESCProjectSettingsManager.register_setting(
@@ -96,7 +78,7 @@ func enable_plugin():
) )
ESCProjectSettingsManager.register_setting( ESCProjectSettingsManager.register_setting(
AVATARS_PATH, RTMISimpleDialogSettings.AVATARS_PATH,
"res://game/dialog_avatars", "res://game/dialog_avatars",
{ {
"type": TYPE_STRING, "type": TYPE_STRING,
@@ -105,7 +87,7 @@ func enable_plugin():
) )
ESCProjectSettingsManager.register_setting( ESCProjectSettingsManager.register_setting(
TEXT_TIME_PER_LETTER_MS, RTMISimpleDialogSettings.TEXT_TIME_PER_LETTER_MS,
TEXT_TIME_PER_LETTER_MS_DEFAULT_VALUE, TEXT_TIME_PER_LETTER_MS_DEFAULT_VALUE,
{ {
"type": TYPE_REAL "type": TYPE_REAL
@@ -113,7 +95,7 @@ func enable_plugin():
) )
ESCProjectSettingsManager.register_setting( ESCProjectSettingsManager.register_setting(
TEXT_TIME_PER_LETTER_MS_FAST, RTMISimpleDialogSettings.TEXT_TIME_PER_LETTER_MS_FAST,
TEXT_TIME_PER_LETTER_MS_FAST_DEFAULT_VALUE, TEXT_TIME_PER_LETTER_MS_FAST_DEFAULT_VALUE,
{ {
"type": TYPE_REAL "type": TYPE_REAL
@@ -121,7 +103,7 @@ func enable_plugin():
) )
ESCProjectSettingsManager.register_setting( ESCProjectSettingsManager.register_setting(
CLEAR_TEXT_BY_CLICK_ONLY, RTMISimpleDialogSettings.CLEAR_TEXT_BY_CLICK_ONLY,
false, false,
{ {
"type": TYPE_BOOL "type": TYPE_BOOL
@@ -129,7 +111,7 @@ func enable_plugin():
) )
ESCProjectSettingsManager.register_setting( ESCProjectSettingsManager.register_setting(
READING_SPEED_IN_WPM, RTMISimpleDialogSettings.READING_SPEED_IN_WPM,
READING_SPEED_IN_WPM_DEFAULT_VALUE, READING_SPEED_IN_WPM_DEFAULT_VALUE,
{ {
"type": TYPE_INT "type": TYPE_INT
@@ -139,8 +121,8 @@ func enable_plugin():
var left_click_actions_string: String = left_click_actions.join(",") var left_click_actions_string: String = left_click_actions.join(",")
ESCProjectSettingsManager.register_setting( ESCProjectSettingsManager.register_setting(
LEFT_CLICK_ACTION, RTMISimpleDialogSettings.LEFT_CLICK_ACTION,
LEFT_CLICK_ACTION_SPEED_UP, RTMISimpleDialogSettings.LEFT_CLICK_ACTION_SPEED_UP,
{ {
"type": TYPE_STRING, "type": TYPE_STRING,
"hint": PROPERTY_HINT_ENUM, "hint": PROPERTY_HINT_ENUM,
@@ -151,8 +133,8 @@ func enable_plugin():
var stop_talking_animation_on_options_string: String = stop_talking_animation_on_options.join(",") var stop_talking_animation_on_options_string: String = stop_talking_animation_on_options.join(",")
ESCProjectSettingsManager.register_setting( ESCProjectSettingsManager.register_setting(
STOP_TALKING_ANIMATION_ON, RTMISimpleDialogSettings.STOP_TALKING_ANIMATION_ON,
STOP_TALKING_ANIMATION_ON_END_OF_AUDIO, RTMISimpleDialogSettings.STOP_TALKING_ANIMATION_ON_END_OF_AUDIO,
{ {
"type": TYPE_STRING, "type": TYPE_STRING,
"hint": PROPERTY_HINT_ENUM, "hint": PROPERTY_HINT_ENUM,

View File

@@ -4,7 +4,7 @@ class_name ESCReturnToMonekyIslandDialogs
# State machine that governs how the dialog manager behaves # State machine that governs how the dialog manager behaves
var state_machine = preload("res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/esc_dialog_simple_state_machine.gd").new() var state_machine = preload("res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/rtmi_dialog_simple_state_machine.gd").new()
# The currently running player # The currently running player
var _type_player: Node = null var _type_player: Node = null

View File

@@ -1,7 +1,7 @@
extends Resource extends Resource
class_name SimpleDialogSettings class_name RTMISimpleDialogSettings
const SETTINGS_ROOT = "escoria/dialog_simple" const SETTINGS_ROOT = "escoria/rtmi_dialog_simple"
const AVATARS_PATH = "%s/avatars_path" % SETTINGS_ROOT const AVATARS_PATH = "%s/avatars_path" % SETTINGS_ROOT
const TEXT_TIME_PER_LETTER_MS = "%s/text_time_per_letter_ms" % SETTINGS_ROOT const TEXT_TIME_PER_LETTER_MS = "%s/text_time_per_letter_ms" % SETTINGS_ROOT

View File

@@ -357,7 +357,7 @@ _global_script_classes=[ {
"base": "ESCDialogManager", "base": "ESCDialogManager",
"class": "ESCReturnToMonekyIslandDialogs", "class": "ESCReturnToMonekyIslandDialogs",
"language": "GDScript", "language": "GDScript",
"path": "res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/esc_dialog_simple.gd" "path": "res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/rtmi_dialog_simple.gd"
}, { }, {
"base": "Node2D", "base": "Node2D",
"class": "ESCRichTooltip", "class": "ESCRichTooltip",
@@ -519,6 +519,11 @@ _global_script_classes=[ {
"language": "GDScript", "language": "GDScript",
"path": "res://addons/escoria-core/game/core-scripts/esc/commands/queue_resource.gd" "path": "res://addons/escoria-core/game/core-scripts/esc/commands/queue_resource.gd"
}, { }, {
"base": "EditorPlugin",
"class": "RTMISimpleDialogPlugin",
"language": "GDScript",
"path": "res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/plugin.gd"
}, {
"base": "ESCBaseCommand", "base": "ESCBaseCommand",
"class": "RandGlobalCommand", "class": "RandGlobalCommand",
"language": "GDScript", "language": "GDScript",
@@ -599,15 +604,10 @@ _global_script_classes=[ {
"language": "GDScript", "language": "GDScript",
"path": "res://addons/escoria-core/game/core-scripts/esc/commands/show_menu.gd" "path": "res://addons/escoria-core/game/core-scripts/esc/commands/show_menu.gd"
}, { }, {
"base": "EditorPlugin",
"class": "SimpleDialogPlugin",
"language": "GDScript",
"path": "res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/plugin.gd"
}, {
"base": "Resource", "base": "Resource",
"class": "SimpleDialogSettings", "class": "SimpleDialogSettings",
"language": "GDScript", "language": "GDScript",
"path": "res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/esc_dialog_simple_settings.gd" "path": "res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/rtmi_dialog_simple_settings.gd"
}, { }, {
"base": "SlideCommand", "base": "SlideCommand",
"class": "SlideBlockCommand", "class": "SlideBlockCommand",
@@ -792,6 +792,7 @@ _global_script_class_icons={
"PrintCommand": "", "PrintCommand": "",
"QueueEventCommand": "", "QueueEventCommand": "",
"QueueResourceCommand": "", "QueueResourceCommand": "",
"RTMISimpleDialogPlugin": "",
"RandGlobalCommand": "", "RandGlobalCommand": "",
"RepeatCommand": "", "RepeatCommand": "",
"SayCommand": "", "SayCommand": "",
@@ -808,7 +809,6 @@ _global_script_class_icons={
"SetStateCommand": "", "SetStateCommand": "",
"SetTooltipCommand": "", "SetTooltipCommand": "",
"ShowMenuCommand": "", "ShowMenuCommand": "",
"SimpleDialogPlugin": "",
"SimpleDialogSettings": "", "SimpleDialogSettings": "",
"SlideBlockCommand": "", "SlideBlockCommand": "",
"SlideCommand": "", "SlideCommand": "",
@@ -888,7 +888,7 @@ ui/inventory_items_path="res://gymkhana/items/inventory"
ui/default_transition="instant" ui/default_transition="instant"
ui/transition_paths=[ "res://addons/escoria-core/game/scenes/transitions/shaders/" ] ui/transition_paths=[ "res://addons/escoria-core/game/scenes/transitions/shaders/" ]
ui/inventory_item_size=Vector2( 72, 72 ) ui/inventory_item_size=Vector2( 72, 72 )
ui/dialog_managers=[ "res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/esc_dialog_simple.gd" ] ui/dialog_managers=[ "res://gymkhana/addons/escoria-ui-return-monkey-island-dialog-simple/rtmi_dialog_simple.gd" ]
sound/master_volume=1 sound/master_volume=1
sound/music_volume=1 sound/music_volume=1
sound/sfx_volume=1 sound/sfx_volume=1
@@ -902,16 +902,16 @@ ui/tooltip_follows_mouse=false
main/escoria_version="" main/escoria_version=""
ui/default_dialog_scene="res://addons/escoria-core/game/scenes/dialogs/esc_dialog_player.gd" ui/default_dialog_scene="res://addons/escoria-core/game/scenes/dialogs/esc_dialog_player.gd"
main/action_default_script="res://action_defaults.esc" main/action_default_script="res://action_defaults.esc"
dialog_simple/text_speed_per_character=0.1 rtmi_dialog_simple/text_speed_per_character=0.1
dialog_simple/fast_text_speed_per_character=0.25 rtmi_dialog_simple/fast_text_speed_per_character=0.25
ui/default_dialog_type="floating" ui/default_dialog_type="floating"
dialog_simple/avatars_path="res://game/dialog_avatars" rtmi_dialog_simple/avatars_path="res://game/dialog_avatars"
dialog_simple/text_time_per_letter_ms=100 rtmi_dialog_simple/text_time_per_letter_ms=100
dialog_simple/text_time_per_fast_letter_ms=25 rtmi_dialog_simple/text_time_per_fast_letter_ms=25
dialog_simple/clear_text_by_click_only=false rtmi_dialog_simple/clear_text_by_click_only=false
dialog_simple/reading_speed_in_wpm=200 rtmi_dialog_simple/reading_speed_in_wpm=200
dialog_simple/left_click_action="Speed up" rtmi_dialog_simple/left_click_action="Speed up"
dialog_simple/stop_talking_animation_on="End of audio" rtmi_dialog_simple/stop_talking_animation_on="End of audio"
debug/enable_hover_stack_viewer=true debug/enable_hover_stack_viewer=true
ui/dialogs_chooser="res://addons/escoria-core/game/scenes/dialogs/esc_dialog_options_chooser.gd" ui/dialogs_chooser="res://addons/escoria-core/game/scenes/dialogs/esc_dialog_options_chooser.gd"