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

pub struct GuiService<'a> {Show 38 fields
    pub auto_select_gui_enabled: bool,
    pub core_effect_folder: Option<InstanceRef>,
    pub core_gui_folder: Option<InstanceRef>,
    pub core_gui_navigation_enabled: bool,
    pub gui_navigation_enabled: bool,
    pub menu_is_open: bool,
    pub selected_core_object: Option<InstanceRef>,
    pub selected_object: Option<InstanceRef>,
    pub touch_controls_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 close_inspect_menu_request: RBXScriptSignal<()>,
    pub core_gui_render_overflowed: RBXScriptSignal<()>,
    pub emotes_menu_open_changed: RBXScriptSignal<bool>,
    pub inspect_menu_enabled_changed_signal: RBXScriptSignal<bool>,
    pub inspect_player_from_humanoid_description_request: RBXScriptSignal<(Option<InstanceRef>, &'a str)>,
    pub inspect_player_from_user_id_with_ctx_request: RBXScriptSignal<(i64, &'a str)>,
    pub key_pressed: RBXScriptSignal<(&'a str, &'a str)>,
    pub menu_closed: RBXScriptSignal<()>,
    pub menu_opened: RBXScriptSignal<()>,
    pub native_close: RBXScriptSignal<()>,
    pub network_paused_enabled_changed: RBXScriptSignal<bool>,
    pub open9_slice_editor: RBXScriptSignal<Option<InstanceRef>>,
    pub safe_zone_offsets_changed: RBXScriptSignal<()>,
    pub show_leave_confirmation: RBXScriptSignal<()>,
    pub special_key_pressed: RBXScriptSignal<(SpecialKey, &'a str)>,
    pub ui_message_changed: RBXScriptSignal<(UiMessageType, &'a str)>,
    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 GuiService Instance Class

View Roblox documentation

Fields

auto_select_gui_enabled: boolcore_effect_folder: Option<InstanceRef>core_gui_folder: Option<InstanceRef>core_gui_navigation_enabled: boolgui_navigation_enabled: boolmenu_is_open: boolselected_core_object: Option<InstanceRef>selected_object: Option<InstanceRef>touch_controls_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

close_inspect_menu_request: RBXScriptSignal<()>core_gui_render_overflowed: RBXScriptSignal<()>emotes_menu_open_changed: RBXScriptSignal<bool>inspect_menu_enabled_changed_signal: RBXScriptSignal<bool>inspect_player_from_humanoid_description_request: RBXScriptSignal<(Option<InstanceRef>, &'a str)>inspect_player_from_user_id_with_ctx_request: RBXScriptSignal<(i64, &'a str)>key_pressed: RBXScriptSignal<(&'a str, &'a str)>menu_closed: RBXScriptSignal<()>menu_opened: RBXScriptSignal<()>native_close: RBXScriptSignal<()>network_paused_enabled_changed: RBXScriptSignal<bool>open9_slice_editor: RBXScriptSignal<Option<InstanceRef>>safe_zone_offsets_changed: RBXScriptSignal<()>show_leave_confirmation: RBXScriptSignal<()>special_key_pressed: RBXScriptSignal<(SpecialKey, &'a str)>ui_message_changed: RBXScriptSignal<(UiMessageType, &'a str)>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::GuiService[−][src]

Fields

Implementations

impl<'a> GuiService<'a>

pub fn add_center_dialog( &self, dialog: Option<InstanceRef>, center_dialog_type: CenterDialogType, show_function: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>, hide_function: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>)

pub fn add_key(&self, key: &'a str)

pub fn add_selection_parent( &self, selection_name: &'a str, selection_parent: Option<InstanceRef>)

pub fn add_selection_tuple( &self, selection_name: &'a str, selections: Array<Variant<'a, ()>>)

pub fn add_special_key(&self, key: SpecialKey)

pub fn broadcast_notification(&self, data: &'a str, notification_type: i32)

pub fn clear_error(&self)

pub fn close_inspect_menu(&self)

pub fn close_stats_based_on_input_string(&self, input: &'a str) -> bool

pub fn force_ten_foot_interface(&self, is_forced: bool)

pub fn get_brick_count(&self) -> i32

pub fn get_closest_dialog_to_position( &self, position: Vector3) -> Option<InstanceRef>

pub fn get_emotes_menu_open(&self) -> bool

pub fn get_error_code(&self) -> ConnectionError

pub fn get_error_type(&self) -> ConnectionError

pub fn get_gameplay_paused_notification_enabled(&self) -> bool

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

pub fn get_inspect_menu_enabled(&self) -> bool

pub fn get_notification_type_list(&self) -> Dictionary

pub fn get_resolution_scale(&self) -> i32

pub fn get_safe_zone_offsets(&self) -> Dictionary

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

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

pub fn inspect_player_from_user_id(&self, user_id: i64)

pub fn inspect_player_from_user_id_with_ctx(&self, user_id: i64, ctx: &'a str)

pub fn is_memory_tracker_enabled(&self) -> bool

pub fn is_ten_foot_interface(&self) -> bool

pub fn remove_center_dialog(&self, dialog: Option<InstanceRef>)

pub fn remove_key(&self, key: &'a str)

pub fn remove_selection_group(&self, selection_name: &'a str)

pub fn remove_special_key(&self, key: SpecialKey)

pub fn set_emotes_menu_open(&self, is_open: bool)

pub fn set_gameplay_paused_notification_enabled(&self, enabled: bool)

pub fn set_global_gui_inset(&self, x1: i32, y1: i32, x2: i32, y2: i32)

pub fn set_inspect_menu_enabled(&self, enabled: bool)

pub fn set_menu_is_open(&self, open: bool, menu_name: &'a str)

pub fn set_safe_zone_offsets( &self, top: f32, bottom: f32, left: f32, right: f32)

pub fn set_ui_message(&self, msg_type: UiMessageType, ui_message: &'a str)

pub fn show_stats_based_on_input_string(&self, input: &'a str) -> bool

pub fn toggle_fullscreen(&self)

pub fn get_screen_resolution(&self) -> Vector2

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

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

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

impl<'a> Debug for GuiService<'a>

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

impl<'a> PartialEq<GuiService<'a>> for GuiService<'a>

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

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

impl<'a> Copy for GuiService<'a>

impl<'a> StructuralPartialEq for GuiService<'a>

Auto Trait Implementations

pub fn add_center_dialog(
&self,
dialog: Option<InstanceRef>,
center_dialog_type: CenterDialogType,
show_function: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>,
hide_function: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>
)

pub fn add_selection_parent(
&self,
selection_name: &'a str,
selection_parent: Option<InstanceRef>
)

pub fn add_selection_tuple(
&self,
selection_name: &'a str,
selections: Array<Variant<'a, ()>>
)

pub fn get_closest_dialog_to_position(
&self,
position: Vector3
) -> Option<InstanceRef>

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

pub fn set_safe_zone_offsets(
&self,
top: f32,
bottom: f32,
left: f32,
right: f32
)

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