game_settings_panel.gd

Go to the documentation of this file.

extends RefCounted
 
 
 
const DataCacheManager = preload("res://scripts/systems/dataCacheManager/data_cache_manager.gd")
 
var data_cache_manager = DataCacheManager.new()
 
 
 
func load_definition(file_path:String) -> Dictionary:
    return normalize_definition(data_cache_manager.load_json(file_path))
 
 
 
func normalize_definition(data) -> Dictionary:
    return data.duplicate(true) if data is Dictionary else {}
 
 
 
func get_cache_stats() -> Dictionary:
    return data_cache_manager.get_cache_stats()
 
 
 
func get_default_state(definition:Dictionary) -> Dictionary:
    var state := {}
    for setting in definition.get("settings", []):
        if setting is Dictionary:
            var id = str(setting.get("id", ""))
            if id != "":
                state[id] = setting.get("default")
    return state
 
 
 
func create(definition:Dictionary, state:Dictionary = {}, changed_callback:Callable = Callable()) -> Dictionary:
    var root = VBoxContainer.new()
    root.name = str(definition.get("name", "GameSettingsPanel"))
    root.size_flags_horizontal = Control.SIZE_EXPAND_FILL
    root.add_theme_constant_override("separation", int(definition.get("separation", 8)))
    var controls := {}
    var title_text = str(definition.get("title", "Game Settings"))
    if title_text != "":
        var title = Label.new()
        title.name = "Title"
        title.text = title_text
        title.horizontal_alignment = HORIZONTAL_ALIGNMENT_CENTER
        root.add_child(title)
    for setting in definition.get("settings", []):
        if not setting is Dictionary:
            continue
        var id = str(setting.get("id", ""))
        if id == "":
            continue
        var row = _build_row(setting, state.get(id, setting.get("default")), changed_callback)
        root.add_child(row.get("row"))
        controls[id] = row.get("control")
    return {"root": root, "controls": controls}
 
 
 
func read_state(controls:Dictionary) -> Dictionary:
    var state := {}
    for id in controls.keys():
        var control = controls[id]
        if control is CheckBox:
            state[str(id)] = control.button_pressed
        elif control is HSlider:
            state[str(id)] = control.value
        elif control is SpinBox:
            state[str(id)] = control.value
        elif control is OptionButton:
            state[str(id)] = control.get_item_metadata(control.selected) if control.selected >= 0 else ""
        elif control is LineEdit:
            state[str(id)] = control.text
    return state
 
 
 
func apply_state(controls:Dictionary, state:Dictionary) -> void:
    for id in state.keys():
        if not controls.has(id):
            continue
        var control = controls[id]
        var value = state[id]
        if control is CheckBox:
            control.button_pressed = bool(value)
        elif control is HSlider:
            control.value = float(value)
        elif control is SpinBox:
            control.value = float(value)
        elif control is OptionButton:
            _select_option_by_value(control, value)
        elif control is LineEdit:
            control.text = str(value)
 
 
func _build_row(setting:Dictionary, value, changed_callback:Callable) -> Dictionary:
    var row = HBoxContainer.new()
    row.name = str(setting.get("row_name", "%sRow" % _node_name(str(setting.get("id", "Setting")))))
    row.size_flags_horizontal = Control.SIZE_EXPAND_FILL
    row.add_theme_constant_override("separation", 8)
    var label = Label.new()
    label.name = "Label"
    label.text = str(setting.get("label", setting.get("id", "")))
    label.custom_minimum_size = Vector2(float(setting.get("label_width", 132.0)), 0.0)
    label.autowrap_mode = TextServer.AUTOWRAP_WORD_SMART
    row.add_child(label)
    var value_label:Label = null
    if bool(setting.get("show_value", false)):
        value_label = Label.new()
        value_label.name = "Value"
        value_label.custom_minimum_size = Vector2(float(setting.get("value_width", 64.0)), 0.0)
        value_label.horizontal_alignment = HORIZONTAL_ALIGNMENT_RIGHT
        value_label.text = _format_value(setting, value if value != null else setting.get("default"))
    var control = _make_control(setting, value, changed_callback, value_label)
    row.add_child(control)
    if value_label != null:
        row.add_child(value_label)
    return {"row": row, "control": control}
 
 
