Struct roblox::instance::CustomEvent[−][src]

pub struct CustomEvent<'a> {Show 15 fields
    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 receiver_connected: RBXScriptSignal<Option<InstanceRef>>,
    pub receiver_disconnected: RBXScriptSignal<Option<InstanceRef>>,
    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>>,
}

👎 Deprecated

Expand description

The CustomEvent Instance Class

View Roblox documentation

Fields

archivable: bool

👎 Deprecated

Inherited from Instance

class_name: &'a str

👎 Deprecated

Inherited from Instance

name: &'a str

👎 Deprecated

Inherited from Instance

parent: Option<InstanceRef>

👎 Deprecated

Inherited from Instance

roblox_locked: bool

👎 Deprecated

Inherited from Instance

source_asset_id: i64

👎 Deprecated

Inherited from Instance

receiver_connected: RBXScriptSignal<Option<InstanceRef>>

👎 Deprecated

receiver_disconnected: RBXScriptSignal<Option<InstanceRef>>

👎 Deprecated

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

👎 Deprecated

Inherited from Instance

attribute_changed: RBXScriptSignal<&'a str>

👎 Deprecated

Inherited from Instance

changed: RBXScriptSignal<&'a str>

👎 Deprecated

Inherited from Instance

child_added: RBXScriptSignal<Option<InstanceRef>>

👎 Deprecated

Inherited from Instance

child_removed: RBXScriptSignal<Option<InstanceRef>>

👎 Deprecated

Inherited from Instance

descendant_added: RBXScriptSignal<Option<InstanceRef>>

👎 Deprecated

Inherited from Instance

descendant_removing: RBXScriptSignal<Option<InstanceRef>>

👎 Deprecated

Inherited from Instance

Implementations

impl<'a> CustomEvent<'a>

pub fn new() -> Self

Creates a new CustomEvent object.

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

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

pub fn set_value(&self, new_value: f32)

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 CustomEvent<'a>

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

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl<'a> Debug for CustomEvent<'a>

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

Formats the value using the given formatter. Read more

impl<'a> PartialEq<CustomEvent<'a>> for CustomEvent<'a>

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

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

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

This method tests for !=.

impl<'a> Copy for CustomEvent<'a>

impl<'a> StructuralPartialEq for CustomEvent<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for CustomEvent<'a>

impl<'a> Send for CustomEvent<'a>

impl<'a> Sync for CustomEvent<'a>

impl<'a> Unpin for CustomEvent<'a>

impl<'a> UnwindSafe for CustomEvent<'a>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.