Struct gdnative::api::ScriptEditor

pub struct ScriptEditor { /* fields omitted */ }

tools class ScriptEditor inherits PanelContainer (unsafe).

Official documentation

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

Class hierarchy

ScriptEditor inherits methods from:

• PanelContainer
• 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 ScriptEditor

pub fn can_drop_data_fw(
    &self,
    point: Vector2D<f32, UnknownUnit>,
    data: impl OwnedToVariant,
    from: impl AsArg<Control>
) -> bool

pub fn drop_data_fw(
    &self,
    point: Vector2D<f32, UnknownUnit>,
    data: impl OwnedToVariant,
    from: impl AsArg<Control>
)

pub fn get_current_script(&self) -> Option<Ref<Script, Shared>>

Returns a [Script] that is currently active in editor.

pub fn get_drag_data_fw(
    &self,
    point: Vector2D<f32, UnknownUnit>,
    from: impl AsArg<Control>
) -> Variant

pub fn get_open_scripts(&self) -> VariantArray<Shared>

Returns an array with all [Script] objects which are currently open in editor.

pub fn goto_line(&self, line_number: i64)

Goes to the specified line in the current script.

pub fn open_script_create_dialog(
    &self,
    base_name: impl Into<GodotString>,
    base_path: impl Into<GodotString>
)

Methods from Deref<Target = PanelContainer>

Trait Implementations

impl Debug for ScriptEditor

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

Formats the value using the given formatter.

impl Deref for ScriptEditor

type Target = PanelContainer

The resulting type after dereferencing.

fn deref(&self) -> &PanelContainer

Dereferences the value.

impl DerefMut for ScriptEditor

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

Mutably dereferences the value.

impl GodotObject for ScriptEditor

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 ScriptEditor

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for ScriptEditor

impl SubClass<Container> for ScriptEditor

impl SubClass<Control> for ScriptEditor

impl SubClass<Node> for ScriptEditor

impl SubClass<Object> for ScriptEditor

impl SubClass<PanelContainer> for ScriptEditor