Files
sor/Client/origin-client/autoloads/Settings.gd
T

179 lines
6.0 KiB
GDScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
extends Node
## Settings autoload — persists audio volume/mute preferences.
##
## Usage from any scene:
## Settings.music_volume → float 0.0–1.0
## Settings.music_muted → bool
## Settings.sfx_volume → float 0.0–1.0
## Settings.sfx_muted → bool
##
## Changing any property automatically applies it to the AudioServer and saves.
const SAVE_PATH := "user://settings.cfg"
const SECTION := "audio"
const SECTION_GAMEPLAY := "gameplay"
const SECTION_VISUAL := "visual"
const SECTION_HIGHLIGHTS := "highlights"
const SECTION_CAMERA := "camera"
## Audio bus names as configured in the Godot project.
const BUS_MUSIC := "Music"
const BUS_SFX := "SFX"
signal settings_changed
var music_volume : float = 1.0 :
set(v):
music_volume = clampf(v, 0.0, 1.0)
_apply_music()
_save()
settings_changed.emit()
var music_muted : bool = false :
set(v):
music_muted = v
_apply_music()
_save()
settings_changed.emit()
var sfx_volume : float = 1.0 :
set(v):
sfx_volume = clampf(v, 0.0, 1.0)
_apply_sfx()
_save()
settings_changed.emit()
var sfx_muted : bool = false :
set(v):
sfx_muted = v
_apply_sfx()
_save()
settings_changed.emit()
## When true, clicking a friendly unit slowly pans the camera to center on it.
var camera_follow_unit : bool = true :
set(v):
camera_follow_unit = v
_save()
settings_changed.emit()
## When true, clicking any tile smoothly pans the camera to center on it.
var click_to_focus_camera : bool = false :
set(v):
click_to_focus_camera = v
_save()
settings_changed.emit()
## Skybox display mode in gameplay scenes.
## "live" — near-black sky with emissive stars; each star = an active game session.
## "cdn" — server-configured panoramic or animated skybox image.
## "off" — default procedural sky (dark blue gradient).
var skybox_mode : String = "live" :
set(v):
skybox_mode = v
_save()
settings_changed.emit()
## How touch camera control is activated.
## "gesture" — hold finger(s) still for 3 s to activate (1 = orbit, 2 = zoom, 3 = pan).
## "buttons" — tap the on-screen Orbit / Pan / Zoom toggle buttons.
var touch_camera_mode : String = "gesture" :
set(v):
touch_camera_mode = v
_save()
settings_changed.emit()
## Per-type highlight texture URL overrides entered by the player.
## Keys: "movement", "attack", "ability", "terramorpha", "selector"
## Value: URL string, or "" to use the server default.
var highlight_overrides : Dictionary = {} :
set(v):
highlight_overrides = v
_apply_highlight_overrides()
_save()
settings_changed.emit()
func set_highlight_override(type: String, url: String) -> void:
var key := type.to_lower()
if url.is_empty():
highlight_overrides.erase(key)
else:
highlight_overrides[key] = url
_apply_highlight_overrides()
_save()
settings_changed.emit()
func clear_highlight_override(type: String) -> void:
set_highlight_override(type.to_lower(), "")
# ── Lifecycle ─────────────────────────────────────────────────────────────────
func _ready() -> void:
_load()
_apply_music()
_apply_sfx()
# ── Internal ──────────────────────────────────────────────────────────────────
func _apply_music() -> void:
var idx := AudioServer.get_bus_index(BUS_MUSIC)
if idx < 0:
return
AudioServer.set_bus_volume_db(idx, linear_to_db(music_volume) if not music_muted else -80.0)
AudioServer.set_bus_mute(idx, music_muted)
func _apply_highlight_overrides() -> void:
if not is_node_ready():
return
# Wait until HighlightConfig has initialised (it's an autoload, loaded after Settings).
if not Engine.has_singleton("HighlightConfig"):
return
HighlightConfig.clear_all_overrides()
for key in highlight_overrides:
var url : String = str(highlight_overrides[key])
if not url.is_empty():
HighlightConfig.set_override(key, { "cdnPath": url, "isAnimated": false,
"frameCount": 1, "fps": 12.0, "fallbackHex": "" })
func _apply_sfx() -> void:
var idx := AudioServer.get_bus_index(BUS_SFX)
if idx < 0:
return
AudioServer.set_bus_volume_db(idx, linear_to_db(sfx_volume) if not sfx_muted else -80.0)
AudioServer.set_bus_mute(idx, sfx_muted)
func _load() -> void:
var cfg := ConfigFile.new()
if cfg.load(SAVE_PATH) != OK:
return
music_volume = float(cfg.get_value(SECTION, "music_volume", 1.0))
music_muted = bool(cfg.get_value(SECTION, "music_muted", false))
sfx_volume = float(cfg.get_value(SECTION, "sfx_volume", 1.0))
sfx_muted = bool(cfg.get_value(SECTION, "sfx_muted", false))
camera_follow_unit = bool(cfg.get_value(SECTION_GAMEPLAY, "camera_follow_unit", true))
click_to_focus_camera = bool(cfg.get_value(SECTION_GAMEPLAY, "click_to_focus_camera", false))
touch_camera_mode = str(cfg.get_value(SECTION_CAMERA, "touch_camera_mode", "gesture"))
skybox_mode = str(cfg.get_value(SECTION_VISUAL, "skybox_mode", "live"))
var raw_overrides = cfg.get_value(SECTION_HIGHLIGHTS, "highlight_overrides", {})
if raw_overrides is Dictionary:
highlight_overrides = raw_overrides as Dictionary
func _save() -> void:
var cfg := ConfigFile.new()
cfg.set_value(SECTION, "music_volume", music_volume)
cfg.set_value(SECTION, "music_muted", music_muted)
cfg.set_value(SECTION, "sfx_volume", sfx_volume)
cfg.set_value(SECTION, "sfx_muted", sfx_muted)
cfg.set_value(SECTION_GAMEPLAY, "camera_follow_unit", camera_follow_unit)
cfg.set_value(SECTION_GAMEPLAY, "click_to_focus_camera", click_to_focus_camera)
cfg.set_value(SECTION_CAMERA, "touch_camera_mode", touch_camera_mode)
cfg.set_value(SECTION_VISUAL, "skybox_mode", skybox_mode)
cfg.set_value(SECTION_HIGHLIGHTS, "highlight_overrides", highlight_overrides)
cfg.save(SAVE_PATH)