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

pub struct UserInputService<'a> {Show 61 fields
    pub accelerometer_enabled: bool,
    pub bottom_bar_size: Vector2,
    pub gamepad_enabled: bool,
    pub gaze_selection_enabled: bool,
    pub gyroscope_enabled: bool,
    pub keyboard_enabled: bool,
    pub legacy_input_events_enabled: bool,
    pub mouse_behavior: MouseBehavior,
    pub mouse_delta_sensitivity: f32,
    pub mouse_enabled: bool,
    pub mouse_icon_enabled: bool,
    pub nav_bar_size: Vector2,
    pub on_screen_keyboard_animation_duration: f64,
    pub on_screen_keyboard_position: Vector2,
    pub on_screen_keyboard_size: Vector2,
    pub on_screen_keyboard_visible: bool,
    pub override_mouse_icon_behavior: OverrideMouseIconBehavior,
    pub right_bar_size: Vector2,
    pub status_bar_size: Vector2,
    pub touch_enabled: bool,
    pub vr_enabled: bool,
    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 device_acceleration_changed: RBXScriptSignal<Option<InstanceRef>>,
    pub device_gravity_changed: RBXScriptSignal<Option<InstanceRef>>,
    pub device_rotation_changed: RBXScriptSignal<(Option<InstanceRef>, CFrame)>,
    pub gamepad_connected: RBXScriptSignal<UserInputType>,
    pub gamepad_disconnected: RBXScriptSignal<UserInputType>,
    pub input_began: RBXScriptSignal<(Option<InstanceRef>, bool)>,
    pub input_changed: RBXScriptSignal<(Option<InstanceRef>, bool)>,
    pub input_ended: RBXScriptSignal<(Option<InstanceRef>, bool)>,
    pub jump_request: RBXScriptSignal<()>,
    pub last_input_type_changed: RBXScriptSignal<UserInputType>,
    pub pointer_action: RBXScriptSignal<(f32, Vector2, f32, bool)>,
    pub status_bar_tapped: RBXScriptSignal<Vector2>,
    pub text_box_focus_released: RBXScriptSignal<Option<InstanceRef>>,
    pub text_box_focused: RBXScriptSignal<Option<InstanceRef>>,
    pub touch_ended: RBXScriptSignal<(Option<InstanceRef>, bool)>,
    pub touch_long_press: RBXScriptSignal<(Array<Variant<'a, ()>>, UserInputState, bool)>,
    pub touch_moved: RBXScriptSignal<(Option<InstanceRef>, bool)>,
    pub touch_pan: RBXScriptSignal<(Array<Variant<'a, ()>>, Vector2, Vector2, UserInputState, bool)>,
    pub touch_pinch: RBXScriptSignal<(Array<Variant<'a, ()>>, f32, f32, UserInputState, bool)>,
    pub touch_rotate: RBXScriptSignal<(Array<Variant<'a, ()>>, f32, f32, UserInputState, bool)>,
    pub touch_started: RBXScriptSignal<(Option<InstanceRef>, bool)>,
    pub touch_swipe: RBXScriptSignal<(SwipeDirection, i32, bool)>,
    pub touch_tap: RBXScriptSignal<(Array<Variant<'a, ()>>, bool)>,
    pub touch_tap_in_world: RBXScriptSignal<(Vector2, bool)>,
    pub user_c_frame_changed: RBXScriptSignal<(UserCFrame, CFrame)>,
    pub window_focus_released: RBXScriptSignal<()>,
    pub window_focused: RBXScriptSignal<()>,
    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 UserInputService Instance Class

View Roblox documentation

Fields

accelerometer_enabled: boolbottom_bar_size: Vector2gamepad_enabled: boolgaze_selection_enabled: boolgyroscope_enabled: boolkeyboard_enabled: boollegacy_input_events_enabled: boolmouse_behavior: MouseBehaviormouse_delta_sensitivity: f32mouse_enabled: boolmouse_icon_enabled: boolnav_bar_size: Vector2on_screen_keyboard_animation_duration: f64on_screen_keyboard_position: Vector2on_screen_keyboard_size: Vector2on_screen_keyboard_visible: booloverride_mouse_icon_behavior: OverrideMouseIconBehaviorright_bar_size: Vector2status_bar_size: Vector2touch_enabled: boolvr_enabled: boolarchivable: 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

device_acceleration_changed: RBXScriptSignal<Option<InstanceRef>>device_gravity_changed: RBXScriptSignal<Option<InstanceRef>>device_rotation_changed: RBXScriptSignal<(Option<InstanceRef>, CFrame)>gamepad_connected: RBXScriptSignal<UserInputType>gamepad_disconnected: RBXScriptSignal<UserInputType>input_began: RBXScriptSignal<(Option<InstanceRef>, bool)>input_changed: RBXScriptSignal<(Option<InstanceRef>, bool)>input_ended: RBXScriptSignal<(Option<InstanceRef>, bool)>jump_request: RBXScriptSignal<()>last_input_type_changed: RBXScriptSignal<UserInputType>pointer_action: RBXScriptSignal<(f32, Vector2, f32, bool)>status_bar_tapped: RBXScriptSignal<Vector2>text_box_focus_released: RBXScriptSignal<Option<InstanceRef>>text_box_focused: RBXScriptSignal<Option<InstanceRef>>touch_ended: RBXScriptSignal<(Option<InstanceRef>, bool)>touch_long_press: RBXScriptSignal<(Array<Variant<'a, ()>>, UserInputState, bool)>touch_moved: RBXScriptSignal<(Option<InstanceRef>, bool)>touch_pan: RBXScriptSignal<(Array<Variant<'a, ()>>, Vector2, Vector2, UserInputState, bool)>touch_pinch: RBXScriptSignal<(Array<Variant<'a, ()>>, f32, f32, UserInputState, bool)>touch_rotate: RBXScriptSignal<(Array<Variant<'a, ()>>, f32, f32, UserInputState, bool)>touch_started: RBXScriptSignal<(Option<InstanceRef>, bool)>touch_swipe: RBXScriptSignal<(SwipeDirection, i32, bool)>touch_tap: RBXScriptSignal<(Array<Variant<'a, ()>>, bool)>touch_tap_in_world: RBXScriptSignal<(Vector2, bool)>user_c_frame_changed: RBXScriptSignal<(UserCFrame, CFrame)>window_focus_released: RBXScriptSignal<()>window_focused: RBXScriptSignal<()>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::UserInputService[−][src]

Fields

Implementations

impl<'a> UserInputService<'a>

pub fn gamepad_supports( &self, gamepad_num: UserInputType, gamepad_key_code: KeyCode) -> bool

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

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

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

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

pub fn get_device_type(&self) -> DeviceType

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

pub fn get_gamepad_connected(&self, gamepad_num: UserInputType) -> bool

pub fn get_gamepad_state( &self, gamepad_num: UserInputType) -> Array<Variant<'a, ()>>

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

pub fn get_last_input_type(&self) -> UserInputType

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

pub fn get_mouse_delta(&self) -> Vector2

pub fn get_mouse_location(&self) -> Vector2

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

pub fn get_platform(&self) -> Platform

pub fn get_string_for_key_code(&self, key_code: KeyCode) -> &'a str

pub fn get_supported_gamepad_key_codes( &self, gamepad_num: UserInputType) -> Array<Variant<'a, ()>>

pub fn get_user_c_frame(&self, type: UserCFrame) -> CFrame

pub fn is_gamepad_button_down( &self, gamepad_num: UserInputType, gamepad_key_code: KeyCode) -> bool

pub fn is_key_down(&self, key_code: KeyCode) -> bool

pub fn is_mouse_button_pressed(&self, mouse_button: UserInputType) -> bool

pub fn is_navigation_gamepad(&self, gamepad_enum: UserInputType) -> bool

pub fn recenter_user_head_c_frame(&self)

pub fn send_app_ui_sizes( &self, status_bar_size: Vector2, nav_bar_size: Vector2, bottom_bar_size: Vector2, right_bar_size: Vector2)

pub fn set_navigation_gamepad(&self, gamepad_enum: UserInputType, enabled: bool)

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

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

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

impl<'a> Debug for UserInputService<'a>

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

impl<'a> PartialEq<UserInputService<'a>> for UserInputService<'a>

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

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

impl<'a> Copy for UserInputService<'a>

impl<'a> StructuralPartialEq for UserInputService<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for UserInputService<'a>

impl<'a> Send for UserInputService<'a>

impl<'a> Sync for UserInputService<'a>

impl<'a> Unpin for UserInputService<'a>

impl<'a> UnwindSafe for UserInputService<'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 gamepad_supports(
&self,
gamepad_num: UserInputType,
gamepad_key_code: KeyCode
) -> bool

pub fn get_gamepad_state(
&self,
gamepad_num: UserInputType
) -> Array<Variant<'a, ()>>

pub fn get_supported_gamepad_key_codes(
&self,
gamepad_num: UserInputType
) -> Array<Variant<'a, ()>>

pub fn is_gamepad_button_down(
&self,
gamepad_num: UserInputType,
gamepad_key_code: KeyCode
) -> bool

pub fn send_app_ui_sizes(
&self,
status_bar_size: Vector2,
nav_bar_size: Vector2,
bottom_bar_size: Vector2,
right_bar_size: Vector2
)

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>,