Struct gdnative_bindings::AudioServer
source · pub struct AudioServer { /* private fields */ }
Expand description
core singleton class AudioServer
inherits Object
(manually managed).
This class has related types in the audio_server
module.
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Class hierarchy
AudioServer inherits methods from:
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 Ownership
in these types tracks whether
ownership is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations§
source§impl AudioServer
impl AudioServer
Constants
pub const SPEAKER_MODE_STEREO: i64 = 0i64
pub const SPEAKER_SURROUND_31: i64 = 1i64
pub const SPEAKER_SURROUND_51: i64 = 2i64
pub const SPEAKER_SURROUND_71: i64 = 3i64
source§impl AudioServer
impl AudioServer
sourcepub fn godot_singleton() -> &'static Self
pub fn godot_singleton() -> &'static Self
Returns a reference to the singleton instance.
sourcepub fn add_bus_effect(
&self,
bus_idx: i64,
effect: impl AsArg<AudioEffect>,
at_position: i64
)
pub fn add_bus_effect(
&self,
bus_idx: i64,
effect: impl AsArg<AudioEffect>,
at_position: i64
)
sourcepub fn capture_get_device(&self) -> GodotString
pub fn capture_get_device(&self) -> GodotString
Name of the current device for audio input (see capture_get_device_list
). On systems with multiple audio inputs (such as analog, USB and HDMI audio), this can be used to select the audio input device. The value "Default"
will record audio on the system-wide default audio input. If an invalid device name is set, the value will be reverted back to "Default"
.
Note: [member ProjectSettings.audio/enable_audio_input] must be true
for audio input to work. See also that setting’s description for caveats related to permissions and operating system privacy settings.
sourcepub fn capture_get_device_list(&self) -> VariantArray
pub fn capture_get_device_list(&self) -> VariantArray
Returns the names of all audio input devices detected on the system.
Note: [member ProjectSettings.audio/enable_audio_input] must be true
for audio input to work. See also that setting’s description for caveats related to permissions and operating system privacy settings.
sourcepub fn capture_set_device(&self, name: impl Into<GodotString>)
pub fn capture_set_device(&self, name: impl Into<GodotString>)
Name of the current device for audio input (see capture_get_device_list
). On systems with multiple audio inputs (such as analog, USB and HDMI audio), this can be used to select the audio input device. The value "Default"
will record audio on the system-wide default audio input. If an invalid device name is set, the value will be reverted back to "Default"
.
Note: [member ProjectSettings.audio/enable_audio_input] must be true
for audio input to work. See also that setting’s description for caveats related to permissions and operating system privacy settings.
sourcepub fn generate_bus_layout(&self) -> Option<Ref<AudioBusLayout, Shared>>
pub fn generate_bus_layout(&self) -> Option<Ref<AudioBusLayout, Shared>>
Generates an AudioBusLayout
using the available buses and effects.
sourcepub fn get_bus_channels(&self, bus_idx: i64) -> i64
pub fn get_bus_channels(&self, bus_idx: i64) -> i64
Returns the amount of channels of the bus at index bus_idx
.
sourcepub fn get_bus_effect(
&self,
bus_idx: i64,
effect_idx: i64
) -> Option<Ref<AudioEffect, Shared>>
pub fn get_bus_effect(
&self,
bus_idx: i64,
effect_idx: i64
) -> Option<Ref<AudioEffect, Shared>>
Returns the AudioEffect
at position effect_idx
in bus bus_idx
.
sourcepub fn get_bus_effect_count(&self, bus_idx: i64) -> i64
pub fn get_bus_effect_count(&self, bus_idx: i64) -> i64
Returns the number of effects on the bus at bus_idx
.
sourcepub fn get_bus_effect_instance(
&self,
bus_idx: i64,
effect_idx: i64,
channel: i64
) -> Option<Ref<AudioEffectInstance, Shared>>
pub fn get_bus_effect_instance(
&self,
bus_idx: i64,
effect_idx: i64,
channel: i64
) -> Option<Ref<AudioEffectInstance, Shared>>
Returns the AudioEffectInstance
assigned to the given bus and effect indices (and optionally channel).
Default Arguments
channel
-0
sourcepub fn get_bus_index(&self, bus_name: impl Into<GodotString>) -> i64
pub fn get_bus_index(&self, bus_name: impl Into<GodotString>) -> i64
Returns the index of the bus with the name bus_name
.
sourcepub fn get_bus_name(&self, bus_idx: i64) -> GodotString
pub fn get_bus_name(&self, bus_idx: i64) -> GodotString
Returns the name of the bus with the index bus_idx
.
sourcepub fn get_bus_peak_volume_left_db(&self, bus_idx: i64, channel: i64) -> f64
pub fn get_bus_peak_volume_left_db(&self, bus_idx: i64, channel: i64) -> f64
Returns the peak volume of the left speaker at bus index bus_idx
and channel index channel
.
sourcepub fn get_bus_peak_volume_right_db(&self, bus_idx: i64, channel: i64) -> f64
pub fn get_bus_peak_volume_right_db(&self, bus_idx: i64, channel: i64) -> f64
Returns the peak volume of the right speaker at bus index bus_idx
and channel index channel
.
sourcepub fn get_bus_send(&self, bus_idx: i64) -> GodotString
pub fn get_bus_send(&self, bus_idx: i64) -> GodotString
Returns the name of the bus that the bus at index bus_idx
sends to.
sourcepub fn get_bus_volume_db(&self, bus_idx: i64) -> f64
pub fn get_bus_volume_db(&self, bus_idx: i64) -> f64
Returns the volume of the bus at index bus_idx
in dB.
sourcepub fn device(&self) -> GodotString
pub fn device(&self) -> GodotString
Name of the current device for audio output (see get_device_list
). On systems with multiple audio outputs (such as analog, USB and HDMI audio), this can be used to select the audio output device. The value "Default"
will play audio on the system-wide default audio output. If an invalid device name is set, the value will be reverted back to "Default"
.
sourcepub fn get_device_list(&self) -> VariantArray
pub fn get_device_list(&self) -> VariantArray
Returns the names of all audio devices detected on the system.
sourcepub fn global_rate_scale(&self) -> f64
pub fn global_rate_scale(&self) -> f64
Scales the rate at which audio is played (i.e. setting it to 0.5
will make the audio be played twice as fast).
sourcepub fn get_mix_rate(&self) -> f64
pub fn get_mix_rate(&self) -> f64
Returns the sample rate at the output of the AudioServer
.
sourcepub fn get_output_latency(&self) -> f64
pub fn get_output_latency(&self) -> f64
Returns the audio driver’s output latency.
sourcepub fn get_speaker_mode(&self) -> SpeakerMode
pub fn get_speaker_mode(&self) -> SpeakerMode
Returns the speaker configuration.
sourcepub fn get_time_since_last_mix(&self) -> f64
pub fn get_time_since_last_mix(&self) -> f64
Returns the relative time since the last mix occurred.
sourcepub fn get_time_to_next_mix(&self) -> f64
pub fn get_time_to_next_mix(&self) -> f64
Returns the relative time until the next mix occurs.
sourcepub fn is_bus_bypassing_effects(&self, bus_idx: i64) -> bool
pub fn is_bus_bypassing_effects(&self, bus_idx: i64) -> bool
If true
, the bus at index bus_idx
is bypassing effects.
sourcepub fn is_bus_effect_enabled(&self, bus_idx: i64, effect_idx: i64) -> bool
pub fn is_bus_effect_enabled(&self, bus_idx: i64, effect_idx: i64) -> bool
If true
, the effect at index effect_idx
on the bus at index bus_idx
is enabled.
sourcepub fn is_bus_mute(&self, bus_idx: i64) -> bool
pub fn is_bus_mute(&self, bus_idx: i64) -> bool
If true
, the bus at index bus_idx
is muted.
sourcepub fn is_bus_solo(&self, bus_idx: i64) -> bool
pub fn is_bus_solo(&self, bus_idx: i64) -> bool
If true
, the bus at index bus_idx
is in solo mode.
sourcepub fn move_bus(&self, index: i64, to_index: i64)
pub fn move_bus(&self, index: i64, to_index: i64)
Moves the bus from index index
to index to_index
.
sourcepub fn remove_bus(&self, index: i64)
pub fn remove_bus(&self, index: i64)
Removes the bus at index index
.
sourcepub fn remove_bus_effect(&self, bus_idx: i64, effect_idx: i64)
pub fn remove_bus_effect(&self, bus_idx: i64, effect_idx: i64)
Removes the effect at index effect_idx
from the bus at index bus_idx
.
sourcepub fn set_bus_bypass_effects(&self, bus_idx: i64, enable: bool)
pub fn set_bus_bypass_effects(&self, bus_idx: i64, enable: bool)
If true
, the bus at index bus_idx
is bypassing effects.
sourcepub fn set_bus_count(&self, amount: i64)
pub fn set_bus_count(&self, amount: i64)
Number of available audio buses.
sourcepub fn set_bus_effect_enabled(&self, bus_idx: i64, effect_idx: i64, enabled: bool)
pub fn set_bus_effect_enabled(&self, bus_idx: i64, effect_idx: i64, enabled: bool)
If true
, the effect at index effect_idx
on the bus at index bus_idx
is enabled.
sourcepub fn set_bus_layout(&self, bus_layout: impl AsArg<AudioBusLayout>)
pub fn set_bus_layout(&self, bus_layout: impl AsArg<AudioBusLayout>)
Overwrites the currently used AudioBusLayout
.
sourcepub fn set_bus_mute(&self, bus_idx: i64, enable: bool)
pub fn set_bus_mute(&self, bus_idx: i64, enable: bool)
If true
, the bus at index bus_idx
is muted.
sourcepub fn set_bus_name(&self, bus_idx: i64, name: impl Into<GodotString>)
pub fn set_bus_name(&self, bus_idx: i64, name: impl Into<GodotString>)
Sets the name of the bus at index bus_idx
to name
.
sourcepub fn set_bus_send(&self, bus_idx: i64, send: impl Into<GodotString>)
pub fn set_bus_send(&self, bus_idx: i64, send: impl Into<GodotString>)
Connects the output of the bus at bus_idx
to the bus named send
.
sourcepub fn set_bus_solo(&self, bus_idx: i64, enable: bool)
pub fn set_bus_solo(&self, bus_idx: i64, enable: bool)
If true
, the bus at index bus_idx
is in solo mode.
sourcepub fn set_bus_volume_db(&self, bus_idx: i64, volume_db: f64)
pub fn set_bus_volume_db(&self, bus_idx: i64, volume_db: f64)
Sets the volume of the bus at index bus_idx
to volume_db
.
sourcepub fn set_device(&self, device: impl Into<GodotString>)
pub fn set_device(&self, device: impl Into<GodotString>)
Name of the current device for audio output (see get_device_list
). On systems with multiple audio outputs (such as analog, USB and HDMI audio), this can be used to select the audio output device. The value "Default"
will play audio on the system-wide default audio output. If an invalid device name is set, the value will be reverted back to "Default"
.
sourcepub fn set_global_rate_scale(&self, scale: f64)
pub fn set_global_rate_scale(&self, scale: f64)
Scales the rate at which audio is played (i.e. setting it to 0.5
will make the audio be played twice as fast).
sourcepub fn swap_bus_effects(&self, bus_idx: i64, effect_idx: i64, by_effect_idx: i64)
pub fn swap_bus_effects(&self, bus_idx: i64, effect_idx: i64, by_effect_idx: i64)
Swaps the position of two effects in bus bus_idx
.
Methods from Deref<Target = Object>§
pub const NOTIFICATION_POSTINITIALIZE: i64 = 0i64
pub const CONNECT_DEFERRED: i64 = 1i64
pub const NOTIFICATION_PREDELETE: i64 = 1i64
pub const CONNECT_PERSIST: i64 = 2i64
pub const CONNECT_ONESHOT: i64 = 4i64
pub const CONNECT_REFERENCE_COUNTED: i64 = 8i64
sourcepub fn add_user_signal(
&self,
signal: impl Into<GodotString>,
arguments: VariantArray
)
pub fn add_user_signal(
&self,
signal: impl Into<GodotString>,
arguments: VariantArray
)
Adds a user-defined signal
. Arguments are optional, but can be added as an Array
of dictionaries, each containing name: String
and type: int
(see [enum Variant.Type]) entries.
Default Arguments
arguments
-[ ]
sourcepub unsafe fn call(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
call("set", "position", Vector2(42.0, 0.0))
Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
call_deferred("set", "position", Vector2(42.0, 0.0))
Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
pub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object and returns the result. Contrarily to call
, this method does not support a variable number of arguments but expects all parameters to be via a single Array
.
callv("set", [ "position", Vector2(42.0, 0.0) ])
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub fn can_translate_messages(&self) -> bool
pub fn can_translate_messages(&self) -> bool
Returns true
if the object can translate strings. See set_message_translation
and tr
.
sourcepub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
pub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
Sample code is GDScript unless otherwise noted.
Connects a signal
to a method
on a target
object. Pass optional binds
to the call as an Array
of parameters. These parameters will be passed to the method after any parameter used in the call to emit_signal
. Use flags
to set deferred or one-shot connections. See ConnectFlags
constants.
A signal
can only be connected once to a method
. It will print an error if already connected, unless the signal was connected with CONNECT_REFERENCE_COUNTED
. To avoid this, first, use is_connected
to check for existing connections.
If the target
is destroyed in the game’s lifecycle, the connection will be lost.
Examples:
connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal
An example of the relationship between binds
passed to connect
and parameters used when calling emit_signal
:
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])
Default Arguments
binds
-[ ]
flags
-0
sourcepub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
pub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
Disconnects a signal
from a method
on the given target
.
If you try to disconnect a connection that does not exist, the method will print an error. Use is_connected
to ensure that the connection exists.
sourcepub fn emit_signal(
&self,
signal: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub fn emit_signal(
&self,
signal: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Emits the given signal
. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
emit_signal("hit", weapon_type, damage)
emit_signal("game_over")
sourcepub fn get(&self, property: impl Into<GodotString>) -> Variant
pub fn get(&self, property: impl Into<GodotString>) -> Variant
Returns the Variant
value of the given property
. If the property
doesn’t exist, this will return null
.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn get_class(&self) -> GodotString
pub fn get_class(&self) -> GodotString
sourcepub fn get_incoming_connections(&self) -> VariantArray
pub fn get_incoming_connections(&self) -> VariantArray
Returns an Array
of dictionaries with information about signals that are connected to the object.
Each Dictionary
contains three String entries:
source
is a reference to the signal emitter.signal_name
is the name of the connected signal.method_name
is the name of the method to which the signal is connected.
sourcepub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant
pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant
Gets the object’s property indexed by the given NodePath
. The node path should be relative to the current object and can use the colon character (:
) to access nested properties. Examples: "position:x"
or "material:next_pass:blend_mode"
.
Note: Even though the method takes NodePath
argument, it doesn’t support actual paths to Node
s in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use Node.get_node_and_resource
instead.
sourcepub fn get_instance_id(&self) -> i64
pub fn get_instance_id(&self) -> i64
Returns the object’s unique instance ID.
This ID can be saved in EncodedObjectAsID
, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].
sourcepub fn get_meta(
&self,
name: impl Into<GodotString>,
default: impl OwnedToVariant
) -> Variant
pub fn get_meta(
&self,
name: impl Into<GodotString>,
default: impl OwnedToVariant
) -> Variant
Returns the object’s metadata entry for the given name
.
Throws error if the entry does not exist, unless default
is not null
(in which case the default value will be returned).
Default Arguments
default
-null
sourcepub fn get_meta_list(&self) -> PoolArray<GodotString>
pub fn get_meta_list(&self) -> PoolArray<GodotString>
Returns the object’s metadata as a PoolStringArray
.
sourcepub fn get_method_list(&self) -> VariantArray
pub fn get_method_list(&self) -> VariantArray
Returns the object’s methods and their signatures as an Array
.
sourcepub fn get_property_list(&self) -> VariantArray
pub fn get_property_list(&self) -> VariantArray
Returns the object’s property list as an Array
of dictionaries.
Each property’s Dictionary
contain at least name: String
and type: int
(see [enum Variant.Type]) entries. Optionally, it can also include hint: int
(see [PropertyHint
][PropertyHint]), hint_string: String
, and usage: int
(see [PropertyUsageFlags
][PropertyUsageFlags]).
sourcepub fn get_script(&self) -> Option<Ref<Reference, Shared>>
pub fn get_script(&self) -> Option<Ref<Reference, Shared>>
Returns the object’s Script
instance, or null
if none is assigned.
sourcepub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray
pub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray
Returns an Array
of connections for the given signal
.
sourcepub fn get_signal_list(&self) -> VariantArray
pub fn get_signal_list(&self) -> VariantArray
Returns the list of signals as an Array
of dictionaries.
sourcepub fn has_meta(&self, name: impl Into<GodotString>) -> bool
pub fn has_meta(&self, name: impl Into<GodotString>) -> bool
Returns true
if a metadata entry is found with the given name
.
sourcepub fn has_method(&self, method: impl Into<GodotString>) -> bool
pub fn has_method(&self, method: impl Into<GodotString>) -> bool
Returns true
if the object contains the given method
.
sourcepub fn has_signal(&self, signal: impl Into<GodotString>) -> bool
pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool
Returns true
if the given signal
exists.
sourcepub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool
pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool
Returns true
if the given user-defined signal
exists. Only signals added using add_user_signal
are taken into account.
sourcepub fn is_blocking_signals(&self) -> bool
pub fn is_blocking_signals(&self) -> bool
Returns true
if signal emission blocking is enabled.
sourcepub fn is_class(&self, class: impl Into<GodotString>) -> bool
pub fn is_class(&self, class: impl Into<GodotString>) -> bool
sourcepub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
pub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
Returns true
if a connection exists for a given signal
, target
, and method
.
sourcepub fn is_queued_for_deletion(&self) -> bool
pub fn is_queued_for_deletion(&self) -> bool
Returns true
if the Node.queue_free
method was called for the object.
sourcepub fn notification(&self, what: i64, reversed: bool)
pub fn notification(&self, what: i64, reversed: bool)
Send a given notification to the object, which will also trigger a call to the [_notification
][Self::_notification] method of all classes that the object inherits from.
If reversed
is true
, [_notification
][Self::_notification] is called first on the object’s own class, and then up to its successive parent classes. If reversed
is false
, [_notification
][Self::_notification] is called first on the highest ancestor (Object
itself), and then down to its successive inheriting classes.
Default Arguments
reversed
-false
sourcepub fn property_list_changed_notify(&self)
pub fn property_list_changed_notify(&self)
Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.
sourcepub fn remove_meta(&self, name: impl Into<GodotString>)
pub fn remove_meta(&self, name: impl Into<GodotString>)
Removes a given entry from the object’s metadata. See also set_meta
.
sourcepub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)
pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)
Assigns a new value to the given property. If the property
does not exist or the given value’s type doesn’t match, nothing will happen.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn set_block_signals(&self, enable: bool)
pub fn set_block_signals(&self, enable: bool)
If set to true
, signal emission is blocked.
sourcepub fn set_deferred(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant
)
pub fn set_deferred(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant
)
Assigns a new value to the given property, after the current frame’s physics step. This is equivalent to calling set
via call_deferred
, i.e. call_deferred("set", property, value)
.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn set_indexed(
&self,
property: impl Into<NodePath>,
value: impl OwnedToVariant
)
pub fn set_indexed(
&self,
property: impl Into<NodePath>,
value: impl OwnedToVariant
)
Sample code is GDScript unless otherwise noted.
Assigns a new value to the property identified by the NodePath
. The node path should be relative to the current object and can use the colon character (:
) to access nested properties. Example:
set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)
sourcepub fn set_message_translation(&self, enable: bool)
pub fn set_message_translation(&self, enable: bool)
Defines whether the object can translate strings (with calls to tr
). Enabled by default.
sourcepub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)
pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)
Adds, changes or removes a given entry in the object’s metadata. Metadata are serialized and can take any Variant
value.
To remove a given entry from the object’s metadata, use remove_meta
. Metadata is also removed if its value is set to null
. This means you can also use set_meta("name", null)
to remove metadata for "name"
.
sourcepub fn set_script(&self, script: impl AsArg<Reference>)
pub fn set_script(&self, script: impl AsArg<Reference>)
Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality.
If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script’s [_init
][Self::_init] method will be called.
sourcepub fn to_string(&self) -> GodotString
pub fn to_string(&self) -> GodotString
sourcepub fn tr(&self, message: impl Into<GodotString>) -> GodotString
pub fn tr(&self, message: impl Into<GodotString>) -> GodotString
Translates a message using translation catalogs configured in the Project Settings.
Only works if message translation is enabled (which it is by default), otherwise it returns the message
unchanged. See set_message_translation
.
Trait Implementations§
source§impl Debug for AudioServer
impl Debug for AudioServer
source§impl Deref for AudioServer
impl Deref for AudioServer
source§impl DerefMut for AudioServer
impl DerefMut for AudioServer
source§impl GodotObject for AudioServer
impl GodotObject for AudioServer
§type Memory = ManuallyManaged
type Memory = ManuallyManaged
Ref
smart pointer. See its type-level documentation for more
information.fn class_name() -> &'static str
source§fn null() -> Null<Self>
fn null() -> Null<Self>
Self
as a method argument. This makes type
inference easier for the compiler compared to Option
.