EditorInspector

Documentation

Overview

Package EditorInspector provides methods for working with EditorInspector object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsCanvasItem() CanvasItem.Instance
  • func (self Instance) AsContainer() Container.Instance
  • func (self Instance) AsControl() Control.Instance
  • func (self Instance) AsEditorInspector() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsScrollContainer() ScrollContainer.Instance
  • func (self Instance) GetEditedObject() Object.Instance
  • func (self Instance) GetSelectedPath() string
  • func (self Instance) OnEditedObjectChanged(cb func())
  • func (self Instance) OnObjectIdSelected(cb func(id int))
  • func (self Instance) OnPropertyDeleted(cb func(property string))
  • func (self Instance) OnPropertyEdited(cb func(property string))
  • func (self Instance) OnPropertyKeyed(cb func(property string, value any, advance bool))
  • func (self Instance) OnPropertySelected(cb func(property string))
  • func (self Instance) OnPropertyToggled(cb func(property string, checked bool))
  • func (self Instance) OnResourceSelected(cb func(resource [1]gdclass.Resource, path string))
  • func (self Instance) OnRestartRequested(cb func())
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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 Any

type Any interface {
	gd.IsClass
	AsEditorInspector() Instance
}

type Instance

type Instance [1]gdclass.EditorInspector

This is the control that implements property editing in the editor's Settings dialogs, the Inspector dock, etc. To get the [EditorInspector] used in the editor's Inspector dock, use [method EditorInterface.get_inspector]. [EditorInspector] will show properties in the same order as the array returned by [method Object.get_property_list]. If a property's name is path-like (i.e. if it contains forward slashes), [EditorInspector] will create nested sections for "directories" along the path. For example, if a property is named [code]highlighting/gdscript/node_path_color[/code], it will be shown as "Node Path Color" inside the "GDScript" section nested inside the "Highlighting" section. If a property has [constant PROPERTY_USAGE_GROUP] usage, it will group subsequent properties whose name starts with the property's hint string. The group ends when a property does not start with that hint string or when a new group starts. An empty group name effectively ends the current group. [EditorInspector] will create a top-level section for each group. For example, if a property with group usage is named [code]Collide With[/code] and its hint string is [code]collide_with_[/code], a subsequent [code]collide_with_area[/code] property will be shown as "Area" inside the "Collide With" section. There is also a special case: when the hint string contains the name of a property, that property is grouped too. This is mainly to help grouping properties like [code]font[/code], [code]font_color[/code] and [code]font_size[/code] (using the hint string [code]font_[/code]). If a property has [constant PROPERTY_USAGE_SUBGROUP] usage, a subgroup will be created in the same way as a group, and a second-level section will be created for each subgroup. [b]Note:[/b] Unlike sections created from path-like property names, [EditorInspector] won't capitalize the name for sections created from groups. So properties with group usage usually use capitalized names instead of snake_cased names.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsContainer

func (self Instance) AsContainer() Container.Instance

func (Instance) AsControl

func (self Instance) AsControl() Control.Instance

func (Instance) AsEditorInspector

func (self Instance) AsEditorInspector() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsScrollContainer

func (self Instance) AsScrollContainer() ScrollContainer.Instance

func (Instance) GetEditedObject

func (self Instance) GetEditedObject() Object.Instance

Returns the object currently selected in this inspector.

func (Instance) GetSelectedPath

func (self Instance) GetSelectedPath() string

Gets the path of the currently selected property.

func (Instance) OnEditedObjectChanged

func (self Instance) OnEditedObjectChanged(cb func())

func (Instance) OnObjectIdSelected

func (self Instance) OnObjectIdSelected(cb func(id int))

func (Instance) OnPropertyDeleted

func (self Instance) OnPropertyDeleted(cb func(property string))

func (Instance) OnPropertyEdited

func (self Instance) OnPropertyEdited(cb func(property string))

func (Instance) OnPropertyKeyed

func (self Instance) OnPropertyKeyed(cb func(property string, value any, advance bool))

func (Instance) OnPropertySelected

func (self Instance) OnPropertySelected(cb func(property string))

func (Instance) OnPropertyToggled

func (self Instance) OnPropertyToggled(cb func(property string, checked bool))

func (Instance) OnResourceSelected

func (self Instance) OnResourceSelected(cb func(resource [1]gdclass.Resource, path string))

func (Instance) OnRestartRequested

func (self Instance) OnRestartRequested(cb func())

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value