func _make_control(setting:Dictionary, value, changed_callback:Callable, value_label:Label = null) -> Control:
    var type = str(setting.get("type", "checkbox"))
    var id = str(setting.get("id", "setting"))
    match type:
        "slider":
            var slider = HSlider.new()
            slider.name = str(setting.get("control_name", _node_name(id)))
            slider.min_value = float(setting.get("min", 0.0))
            slider.max_value = float(setting.get("max", 1.0))
            slider.step = float(setting.get("step", 0.01))
            slider.value = float(value if value != null else setting.get("default", slider.min_value))
            slider.size_flags_horizontal = Control.SIZE_EXPAND_FILL
            slider.value_changed.connect(func(next_value):
                if value_label != null:
                    value_label.text = _format_value(setting, next_value)
                _emit_change(changed_callback, id, next_value)
            )
            return slider
        "number":
            var spin = SpinBox.new()
            spin.name = str(setting.get("control_name", _node_name(id)))
            spin.min_value = float(setting.get("min", 0.0))
            spin.max_value = float(setting.get("max", 100.0))
            spin.step = float(setting.get("step", 1.0))
            spin.value = float(value if value != null else setting.get("default", spin.min_value))
            spin.size_flags_horizontal = Control.SIZE_EXPAND_FILL
            spin.value_changed.connect(func(next_value):
                if value_label != null:
                    value_label.text = _format_value(setting, next_value)
                _emit_change(changed_callback, id, next_value)
            )
            return spin
        "option":
            var option = OptionButton.new()
            option.name = str(setting.get("control_name", _node_name(id)))
            option.size_flags_horizontal = Control.SIZE_EXPAND_FILL
            for entry in setting.get("options", []):
                if entry is Dictionary:
                    option.add_item(str(entry.get("label", entry.get("value", ""))))
                    option.set_item_metadata(option.item_count - 1, entry.get("value", entry.get("id", "")))
                else:
                    option.add_item(str(entry))
                    option.set_item_metadata(option.item_count - 1, str(entry))
            _select_option_by_value(option, value if value != null else setting.get("default", ""))
            option.item_selected.connect(func(_index): _emit_change(changed_callback, id, option.get_item_metadata(option.selected)))
            return option
        "text":
            var edit = LineEdit.new()
            edit.name = str(setting.get("control_name", _node_name(id)))
            edit.text = str(value if value != null else setting.get("default", ""))
            edit.size_flags_horizontal = Control.SIZE_EXPAND_FILL
            edit.text_changed.connect(func(next_text): _emit_change(changed_callback, id, next_text))
            return edit
        _:
            var check = CheckBox.new()
            check.name = str(setting.get("control_name", _node_name(id)))
            check.text = str(setting.get("checkbox_text", ""))
            check.button_pressed = bool(value if value != null else setting.get("default", false))
            check.size_flags_horizontal = Control.SIZE_EXPAND_FILL
            check.toggled.connect(func(next_value): _emit_change(changed_callback, id, next_value))
            return check
 
 
func _select_option_by_value(option:OptionButton, value) -> void:
    for index in range(option.item_count):
        if str(option.get_item_metadata(index)) == str(value):
            option.select(index)
            return
    if option.item_count > 0:
        option.select(0)
 
 
func _emit_change(callback:Callable, id:String, value) -> void:
    if callback.is_valid():
        callback.call(id, value)
 
 
func _format_value(setting:Dictionary, value) -> String:
    match str(setting.get("format", "")):
        "percent":
            return "%d%%" % int(float(value) * 100.0)
        "seconds":
            return "%.1fs" % float(value)
        "multiplier":
            return "%.2fx" % float(value)
        "integer":
            return "%d" % int(float(value))
    var suffix := str(setting.get("suffix", ""))
    if suffix != "":
        return "%s%s" % [str(value), suffix]
    return str(value)
 
 
func _node_name(value:String) -> String:
    var parts = value.replace("-", "_").split("_")
    var text := ""
    for part in parts:
        text += str(part).capitalize()
    return text if text != "" else "Setting"