Struct gdnative::api::NativeScript

pub struct NativeScript { /* fields omitted */ }

core class NativeScript inherits Script (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

NativeScript inherits methods from:

• Script
• Resource
• Reference
• Object

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 NativeScript

pub fn new() -> Ref<NativeScript, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn get_class_documentation(&self) -> GodotString

pub fn class_name(&self) -> GodotString

pub fn library(&self) -> Option<Ref<GDNativeLibrary, Shared>>

pub fn get_method_documentation(
    &self,
    method: impl Into<GodotString>
) -> GodotString

pub fn get_property_documentation(
    &self,
    path: impl Into<GodotString>
) -> GodotString

pub fn script_class_icon_path(&self) -> GodotString

pub fn script_class_name(&self) -> GodotString

pub fn get_signal_documentation(
    &self,
    signal_name: impl Into<GodotString>
) -> GodotString

pub fn _new(&self, varargs: &[Variant]) -> Variant

pub fn set_class_name(&self, class_name: impl Into<GodotString>)

pub fn set_library(&self, library: impl AsArg<GDNativeLibrary>)

pub fn set_script_class_icon_path(&self, icon_path: impl Into<GodotString>)

pub fn set_script_class_name(&self, class_name: impl Into<GodotString>)

Methods from Deref<Target = Script>

pub fn can_instance(&self) -> bool

Returns [code]true[/code] if the script can be instanced.

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

Returns the script directly inherited by this script.

pub fn get_instance_base_type(&self) -> GodotString

Returns the script's base type.

pub fn get_property_default_value(
    &self,
    property: impl Into<GodotString>
) -> Variant

Returns the default value of the specified property.

pub fn get_script_constant_map(&self) -> Dictionary<Shared>

Returns a dictionary containing constant names and their values.

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

Returns the list of methods in this [Script].

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

Returns the list of properties in this [Script].

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

Returns the list of user signals defined in this [Script].

pub fn source_code(&self) -> GodotString

The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.

pub fn has_script_signal(&self, signal_name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.

pub fn has_source_code(&self) -> bool

Returns [code]true[/code] if the script contains non-empty source code.

pub fn instance_has(&self, base_object: impl AsArg<Object>) -> bool

Returns [code]true[/code] if [code]base_object[/code] is an instance of this script.

pub fn is_tool(&self) -> bool

Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor.

pub fn reload(&self, keep_state: bool) -> Result<(), GodotError>

Reloads the script's class implementation. Returns an error code.

Default Arguments

• keep_state - false

pub fn set_source_code(&self, source: impl Into<GodotString>)

The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.

Trait Implementations

impl Debug for NativeScript

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

Formats the value using the given formatter.

impl Deref for NativeScript

type Target = Script

The resulting type after dereferencing.

fn deref(&self) -> &Script

Dereferences the value.

impl DerefMut for NativeScript

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

Mutably dereferences the value.

impl GodotObject for NativeScript

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 Instanciable for NativeScript

fn construct() -> Ref<NativeScript, Unique>

impl SubClass<Object> for NativeScript

impl SubClass<Reference> for NativeScript

impl SubClass<Resource> for NativeScript

impl SubClass<Script> for NativeScript