Struct gdnative::api::Script

pub struct Script { /* fields omitted */ }

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

Script inherits methods from:

• 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 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.

Methods from Deref<Target = Resource>

pub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>

Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources.
				[b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.

Default Arguments

• subresources - false

pub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>

If [member resource_local_to_scene] is enabled and the resource was loaded from a [PackedScene] instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns [code]null[/code].

pub fn name(&self) -> GodotString

The name of the resource. This is an optional identifier.

pub fn path(&self) -> GodotString

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

pub fn get_rid(&self) -> Rid

Returns the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high-level abstractions of resources stored in a server, so this function will return the original RID.

pub fn is_local_to_scene(&self) -> bool

If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

pub fn set_local_to_scene(&self, enable: bool)

If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

pub fn set_name(&self, name: impl Into<GodotString>)

The name of the resource. This is an optional identifier.

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

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

pub fn setup_local_to_scene(&self)

This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a [PackedScene] instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script.
				For most resources, this method performs no base logic. [ViewportTexture] performs custom logic to properly set the proxy texture and flags in the local viewport.

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

Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path.

Trait Implementations

impl Debug for Script

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

Formats the value using the given formatter.

impl Deref for Script

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for Script

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

Mutably dereferences the value.

impl GodotObject for Script

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 Script

impl SubClass<Reference> for Script

impl SubClass<Resource> for Script

impl SubClass<Script> for VisualScript

impl SubClass<Script> for NativeScript

impl SubClass<Script> for GDScript

impl SubClass<Script> for PluginScript