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

pub struct UserGameSettings<'a> {Show 53 fields
    pub all_tutorials_disabled: bool,
    pub camera_mode: CustomCameraMode,
    pub camera_y_inverted: bool,
    pub chat_visible: bool,
    pub computer_camera_movement_mode: ComputerCameraMovementMode,
    pub computer_movement_mode: ComputerMovementMode,
    pub control_mode: ControlMode,
    pub fullscreen: bool,
    pub gamepad_camera_sensitivity: f32,
    pub graphics_quality_level: i32,
    pub has_ever_used_vr: bool,
    pub is_using_camera_y_inverted: bool,
    pub is_using_gamepad_camera_sensitivity: bool,
    pub master_volume: f32,
    pub micro_profiler_web_server_enabled: bool,
    pub micro_profiler_web_server_ip: &'a str,
    pub micro_profiler_web_server_port: i32,
    pub mouse_sensitivity: f32,
    pub mouse_sensitivity_first_person: Vector2,
    pub mouse_sensitivity_third_person: Vector2,
    pub on_screen_profiler_enabled: bool,
    pub onboardings_completed: &'a str,
    pub performance_stats_visible: bool,
    pub rcc_profiler_record_frame_rate: i32,
    pub rcc_profiler_record_time_frame: i32,
    pub rotation_type: RotationType,
    pub saved_quality_level: SavedQualitySetting,
    pub start_maximized: bool,
    pub start_screen_position: Vector2,
    pub start_screen_size: Vector2,
    pub touch_camera_movement_mode: TouchCameraMovementMode,
    pub touch_movement_mode: TouchMovementMode,
    pub used_core_gui_is_visible_toggle: bool,
    pub used_custom_gui_is_visible_toggle: bool,
    pub used_hide_hud_shortcut: bool,
    pub vr_enabled: bool,
    pub vr_rotation_intensity: i32,
    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 fullscreen_changed: RBXScriptSignal<bool>,
    pub performance_stats_visible_changed: RBXScriptSignal<bool>,
    pub studio_mode_changed: RBXScriptSignal<bool>,
    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 UserGameSettings Instance Class

View Roblox documentation

Fields

all_tutorials_disabled: boolcamera_mode: CustomCameraModecamera_y_inverted: boolchat_visible: boolcomputer_camera_movement_mode: ComputerCameraMovementModecomputer_movement_mode: ComputerMovementModecontrol_mode: ControlModefullscreen: boolgamepad_camera_sensitivity: f32graphics_quality_level: i32has_ever_used_vr: boolis_using_camera_y_inverted: boolis_using_gamepad_camera_sensitivity: boolmaster_volume: f32micro_profiler_web_server_enabled: boolmicro_profiler_web_server_ip: &'a strmicro_profiler_web_server_port: i32mouse_sensitivity: f32mouse_sensitivity_first_person: Vector2mouse_sensitivity_third_person: Vector2on_screen_profiler_enabled: boolonboardings_completed: &'a strperformance_stats_visible: boolrcc_profiler_record_frame_rate: i32rcc_profiler_record_time_frame: i32rotation_type: RotationTypesaved_quality_level: SavedQualitySettingstart_maximized: boolstart_screen_position: Vector2start_screen_size: Vector2touch_camera_movement_mode: TouchCameraMovementModetouch_movement_mode: TouchMovementModeused_core_gui_is_visible_toggle: boolused_custom_gui_is_visible_toggle: boolused_hide_hud_shortcut: boolvr_enabled: boolvr_rotation_intensity: i32archivable: 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

fullscreen_changed: RBXScriptSignal<bool>performance_stats_visible_changed: RBXScriptSignal<bool>studio_mode_changed: RBXScriptSignal<bool>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::UserGameSettings[−][src]

Fields

Implementations

impl<'a> UserGameSettings<'a>

pub fn get_camera_y_invert_value(&self) -> i32

pub fn get_onboarding_completed(&self, onboarding_id: &'a str) -> bool

pub fn get_tutorial_state(&self, tutorial_id: &'a str) -> bool

pub fn in_full_screen(&self) -> bool

pub fn in_studio_mode(&self) -> bool

pub fn reset_onboarding_completed(&self, onboarding_id: &'a str)

pub fn set_camera_y_invert_visible(&self)

pub fn set_gamepad_camera_sensitivity_visible(&self)

pub fn set_onboarding_completed(&self, onboarding_id: &'a str)

pub fn set_tutorial_state(&self, tutorial_id: &'a str, value: 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 UserGameSettings<'a>

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

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

impl<'a> Debug for UserGameSettings<'a>

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

impl<'a> PartialEq<UserGameSettings<'a>> for UserGameSettings<'a>

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

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

impl<'a> Copy for UserGameSettings<'a>

impl<'a> StructuralPartialEq for UserGameSettings<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for UserGameSettings<'a>

impl<'a> Send for UserGameSettings<'a>

impl<'a> Sync for UserGameSettings<'a>

impl<'a> Unpin for UserGameSettings<'a>

impl<'a> UnwindSafe for UserGameSettings<'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>,