Struct PluginScript

Source

pub struct PluginScript { /* private fields */ }

Expand description

core class PluginScript 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.

§Feature flag

This type is behind the gdnative crate’s common feature flag.

§Class hierarchy

PluginScript inherits methods from:

Implementations§

Source §

impl PluginScript

Source

pub fn new() -> Self

Source

pub fn new_ref(&self) -> Self

Creates a new reference to the same reference-counted object.

Source

pub fn can_instance(&self) -> bool

Inherited from Script.

Source

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

Inherited from Script.

Source

pub fn has_source_code(&self) -> bool

Inherited from Script.

Source

pub fn get_source_code(&self) -> GodotString

Inherited from Script.

Source

pub fn set_source_code(&mut self, source: GodotString)

Inherited from Script.

Source

pub fn reload(&mut self, keep_state: bool) -> GodotResult

Inherited from Script.

Source

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

Inherited from Script.

Source

pub fn get_instance_base_type(&self) -> GodotString

Inherited from Script.

Source

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

Inherited from Script.

Source

pub fn is_tool(&self) -> bool

Inherited from Script.

Source

pub fn _setup_local_to_scene(&mut self)

Inherited from Resource.

Source

pub fn set_path(&mut self, path: GodotString)

Inherited from Resource.

Source

pub fn take_over_path(&mut self, path: GodotString)

Inherited from Resource.

Source

pub fn get_path(&self) -> GodotString

Inherited from Resource.

Source

pub fn set_name(&mut self, name: GodotString)

Inherited from Resource.

Source

pub fn get_name(&self) -> GodotString

Inherited from Resource.

Source

pub fn get_rid(&self) -> Rid

Inherited from Resource.

Source

pub fn set_local_to_scene(&mut self, enable: bool)

Inherited from Resource.

Source

pub fn is_local_to_scene(&self) -> bool

Inherited from Resource.

Source

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

Inherited from Resource.

Source

pub fn setup_local_to_scene(&mut self)

Inherited from Resource.

Source

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

Inherited from Resource.

Source

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

Source

pub fn _notification(&mut self, what: i64)

Inherited from Object.

Source

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

Source

pub fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

Source

pub fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

Source

pub fn _init(&mut self)

Inherited from Object.

Source

pub fn get_class(&self) -> GodotString

Inherited from Object.

Source

pub fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

Source

pub fn set(&mut self, property: GodotString, value: Variant)

Inherited from Object.

Source

pub fn get(&self, property: GodotString) -> Variant

Inherited from Object.

Source

pub fn set_indexed(&mut self, property: NodePath, value: Variant)

Inherited from Object.

Source

pub fn get_indexed(&self, property: NodePath) -> Variant

Inherited from Object.

Source

pub fn get_property_list(&self) -> VariantArray

Inherited from Object.

Source

pub fn get_method_list(&self) -> VariantArray

Inherited from Object.

Source

pub fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

Source

pub fn get_instance_id(&self) -> i64

Inherited from Object.

Source

pub fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

Source

pub fn get_script(&self) -> Option<Reference>

Inherited from Object.

Source

pub fn set_meta(&mut self, name: GodotString, value: Variant)

Inherited from Object.

Source

pub fn get_meta(&self, name: GodotString) -> Variant

Inherited from Object.

Source

pub fn has_meta(&self, name: GodotString) -> bool

Inherited from Object.

Source

pub fn get_meta_list(&self) -> StringArray

Inherited from Object.

Source

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)

Inherited from Object.

Source

pub fn has_user_signal(&self, signal: GodotString) -> bool

Inherited from Object.

Source

pub fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

Source

pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant

Inherited from Object.

Source

