Struct roblox::instance::Sound

pub struct Sound<'a> {

    pub channel_count: i32,
    pub is_loaded: bool,
    pub is_paused: bool,
    pub is_playing: bool,
    pub looped: bool,
    pub play_on_remove: bool,
    pub playback_loudness: f64,
    pub playback_speed: f32,
    pub playing: bool,
    pub roll_off_max_distance: f32,
    pub roll_off_min_distance: f32,
    pub roll_off_mode: RollOffMode,
    pub sound_group: Option<InstanceRef>,
    pub sound_id: &'a str,
    pub time_length: f64,
    pub time_position: f64,
    pub volume: f32,
    pub archivable: bool,
    pub class_name: &'a str,
    pub name: &'a str,
    pub parent: Option<InstanceRef>,
    pub roblox_locked: bool,
    pub source_asset_id: i64,
    pub did_loop: RBXScriptSignal<(&'a str, i32)>,
    pub ended: RBXScriptSignal<&'a str>,
    pub loaded: RBXScriptSignal<&'a str>,
    pub paused: RBXScriptSignal<&'a str>,
    pub played: RBXScriptSignal<&'a str>,
    pub resumed: RBXScriptSignal<&'a str>,
    pub stopped: RBXScriptSignal<&'a str>,
    pub ancestry_changed: RBXScriptSignal<(Option<InstanceRef>, Option<InstanceRef>)>,
    pub attribute_changed: RBXScriptSignal<&'a str>,
    pub changed: RBXScriptSignal<&'a str>,
    pub child_added: RBXScriptSignal<Option<InstanceRef>>,
    pub child_removed: RBXScriptSignal<Option<InstanceRef>>,
    pub descendant_added: RBXScriptSignal<Option<InstanceRef>>,
    pub descendant_removing: RBXScriptSignal<Option<InstanceRef>>,
}

The Sound Instance Class

View Roblox documentation

Fields

channel_count: i32

is_loaded: bool

is_paused: bool

is_playing: bool

looped: bool

play_on_remove: bool

playback_loudness: f64

playback_speed: f32

playing: bool

roll_off_max_distance: f32

roll_off_min_distance: f32

roll_off_mode: RollOffMode

sound_group: Option<InstanceRef>

sound_id: &'a str

time_length: f64

time_position: f64

volume: f32

archivable: bool

Inherited from Instance

class_name: &'a str

Inherited from Instance

name: &'a str

Inherited from Instance

parent: Option<InstanceRef>

Inherited from Instance

roblox_locked: bool

Inherited from Instance

source_asset_id: i64

Inherited from Instance

did_loop: RBXScriptSignal<(&'a str, i32)>

ended: RBXScriptSignal<&'a str>

loaded: RBXScriptSignal<&'a str>

paused: RBXScriptSignal<&'a str>

played: RBXScriptSignal<&'a str>

resumed: RBXScriptSignal<&'a str>

stopped: RBXScriptSignal<&'a str>

ancestry_changed: RBXScriptSignal<(Option<InstanceRef>, Option<InstanceRef>)>

Inherited from Instance

attribute_changed: RBXScriptSignal<&'a str>

Inherited from Instance

changed: RBXScriptSignal<&'a str>

Inherited from Instance

child_added: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

child_removed: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

descendant_added: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

descendant_removing: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

Implementations

impl<'a> Sound<'a>

pub fn new() -> Self

Creates a new Sound object.

Equivalent to Instance.new(“Sound”) in Luau.

pub fn pause(&self)

pub fn play(&self)

pub fn resume(&self)

pub fn stop(&self)

pub fn clear_all_children(&self)

Inherited from Instance

pub fn destroy(&self)

Inherited from Instance

pub fn find_first_ancestor(&self, name: &'a str) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_ancestor_of_class(
    &self,
    class_name: &'a str
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_ancestor_which_is_a(
    &self,
    class_name: &'a str
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_child(
    &self,
    name: &'a str,
    recursive: bool
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_child_of_class(
    &self,
    class_name: &'a str
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_child_which_is_a(
    &self,
    class_name: &'a str,
    recursive: bool
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_descendant(&self, name: &'a str) -> Option<InstanceRef>

Inherited from Instance

pub fn get_actor(&self) -> Option<InstanceRef>

Inherited from Instance

pub fn get_attribute(&self, attribute: &'a str) -> Variant<'a, ()>

Inherited from Instance

pub fn get_attribute_changed_signal(
    &self,
    attribute: &'a str
) -> RBXScriptSignal<()>

Inherited from Instance

pub fn get_attributes(&self) -> Dictionary

Inherited from Instance

pub fn get_children(&self) -> Array<Instance<'a>>

Inherited from Instance

pub fn get_debug_id(&self, scope_length: i32) -> &'a str

Inherited from Instance

pub fn get_descendants(&self) -> Array<Variant<'a, ()>>

Inherited from Instance

pub fn get_full_name(&self) -> &'a str

Inherited from Instance

pub fn get_property_changed_signal(
    &self,
    property: &'a str
) -> RBXScriptSignal<()>

Inherited from Instance

pub fn is_a(&self, class_name: &'a str) -> bool

Inherited from Instance

pub fn is_ancestor_of(&self, descendant: Option<InstanceRef>) -> bool

Inherited from Instance

pub fn is_descendant_of(&self, ancestor: Option<InstanceRef>) -> bool

Inherited from Instance

pub fn set_attribute(&self, attribute: &'a str, value: Variant<'a, ()>)

Inherited from Instance

pub fn wait_for_child(
    &self,
    child_name: &'a str,
    time_out: f64
) -> Option<InstanceRef>

Inherited from Instance

Trait Implementations

impl<'a> Clone for Sound<'a>

fn clone(&self) -> Sound<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Sound<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Sound<'a>> for Sound<'a>

fn eq(&self, other: &Sound<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Sound<'a>) -> bool

This method tests for !=.

impl<'a> Copy for Sound<'a>

impl<'a> StructuralPartialEq for Sound<'a>