Struct gdnative::api::EditorProperty

pub struct EditorProperty { /* fields omitted */ }

tools class EditorProperty inherits Container (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Class hierarchy

EditorProperty inherits methods from:

• Container
• Control
• CanvasItem
• Node
• Object

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

impl EditorProperty

pub fn add_focusable(&self, control: impl AsArg<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.

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. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure).

Default Arguments

• field - ""
• changing - false

pub fn get_edited_object(&self) -> Option<Ref<Object, Shared>>

Gets the edited object.

pub fn get_edited_property(&self) -> GodotString

Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return the property.

pub fn label(&self) -> GodotString

Set this property to change the label (if you want to show one).

pub fn get_tooltip_text(&self) -> GodotString

Override if you want to allow a custom tooltip over your property.

pub fn is_checkable(&self) -> bool

Used by the inspector, set to [code]true[/code] when the property is checkable.

pub fn is_checked(&self) -> bool

Used by the inspector, set to [code]true[/code] when the property is checked.

pub fn is_draw_red(&self) -> bool

Used by the inspector, set to [code]true[/code] when the property must draw with error color. This is used for editable children's properties.

pub fn is_keying(&self) -> bool

Used by the inspector, set to [code]true[/code] when the property can add keys for animation.

pub fn is_read_only(&self) -> bool

Used by the inspector, set to [code]true[/code] when the property is read-only.

pub fn set_bottom_editor(&self, editor: impl AsArg<Control>)

Adds controls with this function if you want them on the bottom (below the label).

pub fn set_checkable(&self, checkable: bool)

Used by the inspector, set to [code]true[/code] when the property is checkable.

pub fn set_checked(&self, checked: bool)

Used by the inspector, set to [code]true[/code] when the property is checked.

pub fn set_draw_red(&self, draw_red: bool)

Used by the inspector, set to [code]true[/code] when the property must draw with error color. This is used for editable children's properties.

pub fn set_keying(&self, keying: bool)

Used by the inspector, set to [code]true[/code] when the property can add keys for animation.

pub fn set_label(&self, text: impl Into<GodotString>)

Set this property to change the label (if you want to show one).

pub fn set_read_only(&self, read_only: bool)

Used by the inspector, set to [code]true[/code] when the property is read-only.

Methods from Deref<Target = Container>

pub const NOTIFICATION_SORT_CHILDREN: i64

pub fn fit_child_in_rect(
    &self,
    child: impl AsArg<Control>,
    rect: Rect<f32, UnknownUnit>
)

Fit a child control in a given rect. This is mainly a helper for creating custom container classes.

pub fn queue_sort(&self)

Queue resort of the contained children. This is called automatically anyway, but can be called upon request.

Trait Implementations

impl Debug for EditorProperty

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for EditorProperty

type Target = Container

The resulting type after dereferencing.

fn deref(&self) -> &Container

Dereferences the value.

impl DerefMut for EditorProperty

fn deref_mut(&mut self) -> &mut Container

Mutably dereferences the value.

impl GodotObject for EditorProperty

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

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.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl QueueFree for EditorProperty

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for EditorProperty

impl SubClass<Container> for EditorProperty

impl SubClass<Control> for EditorProperty

impl SubClass<Node> for EditorProperty

impl SubClass<Object> for EditorProperty