EditorSettings¶

Inherits: Resource < Reference < Object

Objeto que contiene la configuración del editor independiente del proyecto.

Descripción¶

Objeto que contiene la configuración del editor independiente del proyecto. Estos ajustes son generalmente visibles en el menú Editor > Ajustes del editor.

Los nombres de las propiedades utilizan delimitadores de barra para distinguir las secciones. Los valores de los ajustes pueden ser de cualquier tipo Variant. Se recomienda utilizar snake_case para que los ajustes del editor sean coherentes con el propio editor Godot.

Se puede acceder a los ajustes mediante los siguientes métodos, como por ejemplo:

# `settings.set("alguna/propiedade", valor)` también funciona ya que esta clase anula `_set()` internamente.
settings.set_setting("some/property",value)

# `settings.get("alguna/propiedad", value)` también funciona ya que esta clase anula `_get()` internamente.
settings.get_setting("alguna/propiedad")

var lista_de_configuracion = settings.get_property_list()

Nota: Esta clase no debe ser instanciada directamente. En su lugar, accede al singleton usando EditorInterface.get_editor_settings.

Métodos¶

void	add_property_info ( Dictionary info )
void	erase ( String property )
PoolStringArray	get_favorites ( ) const
Variant	get_project_metadata ( String section, String key, Variant default=null ) const
String	get_project_settings_dir ( ) const
PoolStringArray	get_recent_dirs ( ) const
Variant	get_setting ( String name ) const
String	get_settings_dir ( ) const
bool	has_setting ( String name ) const
bool	property_can_revert ( String name )
Variant	property_get_revert ( String name )
void	set_favorites ( PoolStringArray dirs )
void	set_initial_value ( String name, Variant value, bool update_current )
void	set_project_metadata ( String section, String key, Variant data )
void	set_recent_dirs ( PoolStringArray dirs )
void	set_setting ( String name, Variant value )

Señales¶

settings_changed ( )

Emitido después de que cualquier ajuste del editor haya cambiado.

Constantes¶

NOTIFICATION_EDITOR_SETTINGS_CHANGED = 10000 --- Emitido después de que cualquier ajuste del editor haya cambiado. Es usado por varios plugins de edición para actualizar sus visuales en los cambios de temas o la lógica en los cambios de configuración.

Descripciones de Métodos¶

void add_property_info ( Dictionary info )

Añade una información de propiedad personalizada a una propiedad. El diccionario debe contener:

name: String (el nombre de la propiedad)
type: int (véase Variant.Type)
opcionalmente sugerencia: int (ver PropertyHint) y hint_string: String

Ejemplo:

editor_settings.set("category/property_name", 0)

var informacion_propiedad = {
    "name": "categoria/nombre_propiedad",
    "type": TYPE_INT,
    "hint": PROPERTY_HINT_ENUM,
    "hint_string": "uno, dos, tres"
}

editor_settings.add_property_info(property_info)

void erase ( String property )

Borra el ajuste cuyo nombre se especifica en property.

PoolStringArray get_favorites ( ) const

Devuelve la lista de archivos y directorios favoritos para este proyecto.

Variant get_project_metadata ( String section, String key, Variant default=null ) const

Devuelve los metadatos específicos del proyecto para la section y la key especificados. Si los metadatos no existen, se devolverá en su lugar default. Véase también set_project_metadata.

String get_project_settings_dir ( ) const

Devuelve la ruta de configuración específica del proyecto. Todos los proyectos tienen un subdirectorio único dentro de la ruta de ajustes donde se guardan los ajustes específicos del proyecto.

PoolStringArray get_recent_dirs ( ) const

Devuelve la lista de carpetas visitadas recientemente en el diálogo de archivos de este proyecto.

Variant get_setting ( String name ) const

Devuelve el valor del ajuste especificado por name. Esto equivale a usar Object.get en la instancia EditorSettings.

String get_settings_dir ( ) const

Obtiene la ruta de configuración global para el motor. Dentro de esta ruta, puedes encontrar algunas rutas estándar como:

settings/tmp - Se utiliza para el almacenamiento temporal de archivos

settings/templates - Donde se encuentran las plantillas de exportación

bool has_setting ( String name ) const

Devuelve true si existe el ajuste especificado por name, false en caso contrario.

bool property_can_revert ( String name )

Devuelve true si el ajuste especificado por name puede tener su valor revertido al valor por defecto, false en caso contrario. Cuando este método devuelve true, se mostrará un botón Revertir junto al ajuste en los Ajustes del Editor.

Variant property_get_revert ( String name )

Devuelve el valor por defecto del ajuste especificado por name. Este es el valor que se aplicaría al hacer clic en el botón Revertir en los Ajustes del Editor.

void set_favorites ( PoolStringArray dirs )

Establece la lista de archivos y directorios favoritos para este proyecto.

void set_initial_value ( String name, Variant value, bool update_current )

Establece el valor inicial del ajuste especificado por name a value. Esto se usa para proporcionar un valor para el botón Revertir en los Ajustes del Editor. Si update_current es verdadero, el valor actual del ajuste se fijará también en value.

void set_project_metadata ( String section, String key, Variant data )

Establece metadatos específicos para cada proyecto con la section, key y data especificados. Estos metadatos se almacenan fuera de la carpeta del proyecto y, por lo tanto, no se comprobarán en el control de versiones. Ver también get_project_metadata.

void set_recent_dirs ( PoolStringArray dirs )

Establece la lista de carpetas visitadas recientemente en el diálogo de archivos de este proyecto.

void set_setting ( String name, Variant value )

Establece el valor valor del ajuste especificado por name. Esto equivale a utilizar el Object.set en la instancia EditorSettings.