Struct roblox::instance::ContextActionService

pub struct ContextActionService<'a> {

    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 bound_action_added: RBXScriptSignal<(&'a str, bool, Dictionary, bool)>,
    pub bound_action_changed: RBXScriptSignal<(&'a str, &'a str, Dictionary)>,
    pub bound_action_removed: RBXScriptSignal<(&'a str, Dictionary, bool)>,
    pub get_action_button_event: RBXScriptSignal<&'a str>,
    pub local_tool_equipped: RBXScriptSignal<Option<InstanceRef>>,
    pub local_tool_unequipped: 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>>,
}

The ContextActionService Instance Class

View Roblox documentation

Fields

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

bound_action_added: RBXScriptSignal<(&'a str, bool, Dictionary, bool)>

bound_action_changed: RBXScriptSignal<(&'a str, &'a str, Dictionary)>

bound_action_removed: RBXScriptSignal<(&'a str, Dictionary, bool)>

get_action_button_event: RBXScriptSignal<&'a str>

local_tool_equipped: RBXScriptSignal<Option<InstanceRef>>

local_tool_unequipped: 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

Implementations

impl<'a> ContextActionService<'a>

pub fn bind_action(
    &self,
    action_name: &'a str,
    function_to_bind: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>,
    create_touch_button: bool,
    input_types: Array<Variant<'a, ()>>
)

pub fn bind_action_at_priority(
    &self,
    action_name: &'a str,
    function_to_bind: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>,
    create_touch_button: bool,
    priority_level: i32,
    input_types: Array<Variant<'a, ()>>
)

pub fn bind_activate(
    &self,
    user_input_type_for_activation: UserInputType,
    key_code_for_activation: KeyCode
)

pub fn bind_core_action(
    &self,
    action_name: &'a str,
    function_to_bind: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>,
    create_touch_button: bool,
    input_types: Array<Variant<'a, ()>>
)

pub fn bind_core_action_at_priority(
    &self,
    action_name: &'a str,
    function_to_bind: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>,
    create_touch_button: bool,
    priority_level: i32,
    input_types: Array<Variant<'a, ()>>
)

pub fn call_function(
    &self,
    action_name: &'a str,
    state: UserInputState,
    input_object: Option<InstanceRef>
) -> Array<Variant<'a, ()>>

pub fn fire_action_button_found_signal(
    &self,
    action_name: &'a str,
    action_button: Option<InstanceRef>
)

pub fn get_all_bound_action_info(&self) -> Dictionary

pub fn get_all_bound_core_action_info(&self) -> Dictionary

pub fn get_bound_action_info(&self, action_name: &'a str) -> Dictionary

pub fn get_bound_core_action_info(&self, action_name: &'a str) -> Dictionary

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

pub fn set_description(&self, action_name: &'a str, description: &'a str)

pub fn set_image(&self, action_name: &'a str, image: &'a str)

pub fn set_position(&self, action_name: &'a str, position: UDim2)

pub fn set_title(&self, action_name: &'a str, title: &'a str)

pub fn unbind_action(&self, action_name: &'a str)

pub fn unbind_activate(
    &self,
    user_input_type_for_activation: UserInputType,
    key_code_for_activation: KeyCode
)

pub fn unbind_all_actions(&self)

pub fn unbind_core_action(&self, action_name: &'a str)

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ContextActionService<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<ContextActionService<'a>> for ContextActionService<'a>

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

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

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

This method tests for !=.

impl<'a> Copy for ContextActionService<'a>

impl<'a> StructuralPartialEq for ContextActionService<'a>