Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
EditorInspector
Hérite de : ScrollContainer < Container < Control < CanvasItem < Node < Object
Un contrôle pour modifier les propriétés d'un objet.
Description
Il s'agit du contrôle qui permet l'édition des propriétés dans les dialogues des Paramètres de l'éditeur, le dock Inspecteur, etc. Pour obtenir le EditorInspector utilisé dans le fichier d'inspecteur de l'éditeur, utilisez EditorInterface.get_inspector()
EditorInspector affichera les propriétés dans le même ordre que le tableau retourné par Object.get_property_list()
Si le nom d'un propriété établie est semblable à celui d'un chemin (c'est-à-dire s'il commence par des barres obliques), EditorInspector créera des sections imbriquées pour les « dossier » suivant le chemin. Par exemple, si une propriété est nommée highlighting/gdscript/node_path_color, elle sera affichée comme "Node Path Color" dans la section "GDScript" imbriquée dans la section "Highlighting".
Si une propriété a l'usage @GlobalScope.PROPERTY_USAGE_GROUP, elle regroupera les propriétés dont le nom commence par la chaîne d'indice de la propriété. Le groupe se termine quand une propriété ne commence pas avec cette chaîne d'indice ou quand un nouveau groupe commence. Un nom de groupe vide termine le groupe actuel. EditorInspector créera une section tout en haut pour chaque groupe. Par exemple, si une propriété avec l'utilisation de groupe est nommée Collide With et que sa chaîne d'indice est collide_with, une propriété collide_with_area suivante sera affichée comme "Area" dans la section "Collide With". Il y a aussi un cas spécial : lorsque la chaîne hint contient le nom d'une propriété, cette propriété est regroupée aussi. C'est principalement pour aider à grouper des propriétés comme font, font_color et font_size (en utilisant la chaîne hint font_).
Si une propriété a @GlobalScope.PROPERTY_USAGE_SUBGROUP usage, un sous-groupe sera créé de la même manière qu'un groupe, et une section de deuxième niveau sera créée pour chaque sous-groupe.
Note : Contrairement aux sections créées à partir de noms de propriété selon des chemins, EditorInspector a obtenu le nom de sections créées à partir de groupes. Ainsi, les propriétés avec l'utilisation de groupe utilisent généralement des noms capitalisés au lieu des noms en "snake_case".
Propriétés
draw_focus_border |
|
|
focus_mode |
|
|
follow_focus |
|
|
horizontal_scroll_mode |
|
Méthodes
void |
|
create_default_inspector(filter_line_edit: LineEdit = null) static |
|
void |
|
void |
|
void |
|
get_selected_path() const |
|
instantiate_property_editor(object: Object, type: Variant.Type, path: String, hint: PropertyHint, hint_text: String, usage: int, wide: bool = false) static |
Signaux
edited_object_changed() 🔗
Emitted when the object being edited by the inspector has changed.
Emitted when the Edit button of an Object has been pressed in the inspector. This is mainly used in the remote scene tree Inspector.
property_deleted(property: String) 🔗
Emitted when a property is removed from the inspector.
property_edited(property: String) 🔗
Émis lorsqu'une propriété est modifiée dans l'inspecteur.
property_keyed(property: String, value: Variant, advance: bool) 🔗
Émis lorsqu'une propriété est utilisée comme clé dans l'inspecteur. Les propriétés peuvent être utilisées comme clé en cliquant sur l'icône "clé" à côté d'une propriété lorsque le panneau "Animation" est ouvert.
property_selected(property: String) 🔗
Émis lorsqu'une propriété est sélectionnée dans l'inspecteur.
property_toggled(property: String, checked: bool) 🔗
Émis lorsqu'une propriété booléenne est basculée dans l'inspecteur.
Note : Ce signal n'est jamais émis si la propriété interne autoclear est activée. Comme cette propriété est toujours activée dans l'inspecteur de l'éditeur, ce signal n'est jamais émis par l'éditeur lui-même.
resource_selected(resource: Resource, path: String) 🔗
Émis quand une ressource est sélectionnée dans l'inspecteur.
restart_requested() 🔗
Emitted when a property that requires a restart to be applied is edited in the inspector. This is only used in the Project Settings and Editor Settings.
Descriptions des méthodes
void collapse_all_folding() 🔗
Collapses all foldable sections.
EditorInspector create_default_inspector(filter_line_edit: LineEdit = null) static 🔗
Creates an inspector with the same configuration as the one used in the editor's Inspector dock. When passing a LineEdit into filter_line_edit, the inspector will filter its properties based on LineEdit.text whenever LineEdit.text_changed is emitted.
Shows the properties of the given object in this inspector for editing. To clear the inspector, call this method with null.
Note: If you want to edit an object in the editor's main inspector, use the edit_* methods in EditorInterface instead.
void expand_all_folding() 🔗
Expands all foldable sections.
void expand_revertable() 🔗
Expands only the foldable sections that contain a revertable (i.e. non-default) property.
Renvoie l'objet actuellement sélectionné dans cet inspecteur.
String get_selected_path() const 🔗
Obtient le chemin de la propriété actuellement sélectionnée.
EditorProperty instantiate_property_editor(object: Object, type: Variant.Type, path: String, hint: PropertyHint, hint_text: String, usage: int, wide: bool = false) static 🔗
Creates a property editor that can be used by plugin UI to edit the specified property of an object.