Instance Propertymigueldeicaza.swiftgodot 0.45.0SwiftGodot
selected
Emitted when selected. Used internally.
EditorProperty.swift:1550var selected: Signal11 { get }To connect to this signal, reference this property and call the
connect method with the method you want to invoke
Example:
obj.selected.connect { path, focusableIdx in
print ("caught signal")
}Other members in extension
Types
class Signal1Signal support.
class Signal10Signal support.
class Signal11Signal support.
class Signal2Signal support.
class Signal3Signal support.
class Signal4Signal support.
class Signal5Signal support.
class Signal6Signal support.
class Signal7Signal support.
class Signal8Signal support.
class Signal9Signal support.
Type members
Instance members
var checkable: BoolUsed by the inspector, set to
truewhen the property is checkable.var checked: BoolUsed by the inspector, set to
truewhen the property is checked.var deletable: BoolUsed by the inspector, set to
truewhen the property can be deleted by the user.var drawWarning: BoolUsed by the inspector, set to
truewhen the property is drawn with the editor theme’s warning color. This is used for editable children’s properties.var keying: BoolUsed by the inspector, set to
truewhen the property can add keys for animation.var label: StringSet this property to change the label (if you want to show one).
var multiplePropertiesChanged: Signal2Emit it if you want multiple properties modified at the same time. Do not use if added via
_parseProperty(object:type:name:hintType:hintString:usageFlags:wide:).var objectIdSelected: Signal10Used by sub-inspectors. Emit it if what was selected was an Object ID.
var propertyCanRevertChanged: Signal8Emitted when the revertability (i.e., whether it has a non-default value and thus is displayed with a revert icon) of a property has changed.
var propertyChanged: Signal1Do not emit this manually, use the
emitChanged(property:value:field:changing:)method instead.var propertyChecked: Signal6Emitted when a property was checked. Used internally.
var propertyDeleted: Signal4Emitted when a property was deleted. Used internally.
var propertyKeyed: Signal3Emit it if you want to add this value as an animation key (check for keying being enabled first).
var propertyKeyedWithValue: Signal5Emit it if you want to key a property with a single value.
var propertyPinned: Signal7Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value.
var readOnly: BoolUsed by the inspector, set to
truewhen the property is read-only.var resourceSelected: Signal9If you want a sub-resource to be edited, emit this signal with the resource.
func 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.
func emitChanged(property: StringName, value: Variant, field: StringName, changing: Bool) If one or several properties have changed, this must be called.
fieldis used in case your editor can modify fields separately (as an example, Vector3.x). Thechangingargument avoids the editor requesting this property to be refreshed (leave asfalseif unsure).func getEditedObject() -> Object? Gets the edited object.
func getEditedProperty() -> StringName Gets the edited property. If your editor is for a single property (added via
_parseProperty(object:type:name:hintType:hintString:usageFlags:wide:)), then this will return the property.func setBottomEditor(Control?) Puts the
editorcontrol below the property label. The control must be previously added usingNode/addChild(node:forceReadableName:`internal`:).func updateProperty() Forces refresh of the property display.
Show implementation details (2)
Hide implementation details
func _setReadOnly(Bool) 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.
func _updateProperty() When this virtual function is called, you must update your editor.