Struct gdnative_bindings_lily::editor_property::EditorProperty [−][src]
pub struct EditorProperty { /* fields omitted */ }
Expand description
tools class EditorProperty
inherits Container
(unsafe).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Class hierarchy
EditorProperty inherits methods from:
Tool
This class is used to interact with Godot’s editor.
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
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.
pub fn emit_changed(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant,
field: impl Into<GodotString>,
changing: bool
)
pub fn emit_changed(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant,
field: impl Into<GodotString>,
changing: bool
)
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).
Default Arguments
field
-""
changing
-false
Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return the property.
Set this property to change the label (if you want to show one).
Override if you want to allow a custom tooltip over your property.
Used by the inspector, set to true
when the property is checkable.
Used by the inspector, set to true
when the property is checked.
Used by the inspector, set to true
when the property must draw with error color. This is used for editable children’s properties.
Used by the inspector, set to true
when the property can add keys for animation.
Used by the inspector, set to true
when the property is read-only.
Adds controls with this function if you want them on the bottom (below the label).
Used by the inspector, set to true
when the property is checkable.
Used by the inspector, set to true
when the property is checked.
Used by the inspector, set to true
when the property must draw with error color. This is used for editable children’s properties.
Used by the inspector, set to true
when the property can add keys for animation.
Set this property to change the label (if you want to show one).
Used by the inspector, set to true
when the property is read-only.
Methods from Deref<Target = Container>
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
Trait Implementations
type RefKind = ManuallyManaged
type RefKind = ManuallyManaged
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for EditorProperty
impl !Send for EditorProperty
impl !Sync for EditorProperty
impl Unpin for EditorProperty
impl UnwindSafe for EditorProperty