pub fn call_deferred( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

Source

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant

Inherited from Object.

Source

pub fn has_method(&self, method: GodotString) -> bool

Inherited from Object.

Source

pub fn get_signal_list(&self) -> VariantArray

Inherited from Object.

Source

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray

Inherited from Object.

Source

pub fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

Source

pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

Source

pub fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

Inherited from Object.

Source

pub fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

Inherited from Object.

Source

pub fn set_block_signals(&mut self, enable: bool)

Inherited from Object.

Source

pub fn is_blocking_signals(&self) -> bool

Inherited from Object.

Source

pub fn property_list_changed_notify(&mut self)

Inherited from Object.

Source

pub fn set_message_translation(&mut self, enable: bool)

Inherited from Object.

Source

pub fn can_translate_messages(&self) -> bool

Inherited from Object.

Source

pub fn tr(&self, message: GodotString) -> GodotString

Inherited from Object.

Source

pub fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

Source

pub fn to_script(&self) -> Script

Up-cast.

Source

pub fn to_resource(&self) -> Resource

Up-cast.

Source

pub fn to_reference(&self) -> Reference

Up-cast.

Source

pub fn to_object(&self) -> Object

Up-cast.

Source

pub fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations§

Source §

impl Debug for PluginScript

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Drop for PluginScript

Source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Source §

fn from_variant(variant: &Variant) -> Option<Self>

Auto Trait Implementations§

§

impl Freeze for PluginScript

§

impl RefUnwindSafe for PluginScript

§

impl !Send for PluginScript

§

impl !Sync for PluginScript

§

impl Unpin for PluginScript

§

impl UnwindSafe for PluginScript

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 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, U> TryFrom for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Struct PluginScriptCopy item path

§Official documentation

§Memory management

§Feature flag

§Class hierarchy

Implementations§

impl PluginScript

pub fn new() -> Self

pub fn new_ref(&self) -> Self

pub fn can_instance(&self) -> bool

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

pub fn has_source_code(&self) -> bool

pub fn get_source_code(&self) -> GodotString

pub fn set_source_code(&mut self, source: GodotString)

pub fn reload(&mut self, keep_state: bool) -> GodotResult

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

pub fn get_instance_base_type(&self) -> GodotString

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

pub fn is_tool(&self) -> bool

pub fn _setup_local_to_scene(&mut self)

pub fn set_path(&mut self, path: GodotString)

pub fn take_over_path(&mut self, path: GodotString)

pub fn get_path(&self) -> GodotString

pub fn set_name(&mut self, name: GodotString)

pub fn get_name(&self) -> GodotString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

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

pub fn setup_local_to_scene(&mut self)

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

pub fn init_ref(&mut self) -> bool

pub fn _notification(&mut self, what: i64)

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool

pub fn _get(&mut self, property: GodotString) -> Variant

pub fn _get_property_list(&mut self) -> VariantArray

pub fn _init(&mut self)

pub fn get_class(&self) -> GodotString

pub fn is_class(&self, _type: GodotString) -> bool

pub fn set(&mut self, property: GodotString, value: Variant)

pub fn get(&self, property: GodotString) -> Variant

pub fn set_indexed(&mut self, property: NodePath, value: Variant)

pub fn get_indexed(&self, property: NodePath) -> Variant

pub fn get_property_list(&self) -> VariantArray

pub fn get_method_list(&self) -> VariantArray

pub fn notification(&mut self, what: i64, reversed: bool)

pub fn get_instance_id(&self) -> i64

pub fn set_script(&mut self, script: Option<Reference>)

pub fn get_script(&self) -> Option<Reference>

pub fn set_meta(&mut self, name: GodotString, value: Variant)

pub fn get_meta(&self, name: GodotString) -> Variant

pub fn has_meta(&self, name: GodotString) -> bool

pub fn get_meta_list(&self) -> StringArray

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)

pub fn has_user_signal(&self, signal: GodotString) -> bool

pub fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant

pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant

pub fn call_deferred( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant

pub fn has_method(&self, method: GodotString) -> bool

pub fn get_signal_list(&self) -> VariantArray

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray

pub fn get_incoming_connections(&self) -> VariantArray

pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

pub fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

pub fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn property_list_changed_notify(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: GodotString) -> GodotString

pub fn is_queued_for_deletion(&self) -> bool

pub fn to_script(&self) -> Script

pub fn to_resource(&self) -> Resource

pub fn to_reference(&self) -> Reference

pub fn to_object(&self) -> Object

pub fn cast<T: GodotObject>(&self) -> Option<T>

Trait Implementations§

impl Debug for PluginScript

Struct PluginScript

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

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

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

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

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

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