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

pub struct ProximityPrompt<'a> {Show 33 fields
    pub action_text: &'a str,
    pub auto_localize: bool,
    pub clickable_prompt: bool,
    pub enabled: bool,
    pub exclusivity: ProximityPromptExclusivity,
    pub gamepad_key_code: KeyCode,
    pub hold_duration: f32,
    pub keyboard_key_code: KeyCode,
    pub max_activation_distance: f32,
    pub object_text: &'a str,
    pub requires_line_of_sight: bool,
    pub root_localization_table: Option<InstanceRef>,
    pub style: ProximityPromptStyle,
    pub ui_offset: Vector2,
    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 prompt_button_hold_began: RBXScriptSignal<Option<InstanceRef>>,
    pub prompt_button_hold_ended: RBXScriptSignal<Option<InstanceRef>>,
    pub prompt_hidden: RBXScriptSignal<()>,
    pub prompt_shown: RBXScriptSignal<ProximityPromptInputType>,
    pub trigger_ended: RBXScriptSignal<Option<InstanceRef>>,
    pub triggered: 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>>,
}

Expand description

The ProximityPrompt Instance Class

View Roblox documentation

Fields

action_text: &'a strauto_localize: boolclickable_prompt: boolenabled: boolexclusivity: ProximityPromptExclusivitygamepad_key_code: KeyCodehold_duration: f32keyboard_key_code: KeyCodemax_activation_distance: f32object_text: &'a strrequires_line_of_sight: boolroot_localization_table: Option<InstanceRef>style: ProximityPromptStyleui_offset: Vector2archivable: 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

prompt_button_hold_began: RBXScriptSignal<Option<InstanceRef>>prompt_button_hold_ended: RBXScriptSignal<Option<InstanceRef>>prompt_hidden: RBXScriptSignal<()>prompt_shown: RBXScriptSignal<ProximityPromptInputType>trigger_ended: RBXScriptSignal<Option<InstanceRef>>triggered: RBXScriptSignal<Option<InstanceRef>>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

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

Fields

Implementations

impl<'a> ProximityPrompt<'a>

pub fn new() -> Self

pub fn input_hold_begin(&self)

pub fn input_hold_end(&self)

pub fn clear_all_children(&self)

pub fn destroy(&self)

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

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

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

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

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

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

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

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

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

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

pub fn get_attributes(&self) -> Dictionary

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl<'a> Clone for ProximityPrompt<'a>

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

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

impl<'a> Debug for ProximityPrompt<'a>

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

impl<'a> PartialEq<ProximityPrompt<'a>> for ProximityPrompt<'a>

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

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

impl<'a> Copy for ProximityPrompt<'a>

impl<'a> StructuralPartialEq for ProximityPrompt<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for ProximityPrompt<'a>

impl<'a> Send for ProximityPrompt<'a>

impl<'a> Sync for ProximityPrompt<'a>

impl<'a> Unpin for ProximityPrompt<'a>

impl<'a> UnwindSafe for ProximityPrompt<'a>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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

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

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> ToOwned for T where
T: Clone,

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

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