#[non_exhaustive]
pub enum EditorRunBehavior { ToolClassesOnly, AllClasses, }
Expand description

Determines if and how an extension’s code is run in the editor.

By default, Godot 4 runs all virtual lifecycle callbacks (_ready, _process, _physics_process, …) for extensions. This behavior is different from Godot 3, where extension classes needed to be explicitly marked as “tool”.

In many cases, users write extension code with the intention to run in games, not inside the editor. This is why the default behavior in gdext deviates from Godot: lifecycle callbacks are disabled inside the editor (see ToolClassesOnly). It is possible to configure this.

See also ExtensionLibrary::editor_run_behavior().

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

ToolClassesOnly

Only runs #[class(tool)] classes in the editor.

All classes are registered, and calls from GDScript to Rust are possible. However, virtual lifecycle callbacks (_ready, _process, _physics_process, …) are not run unless the class is annotated with #[class(tool)].

§

AllClasses

Runs the extension with full functionality in editor.

Ignores any #[class(tool)] annotations.

Trait Implementations§

§

impl Clone for EditorRunBehavior

§

fn clone(&self) -> EditorRunBehavior

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Debug for EditorRunBehavior

§

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

Formats the value using the given formatter. Read more
§

impl Copy for EditorRunBehavior

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.