From df97602c6d7335d0a8c83cddefef8716e47c37a0 Mon Sep 17 00:00:00 2001 From: Nemrav <> Date: Tue, 9 May 2023 21:08:41 -0300 Subject: Add UI scaling through menu option --- game/localisation/en_GB/menus.csv | 1 + game/localisation/en_US/menus.csv | 1 + game/localisation/fr_FR/menus.csv | 1 + game/project.godot | 1 + game/src/Autoload/GuiScale.gd | 65 +++++++++++++++++++++++++++++++++ game/src/GameSession/MapView.gd | 2 +- game/src/OptionMenu/GuiScaleSelector.gd | 65 +++++++++++++++++++++++++++++++++ game/src/OptionMenu/VideoTab.tscn | 18 ++++++++- 8 files changed, 152 insertions(+), 2 deletions(-) create mode 100644 game/src/Autoload/GuiScale.gd create mode 100644 game/src/OptionMenu/GuiScaleSelector.gd (limited to 'game') diff --git a/game/localisation/en_GB/menus.csv b/game/localisation/en_GB/menus.csv index 3c3fff1..6a44f3a 100644 --- a/game/localisation/en_GB/menus.csv +++ b/game/localisation/en_GB/menus.csv @@ -35,6 +35,7 @@ OPTIONS_VIDEO_MONITOR_SELECTION,Monitor Selection OPTIONS_VIDEO_REFRESH_RATE,Refresh Rate OPTIONS_VIDEO_REFRESH_RATE_TOOLTIP,Only change from VSYNC if you are having issues with screen tearing. OPTIONS_VIDEO_QUALITY,Quality Preset +OPTIONS_VIDEO_GUI_SCALE,Gui Scaling Factor ,, Sound Tab MASTER_BUS,Master Volume diff --git a/game/localisation/en_US/menus.csv b/game/localisation/en_US/menus.csv index 807d1cb..88cf12c 100644 --- a/game/localisation/en_US/menus.csv +++ b/game/localisation/en_US/menus.csv @@ -35,6 +35,7 @@ OPTIONS_VIDEO_MONITOR_SELECTION,Monitor Selection OPTIONS_VIDEO_REFRESH_RATE,Refresh Rate OPTIONS_VIDEO_REFRESH_RATE_TOOLTIP,Only change from VSYNC if you are having issues with screen tearing. OPTIONS_VIDEO_QUALITY,Quality Preset +OPTIONS_VIDEO_GUI_SCALE,Gui Scaling Factor ,, Sound Tab MASTER_BUS,Master Volume diff --git a/game/localisation/fr_FR/menus.csv b/game/localisation/fr_FR/menus.csv index 0d84b64..3794695 100644 --- a/game/localisation/fr_FR/menus.csv +++ b/game/localisation/fr_FR/menus.csv @@ -35,6 +35,7 @@ OPTIONS_VIDEO_MONITOR_SELECTION,Sélection du Moniteur OPTIONS_VIDEO_REFRESH_RATE,Taux de Rafraîchissement OPTIONS_VIDEO_REFRESH_RATE_TOOLTIP,Ne changez de VSYNC que si vous rencontrez des problèmes de déchirement d'écran. OPTIONS_VIDEO_QUALITY,Préréglage de la Qualité +OPTIONS_VIDEO_GUI_SCALE,Mise à échelle de l'Interface Graphique ,, Sound Tab MASTER_BUS,Volume Principal diff --git a/game/project.godot b/game/project.godot index a14f910..7201be7 100644 --- a/game/project.godot +++ b/game/project.godot @@ -26,6 +26,7 @@ Resolution="*res://src/Autoload/Resolution.gd" SoundManager="*res://src/Autoload/SoundManager.gd" MusicConductor="*res://src/MusicConductor/MusicConductor.tscn" Keychain="*res://addons/keychain/Keychain.gd" +GuiScale="*res://src/Autoload/GuiScale.gd" [display] diff --git a/game/src/Autoload/GuiScale.gd b/game/src/Autoload/GuiScale.gd new file mode 100644 index 0000000..d134f5b --- /dev/null +++ b/game/src/Autoload/GuiScale.gd @@ -0,0 +1,65 @@ +extends Node + +#the default value +const error_guiscale : float = 1 + +@export +var minimum_guiscale : float = 0.1 + +const _starting_guiscales : Dictionary = { + float(0.5): &"0.5x", + float(0.75): &"0.75x", + float(1): &"1x", + float(1.5): &"1.5x", + float(2): &"2x", +} + +var _guiscales: Dictionary + +#Similar to Resolution.gd, but we don't bother checking for strings from files +#and we have floats instead of vector2 integers + +func _ready(): + assert(minimum_guiscale > 0, "Minimum gui scale must be positive") + for guiscale_value in _starting_guiscales: + add_guiscale(guiscale_value, _starting_guiscales[guiscale_value]) + assert(not _guiscales.is_empty(), "No valid starting gui scales!") + +func has_guiscale(guiscale_value : float) -> bool: + return guiscale_value in _guiscales + +func add_guiscale(guiscale_value: float, guiscale_name: StringName=&"") -> bool: + if has_guiscale(guiscale_value): return true + var scale_dict := { value = guiscale_value } + var display_name := "%sx" % [guiscale_value] + if not guiscale_name.is_empty(): + scale_dict.name = guiscale_name + #don't need to change the display name + scale_dict.display_name = StringName(display_name) + if guiscale_value < minimum_guiscale: + push_error("GUI scale %s is smaller than the minimum %s" % [scale_dict.display_name,minimum_guiscale]) + return false + _guiscales[guiscale_value] = scale_dict + return true + +#returns floats +func get_guiscale_value_list() -> Array: + var list := _guiscales.keys() + list.sort_custom(func(a, b): return a > b) + return list + +func get_guiscale_display_name(guiscale_value : float) -> StringName: + return _guiscales.get(guiscale_value, {display_name = &"unknown gui scale"}).display_name + +func get_current_guiscale() -> float: + return get_tree().root.content_scale_factor + +func set_guiscale(guiscale:float) -> void: + print("New GUI scale: %f" % guiscale) + if not has_guiscale(guiscale): + push_warning("Setting GUI Scale to non-standard value %sx" % [guiscale]) + get_tree().root.content_scale_factor = guiscale + +func reset_guiscale() -> void: + set_guiscale(get_current_guiscale()) + diff --git a/game/src/GameSession/MapView.gd b/game/src/GameSession/MapView.gd index dc62594..c3b5cbb 100644 --- a/game/src/GameSession/MapView.gd +++ b/game/src/GameSession/MapView.gd @@ -175,7 +175,7 @@ func _movement_process(delta : float) -> void: func _edge_scrolling_vector() -> Vector2: if not _mouse_over_viewport: return Vector2() - var mouse_vector := _mouse_pos_viewport / _viewport_dims - Vector2(0.5, 0.5) + var mouse_vector := _mouse_pos_viewport * GuiScale.get_current_guiscale() / _viewport_dims - Vector2(0.5, 0.5) if abs(mouse_vector.x) < 0.5 - _edge_move_threshold and abs(mouse_vector.y) < 0.5 - _edge_move_threshold: mouse_vector *= 0 return mouse_vector * _edge_move_speed diff --git a/game/src/OptionMenu/GuiScaleSelector.gd b/game/src/OptionMenu/GuiScaleSelector.gd new file mode 100644 index 0000000..ec94269 --- /dev/null +++ b/game/src/OptionMenu/GuiScaleSelector.gd @@ -0,0 +1,65 @@ +extends SettingOptionButton + +@export +var default_value : float = GuiScale.error_guiscale + +func _find_guiscale_index_by_value(value : float) -> int: + for item_index in item_count: + if get_item_metadata(item_index) == value: + return item_index + return -1 + +func _sync_guiscales(to_select:float=GuiScale.get_current_guiscale()) -> void: + clear() + default_selected = -1 + selected = -1 + for guiscale_value in GuiScale.get_guiscale_value_list(): + add_item(GuiScale.get_guiscale_display_name(guiscale_value)) + set_item_metadata(item_count - 1, guiscale_value) + + if guiscale_value == default_value: + default_selected = item_count - 1 + + if guiscale_value == to_select: + selected = item_count - 1 + + if default_selected == -1: + default_selected = item_count - 1 + + if selected == -1: + selected = default_selected + +func _setup_button(): + print("Setup Gui scales Button") + if default_value <= 0: + #TODO: verify this project setting is what we actually want + #print("get default from project settings, default was %f",default_value) + default_value = ProjectSettings.get_setting("display/window/stretch/scale") + GuiScale.add_guiscale(default_value,&"default") + _sync_guiscales() + +func _get_value_for_file(select_value : int): + if _valid_index(select_value): + return get_item_metadata(select_value) + else: + return null + +func _set_value_from_file(load_value): + #no need to match types like resolution does since we don't + #intend on supporting strings + var target_guiscale = load_value + selected = _find_guiscale_index_by_value(target_guiscale) + if selected != -1:return + if GuiScale.add_guiscale(target_guiscale): + _sync_guiscales(target_guiscale) + return + push_error("Setting value '%s' invalid for setting [%s] %s" % [load_value, section_name, setting_name]) + selected = default_selected + +func _on_item_selected(index:int): + if _valid_index(index): + print("Change GUI scale on selector index: %d" % index) + GuiScale.set_guiscale(get_item_metadata(index)) + else: + push_error("Invalid GuiScaleSelector index: %d" % index) + reset_setting() diff --git a/game/src/OptionMenu/VideoTab.tscn b/game/src/OptionMenu/VideoTab.tscn index c92f7f7..8fc8747 100644 --- a/game/src/OptionMenu/VideoTab.tscn +++ b/game/src/OptionMenu/VideoTab.tscn @@ -1,8 +1,9 @@ -[gd_scene load_steps=7 format=3 uid="uid://bq3awxxjn1tuw"] +[gd_scene load_steps=8 format=3 uid="uid://bq3awxxjn1tuw"] [ext_resource type="Script" path="res://src/OptionMenu/ResolutionSelector.gd" id="1_i8nro"] [ext_resource type="Script" path="res://src/OptionMenu/VideoTab.gd" id="1_jvv62"] [ext_resource type="Script" path="res://src/OptionMenu/ScreenModeSelector.gd" id="2_wa7vw"] +[ext_resource type="Script" path="res://src/OptionMenu/GuiScaleSelector.gd" id="3_pgc5d"] [ext_resource type="Script" path="res://src/OptionMenu/MonitorDisplaySelector.gd" id="3_y6lyb"] [ext_resource type="Script" path="res://src/OptionMenu/RefreshRateSelector.gd" id="4_381mg"] [ext_resource type="Script" path="res://src/OptionMenu/QualityPresetSelector.gd" id="5_srg4v"] @@ -42,6 +43,20 @@ script = ExtResource("1_i8nro") section_name = "video" setting_name = "resolution" +[node name="GuiScaleLabel" type="Label" parent="VBoxContainer/GridContainer"] +layout_mode = 2 +text = "OPTIONS_VIDEO_GUI_SCALE" + +[node name="GuiScaleSelector" type="OptionButton" parent="VBoxContainer/GridContainer"] +editor_description = "UI-19" +layout_mode = 2 +focus_neighbor_bottom = NodePath("../ScreenModeSelector") +item_count = 1 +selected = 0 +popup/item_0/text = "MISSING" +popup/item_0/id = 0 +script = ExtResource("3_pgc5d") + [node name="ScreenModeLabel" type="Label" parent="VBoxContainer/GridContainer"] editor_description = "UI-44" layout_mode = 2 @@ -138,5 +153,6 @@ setting_name = "quality_preset" default_selected = 1 [connection signal="item_selected" from="VBoxContainer/GridContainer/ResolutionSelector" to="VBoxContainer/GridContainer/ResolutionSelector" method="_on_item_selected"] +[connection signal="item_selected" from="VBoxContainer/GridContainer/GuiScaleSelector" to="VBoxContainer/GridContainer/GuiScaleSelector" method="_on_item_selected"] [connection signal="item_selected" from="VBoxContainer/GridContainer/ScreenModeSelector" to="VBoxContainer/GridContainer/ScreenModeSelector" method="_on_item_selected"] [connection signal="item_selected" from="VBoxContainer/GridContainer/MonitorDisplaySelector" to="VBoxContainer/GridContainer/MonitorDisplaySelector" method="_on_item_selected"] -- cgit v1.2.3-56-ga3b1