EditorInspectorPlugin

Plugin for adding custom property editors on inspector.

These plugins allow adding custom property editors to EditorInspector. Plugins are registered via EditorPlugin.addInspectorPlugin. When an object is edited, the canHandle function is called and must return true if the object type is supported. If supported, the function parseBegin will be called, allowing to place custom controls at the beginning of the class. Subsequently, the parseCategory and parseProperty are called for every category and property. They offer the ability to add custom controls to the inspector too. Finally, parseEnd will be called. On each of these calls, the "add" functions can be called.

Members

Aliases

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

Functions

addCustomControl
void addCustomControl(Control control)

Adds a custom control, which is not necessarily a property editor.

addPropertyEditor
void addPropertyEditor(String property, Control editor)

Adds a property editor for an individual property. The editor control must extend EditorProperty.

addPropertyEditorForMultipleProperties
void addPropertyEditorForMultipleProperties(String label, PoolStringArray properties, Control editor)

Adds an editor that allows modifying multiple properties. The editor control must extend EditorProperty.

canHandle
bool canHandle(GodotObject object)

Returns true if this object can be handled by this plugin.

opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(EditorInspectorPlugin other)
opEquals
bool opEquals(typeof(null) n)
parseBegin
void parseBegin(GodotObject object)

Called to allow adding controls at the beginning of the list.

parseCategory
void parseCategory(GodotObject object, String category)

Called to allow adding controls at the beginning of the category.

parseEnd
void parseEnd()

Called to allow adding controls at the end of the list.

parseProperty
bool parseProperty(GodotObject object, long type, String path, long hint, String hint_text, long usage)

Called to allow adding property specific editors to the inspector. Usually these inherit EditorProperty. Returning true removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.

toHash
size_t toHash()

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Static functions

_new
EditorInspectorPlugin _new()

Construct a new instance of EditorInspectorPlugin. Note: use memnew!EditorInspectorPlugin 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