Struct roblox::instance::StarterGui

pub struct StarterGui<'a> {

    pub process_user_input: bool,
    pub screen_orientation: ScreenOrientation,
    pub show_development_gui: bool,
    pub virtual_cursor_mode: VirtualCursorMode,
    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 core_gui_changed_signal: RBXScriptSignal<(CoreGuiType, 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>>,
}

The StarterGui Instance Class

View Roblox documentation

Fields

process_user_input: bool

screen_orientation: ScreenOrientation

show_development_gui: bool

virtual_cursor_mode: VirtualCursorMode

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

core_gui_changed_signal: RBXScriptSignal<(CoreGuiType, 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

Implementations

impl<'a> StarterGui<'a>

pub fn get_core_gui_enabled(&self, core_gui_type: CoreGuiType) -> bool

pub fn register_get_core(
    &self,
    parameter_name: &'a str,
    get_function: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>
)

pub fn register_set_core(
    &self,
    parameter_name: &'a str,
    set_function: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>
)

pub fn set_core(&self, parameter_name: &'a str, value: Variant<'a, ()>)

pub fn set_core_gui_enabled(&self, core_gui_type: CoreGuiType, enabled: bool)

pub fn get_core(&self, parameter_name: &'a str) -> Variant<'a, ()>

pub fn get_gui_objects_at_position(&self, x: i32, y: i32) -> Array<Instance<'a>>

Inherited from BasePlayerGui

pub fn get_gui_objects_in_circle(
    &self,
    position: Vector2,
    radius: f32
) -> Array<Instance<'a>>

Inherited from BasePlayerGui

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for StarterGui<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<StarterGui<'a>> for StarterGui<'a>

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

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

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

This method tests for !=.

impl<'a> Copy for StarterGui<'a>

impl<'a> StructuralPartialEq for StarterGui<'a>