EditorProperty

Custom control to edit properties for adding into the inspector.

This control allows property editing for one or multiple properties into EditorInspector. It is added via EditorInspectorPlugin.

@GodotBaseClass

struct EditorProperty {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(EditorProperty other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static EditorProperty _new();

void _focusableFocused(long arg0);

void _guiInput(InputEvent arg0);

void addFocusable(Control control);

void emitChanged(String property, VariantArg1 value, String field, bool changing);

GodotObject getEditedObject();

String getEditedProperty();

String getLabel();

String getTooltipText();

bool isCheckable();

bool isChecked();

bool isDrawRed();

bool isKeying();

bool isReadOnly();

void setBottomEditor(Control editor);

void setCheckable(bool checkable);

void setChecked(bool checked);

void setDrawRed(bool draw_red);

void setKeying(bool keying);

void setLabel(String text);

void setReadOnly(bool read_only);

void updateProperty();

bool checkable [@property getter];

bool checkable [@property setter];

bool checked [@property getter];

bool checked [@property setter];

bool drawRed [@property getter];

bool drawRed [@property setter];

bool keying [@property getter];

bool keying [@property setter];

String label [@property getter];

String label [@property setter];

bool readOnly [@property getter];

bool readOnly [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

_focusableFocused void _focusableFocused(long arg0)
_guiInput void _guiInput(InputEvent arg0)
addFocusable void addFocusable(Control control): If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed.
emitChanged void emitChanged(String property, VariantArg1 value, String field, bool changing): If one or several properties have changed, this must be called. field is used in case your editor can modify fields separately (as an example, Vector3.x). The changing argument avoids the editor requesting this property to be refreshed (leave as false if unsure).
getEditedObject GodotObject getEditedObject(): Gets the edited object.
getEditedProperty String getEditedProperty(): Gets the edited property. If your editor is for a single property (added via EditorInspectorPlugin.parseProperty), then this will return the property.
getLabel String getLabel()
getTooltipText String getTooltipText(): Must be implemented to provide a custom tooltip to the property editor.
isCheckable bool isCheckable()
isChecked bool isChecked()
isDrawRed bool isDrawRed()
isKeying bool isKeying()
isReadOnly bool isReadOnly()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(EditorProperty other)
opEquals bool opEquals(typeof(null) n)
setBottomEditor void setBottomEditor(Control editor): Puts the editor control below the property label. The control must be previously added using Node.addChild.
setCheckable void setCheckable(bool checkable)
setChecked void setChecked(bool checked)
setDrawRed void setDrawRed(bool draw_red)
setKeying void setKeying(bool keying)
setLabel void setLabel(String text)
setReadOnly void setReadOnly(bool read_only)
toHash size_t toHash()
updateProperty void updateProperty(): When this virtual function is called, you must update your editor.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

checkable bool checkable [@property getter]
bool checkable [@property setter]: Used by the inspector, set to true when the property is checkable.
checked bool checked [@property getter]
bool checked [@property setter]: Used by the inspector, set to true when the property is checked.
drawRed bool drawRed [@property getter]
bool drawRed [@property setter]: Used by the inspector, set to true when the property must draw with error color. This is used for editable children's properties.
keying bool keying [@property getter]
bool keying [@property setter]: Used by the inspector, set to true when the property can add keys for animation.
label String label [@property getter]
String label [@property setter]: Set this property to change the label (if you want to show one).
readOnly bool readOnly [@property getter]
bool readOnly [@property setter]: Used by the inspector, set to true when the property is read-only.

Static functions

_new EditorProperty _new(): Construct a new instance of EditorProperty. Note: use memnew!EditorProperty instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot editorproperty structs

EditorProperty