ESCProjectSettingsManager

Extends: Node

Description

Registers and allows access to Escoria-specific project settings.

Constants Descriptions

AVATARS_PATH

const AVATARS_PATH: String = "escoria/dialog_simple/avatars_path"

COMMAND_DIRECTORIES

const COMMAND_DIRECTORIES: String = "escoria/main/command_directories"

CRASH_MESSAGE

const CRASH_MESSAGE: String = "escoria/debug/crash_message"

DEFAULT_DIALOG_TYPE

const DEFAULT_DIALOG_TYPE: String = "escoria/ui/default_dialog_type"

DEFAULT_TRANSITION

const DEFAULT_TRANSITION: String = "escoria/ui/default_transition"

DEVELOPMENT_LANG

const DEVELOPMENT_LANG: String = "escoria/debug/development_lang"

DIALOG_MANAGERS

const DIALOG_MANAGERS: String = "escoria/ui/dialog_managers"

ENABLE_ROOM_SELECTOR

const ENABLE_ROOM_SELECTOR: String = "escoria/debug/enable_room_selector"

FAST_TEXT_SPEED_PER_CHARACTER

const FAST_TEXT_SPEED_PER_CHARACTER: String = "escoria/dialog_simple/fast_text_speed_per_character"

FORCE_QUIT

const FORCE_QUIT: String = "escoria/main/force_quit"

GAME_MIGRATION_PATH

const GAME_MIGRATION_PATH: String = "escoria/main/game_migration_path"

GAME_SCENE

const GAME_SCENE: String = "escoria/ui/game_scene"

GAME_START_SCRIPT

const GAME_START_SCRIPT: String = "escoria/main/game_start_script"

GAME_VERSION

const GAME_VERSION: String = "escoria/main/game_version"

INVENTORY_ITEM_SIZE

const INVENTORY_ITEM_SIZE: String = "escoria/ui/inventory_item_size"

ITEMS_AUTOREGISTER_PATH

const ITEMS_AUTOREGISTER_PATH: String = "escoria/ui/items_autoregister_path"

LOG_FILE_PATH

const LOG_FILE_PATH: String = "escoria/debug/log_file_path"

LOG_LEVEL

const LOG_LEVEL: String = "escoria/debug/log_level"

MASTER_VOLUME

const MASTER_VOLUME: String = "escoria/sound/master_volume"

MAX_TIME_TO_DISAPPEAR

const MAX_TIME_TO_DISAPPEAR: String = "escoria/dialog_simple/max_time_to_disappear"

MUSIC_VOLUME

const MUSIC_VOLUME: String = "escoria/sound/music_volume"

ROOM_SELECTOR_ROOM_DIR

const ROOM_SELECTOR_ROOM_DIR: String = "escoria/debug/room_selector_room_dir"

SAVEGAMES_PATH

const SAVEGAMES_PATH: String = "escoria/main/savegames_path"

SETTINGS_PATH

const SETTINGS_PATH: String = "escoria/main/settings_path"

SFX_VOLUME

const SFX_VOLUME: String = "escoria/sound/sfx_volume"

SKIP_CACHE

const SKIP_CACHE: String = "escoria/platform/skip_cache"

SKIP_CACHE_MOBILE

const SKIP_CACHE_MOBILE: String = "escoria/platform/skip_cache.mobile"

SPEECH_ENABLED

const SPEECH_ENABLED: String = "escoria/sound/speech_enabled"

SPEECH_EXTENSION

const SPEECH_EXTENSION: String = "escoria/sound/speech_extension"

SPEECH_FOLDER

const SPEECH_FOLDER: String = "escoria/sound/speech_folder"

SPEECH_VOLUME

const SPEECH_VOLUME: String = "escoria/sound/speech_volume"

TERMINATE_ON_ERRORS

const TERMINATE_ON_ERRORS: String = "escoria/debug/terminate_on_errors"

TERMINATE_ON_WARNINGS

const TERMINATE_ON_WARNINGS: String = "escoria/debug/terminate_on_warnings"

TEXT_LANG

const TEXT_LANG: String = "escoria/main/text_lang"

TEXT_SPEED_PER_CHARACTER

const TEXT_SPEED_PER_CHARACTER: String = "escoria/dialog_simple/text_speed_per_character"

TRANSITION_PATHS

const TRANSITION_PATHS: String = "escoria/ui/transition_paths"

VOICE_LANG

const VOICE_LANG: String = "escoria/main/voice_lang"

Method Descriptions

register_setting

func register_setting(name: String, default, info: Dictionary) -> void

Register a new project setting if it hasn’t been defined already

Parameters

  • name: Name of the project setting

  • default: Default value

  • info: Property info for the setting

get_setting

func get_setting(key: String)

Retrieves the specified project setting.

Parameters

  • key: Project setting name.

Returns the value of the project setting located with key.

set_setting

func set_setting(key: String, value) -> void

Sets the specified project setting to the provided value.

Parameters

  • key: Project setting name.

  • value: Project setting value.

has_setting

func has_setting(key: String) -> bool

Simple wrapper for consistency’s sake.

Parameters

  • key: Project setting name.

Returns true iff the project setting exists.