[−][src]Struct gdnative::api::AudioEffect

pub struct AudioEffect { /* fields omitted */ }

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

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.

Methods from Deref<Target = Resource>

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

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>>`[src]

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`[src]

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

`pub fn path(&self) -> GodotString`[src]

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`[src]

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`[src]

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)`[src]

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>)`[src]

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

`pub fn set_path(&self, path: impl Into<GodotString>)`[src]

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)`[src]

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>)`[src]

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 AudioEffect`[src]

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

`impl Deref for AudioEffect`[src]

`type Target = Resource`

The resulting type after dereferencing.

`fn deref(&self) -> &Resource`[src]

`impl DerefMut for AudioEffect`[src]

`fn deref_mut(&mut self) -> &mut Resource`[src]

`impl GodotObject for AudioEffect`[src]

`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. Read more