Documentation
¶
Overview ¶
A custom control for editing properties that can be added to the graphics.gd/classdb/EditorInspector. It is added via graphics.gd/classdb/EditorInspectorPlugin.
Index ¶
- type Advanced
- type Any
- type Expanded
- type Extension
- func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
- func (self *Extension[T]) AsContainer() Container.Instance
- func (self *Extension[T]) AsControl() Control.Instance
- func (self *Extension[T]) AsEditorProperty() Instance
- func (self *Extension[T]) AsNode() Node.Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- type ID
- type Implementation
- type Instance
- func (self Instance) AddFocusable(control Control.Instance)
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsContainer() Container.Instance
- func (self Instance) AsControl() Control.Instance
- func (self Instance) AsEditorProperty() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) Checkable() bool
- func (self Instance) Checked() bool
- func (self Instance) Deletable() bool
- func (self Instance) Deselect()
- func (self Instance) DrawBackground() bool
- func (self Instance) DrawLabel() bool
- func (self Instance) DrawWarning() bool
- func (self Instance) EmitChanged(property string, value any)
- func (self Instance) GetEditedObject() Object.Instance
- func (self Instance) GetEditedProperty() string
- func (self Instance) ID() ID
- func (self Instance) IsSelected() bool
- func (self Instance) Keying() bool
- func (self Instance) Label() string
- func (self Instance) NameSplitRatio() Float.X
- func (self Instance) OnMultiplePropertiesChanged(cb func(properties []string, value []any), flags ...Signal.Flags)
- func (self Instance) OnObjectIdSelected(cb func(property string, id int), flags ...Signal.Flags)
- func (self Instance) OnPropertyCanRevertChanged(cb func(property string, can_revert bool), flags ...Signal.Flags)
- func (self Instance) OnPropertyChanged(cb func(property string, value any, field string, changing bool), ...)
- func (self Instance) OnPropertyChecked(cb func(property string, checked bool), flags ...Signal.Flags)
- func (self Instance) OnPropertyDeleted(cb func(property string), flags ...Signal.Flags)
- func (self Instance) OnPropertyFavorited(cb func(property string, favorited bool), flags ...Signal.Flags)
- func (self Instance) OnPropertyKeyed(cb func(property string), flags ...Signal.Flags)
- func (self Instance) OnPropertyKeyedWithValue(cb func(property string, value any), flags ...Signal.Flags)
- func (self Instance) OnPropertyOverridden(cb func(), flags ...Signal.Flags)
- func (self Instance) OnPropertyPinned(cb func(property string, pinned bool), flags ...Signal.Flags)
- func (self Instance) OnResourceSelected(cb func(path string, resource Resource.Instance), flags ...Signal.Flags)
- func (self Instance) OnSelected(cb func(path string, focusable_idx int), flags ...Signal.Flags)
- func (self Instance) ReadOnly() bool
- func (self Instance) Select()
- func (self Instance) Selectable() bool
- func (self Instance) SetBottomEditor(editor Control.Instance)
- func (self Instance) SetCheckable(value bool)
- func (self Instance) SetChecked(value bool)
- func (self Instance) SetDeletable(value bool)
- func (self Instance) SetDrawBackground(value bool)
- func (self Instance) SetDrawLabel(value bool)
- func (self Instance) SetDrawWarning(value bool)
- func (self Instance) SetKeying(value bool)
- func (self Instance) SetLabel(value string)
- func (self Instance) SetLabelReference(control Control.Instance)
- func (self Instance) SetNameSplitRatio(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetObjectAndProperty(obj Object.Instance, property string)
- func (self Instance) SetSelectable(value bool)
- func (self Instance) SetUseFolding(value bool)
- func (self Instance) UpdateProperty()
- func (self Instance) UseFolding() bool
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Expanded ¶
type Expanded [1]gdclass.EditorProperty
func (Expanded) EmitChanged ¶
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).
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
func (*Extension[T]) AsContainer ¶
func (*Extension[T]) AsEditorProperty ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.EditorProperty
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AddFocusable ¶
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.
func (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsContainer ¶
func (Instance) AsEditorProperty ¶
func (Instance) Deselect ¶
func (self Instance) Deselect()
Draw property as not selected. Used by the inspector.
func (Instance) DrawBackground ¶
func (Instance) DrawWarning ¶
func (Instance) EmitChanged ¶
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).
func (Instance) GetEditedObject ¶
Returns the edited object.
Note: This method could return null if the editor has not yet been associated with a property. However, in [Interface.UpdateProperty] and [Interface.SetReadOnly], this value is guaranteed to be non-null.
func (Instance) GetEditedProperty ¶
Returns the edited property. If your editor is for a single property (added via graphics.gd/classdb/EditorInspectorPlugin.Instance.ParseProperty), then this will return the property.
Note: This method could return null if the editor has not yet been associated with a property. However, in [Interface.UpdateProperty] and [Interface.SetReadOnly], this value is guaranteed to be non-null.
func (Instance) IsSelected ¶
Returns true if property is drawn as selected. Used by the inspector.
func (Instance) NameSplitRatio ¶
func (Instance) OnMultiplePropertiesChanged ¶
func (Instance) OnObjectIdSelected ¶
func (Instance) OnPropertyCanRevertChanged ¶
func (Instance) OnPropertyChanged ¶
func (Instance) OnPropertyChecked ¶
func (Instance) OnPropertyDeleted ¶
func (Instance) OnPropertyFavorited ¶
func (Instance) OnPropertyKeyed ¶
func (Instance) OnPropertyKeyedWithValue ¶
func (Instance) OnPropertyOverridden ¶
func (Instance) OnPropertyPinned ¶
func (Instance) OnResourceSelected ¶
func (Instance) OnSelected ¶
func (Instance) Select ¶
func (self Instance) Select()
Draw property as selected. Used by the inspector.
func (Instance) Selectable ¶
func (Instance) SetBottomEditor ¶
Puts the 'editor' control below the property label. The control must be previously added using graphics.gd/classdb/Node.Instance.AddChild.
func (Instance) SetCheckable ¶
func (Instance) SetChecked ¶
func (Instance) SetDeletable ¶
func (Instance) SetDrawBackground ¶
func (Instance) SetDrawLabel ¶
func (Instance) SetDrawWarning ¶
func (Instance) SetLabelReference ¶
Used by the inspector, set to a control that will be used as a reference to calculate the size of the label.
func (Instance) SetNameSplitRatio ¶
func (Instance) SetObjectAndProperty ¶
Assigns object and property to edit.
func (Instance) SetSelectable ¶
func (Instance) SetUseFolding ¶
func (Instance) UpdateProperty ¶
func (self Instance) UpdateProperty()
Forces a refresh of the property display.
func (Instance) UseFolding ¶
type Interface ¶
type Interface interface {
// When this virtual function is called, you must update your editor.
UpdateProperty()
// Called when the read-only status of the property is changed. It may be used to change custom controls into a read-only or modifiable state.
SetReadOnly(read_only bool)
}
Source Files