Struct gdnative::api::EditorFeatureProfile

pub struct EditorFeatureProfile { /* fields omitted */ }

tools class EditorFeatureProfile inherits Reference (reference counted).

Official documentation

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

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

EditorFeatureProfile inherits methods from:

• Reference
• 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 EditorFeatureProfile

Constants

pub const FEATURE_3D: i64

pub const FEATURE_ASSET_LIB: i64

pub const FEATURE_FILESYSTEM_DOCK: i64

pub const FEATURE_IMPORT_DOCK: i64

pub const FEATURE_MAX: i64

pub const FEATURE_NODE_DOCK: i64

pub const FEATURE_SCENE_TREE: i64

pub const FEATURE_SCRIPT: i64

impl EditorFeatureProfile

pub fn get_feature_name(&self, feature: i64) -> GodotString

Returns the specified [code]feature[/code]'s human-readable name.

pub fn is_class_disabled(&self, class_name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if the class specified by [code]class_name[/code] is disabled. When disabled, the class won't appear in the Create New Node dialog.

pub fn is_class_editor_disabled(
    &self,
    class_name: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if editing for the class specified by [code]class_name[/code] is disabled. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class.

pub fn is_class_property_disabled(
    &self,
    class_name: impl Into<GodotString>,
    property: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if [code]property[/code] is disabled in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code].

pub fn is_feature_disabled(&self, feature: i64) -> bool

Returns [code]true[/code] if the [code]feature[/code] is disabled. When a feature is disabled, it will disappear from the editor entirely.

pub fn load_from_file(
    &self,
    path: impl Into<GodotString>
) -> Result<(), GodotError>

Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's [b]Export[/b] button or the [method save_to_file] method.

pub fn save_to_file(
    &self,
    path: impl Into<GodotString>
) -> Result<(), GodotError>

Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's [b]Import[/b] button or the [method load_from_file] button.

pub fn set_disable_class(
    &self,
    class_name: impl Into<GodotString>,
    disable: bool
)

If [code]disable[/code] is [code]true[/code], disables the class specified by [code]class_name[/code]. When disabled, the class won't appear in the Create New Node dialog.

pub fn set_disable_class_editor(
    &self,
    class_name: impl Into<GodotString>,
    disable: bool
)

If [code]disable[/code] is [code]true[/code], disables editing for the class specified by [code]class_name[/code]. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class.

pub fn set_disable_class_property(
    &self,
    class_name: impl Into<GodotString>,
    property: impl Into<GodotString>,
    disable: bool
)

If [code]disable[/code] is [code]true[/code], disables editing for [code]property[/code] in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code].

pub fn set_disable_feature(&self, feature: i64, disable: bool)

If [code]disable[/code] is [code]true[/code], disables the editor feature specified in [code]feature[/code]. When a feature is disabled, it will disappear from the editor entirely.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for EditorFeatureProfile

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

Formats the value using the given formatter.

impl Deref for EditorFeatureProfile

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for EditorFeatureProfile

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

Mutably dereferences the value.

impl GodotObject for EditorFeatureProfile

type RefKind = RefCounted

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 SubClass<Object> for EditorFeatureProfile

impl SubClass<Reference> for EditorFeatureProfile