Struct roblox::instance::Plugin

pub struct Plugin<'a> {

    pub collision_enabled: bool,
    pub grid_size: f32,
    pub host_data_model_type: StudioDataModelType,
    pub host_data_model_type_is_current: bool,
    pub multiple_document_interface_instance: Option<InstanceRef>,
    pub uses_asset_insertion_drag: 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 deactivation: RBXScriptSignal<()>,
    pub ready: RBXScriptSignal<()>,
    pub unloading: 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>>,
}

The Plugin Instance Class

View Roblox documentation

Fields

collision_enabled: bool

grid_size: f32

host_data_model_type: StudioDataModelType

host_data_model_type_is_current: bool

multiple_document_interface_instance: Option<InstanceRef>

uses_asset_insertion_drag: bool

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

deactivation: RBXScriptSignal<()>

ready: RBXScriptSignal<()>

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

Implementations

impl<'a> Plugin<'a>

pub fn activate(&self, exclusive_mouse: bool)

pub fn create_plugin_action(
    &self,
    action_id: &'a str,
    text: &'a str,
    status_tip: &'a str,
    icon_name: &'a str,
    allow_binding: bool
) -> Option<InstanceRef>

pub fn create_plugin_menu(
    &self,
    id: &'a str,
    title: &'a str,
    icon: &'a str
) -> Option<InstanceRef>

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

pub fn deactivate(&self)

pub fn get_item(
    &self,
    key: &'a str,
    default_value: Variant<'a, ()>
) -> Variant<'a, ()>

pub fn get_join_mode(&self) -> JointCreationMode

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

pub fn get_selected_ribbon_tool(&self) -> RibbonTool

pub fn get_setting(&self, key: &'a str) -> Variant<'a, ()>

pub fn invoke(&self, key: &'a str, arguments: Array<Variant<'a, ()>>)

pub fn is_activated(&self) -> bool

pub fn is_activated_with_exclusive_mouse(&self) -> bool

pub fn negate(&self, objects: Array<Instance<'a>>) -> Array<Instance<'a>>

pub fn on_invoke(
    &self,
    key: &'a str,
    callback: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>
) -> Option<InstanceRef>

pub fn on_set_item(
    &self,
    key: &'a str,
    callback: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>
) -> Option<InstanceRef>

pub fn open_script(&self, script: Option<InstanceRef>, line_number: i32)

pub fn open_wiki_page(&self, url: &'a str)

pub fn pause_sound(&self, sound: Option<InstanceRef>)

pub fn play_sound(
    &self,
    sound: Option<InstanceRef>,
    normalized_time_position: f64
)

pub fn resume_sound(&self, sound: Option<InstanceRef>)

pub fn save_selected_to_roblox(&self)

pub fn select_ribbon_tool(&self, tool: RibbonTool, position: UDim2)

pub fn separate(&self, objects: Array<Instance<'a>>) -> Array<Instance<'a>>

pub fn set_item(&self, key: &'a str, value: Variant<'a, ()>)

pub fn set_ready(&self)

pub fn set_setting(&self, key: &'a str, value: Variant<'a, ()>)

pub fn start_decal_drag(&self, decal: Option<InstanceRef>)

pub fn start_drag(&self, drag_data: Dictionary)

pub fn stop_all_sounds(&self)

pub fn union(&self, objects: Array<Instance<'a>>) -> Option<InstanceRef>

pub fn create_dock_widget_plugin_gui(
    &self,
    plugin_gui_id: &'a str,
    dock_widget_plugin_gui_info: DockWidgetPluginGuiInfo
) -> Option<InstanceRef>

pub fn create_q_widget_plugin_gui(
    &self,
    plugin_gui_id: &'a str,
    plugin_gui_options: Dictionary
) -> Option<InstanceRef>

pub fn import_fbx_animation(
    &self,
    rig_model: Option<InstanceRef>,
    is_r15: bool
) -> Option<InstanceRef>

pub fn import_fbx_rig(&self, is_r15: bool) -> Option<InstanceRef>

pub fn prompt_for_existing_asset_id(&self, asset_type: &'a str) -> i64

pub fn prompt_save_selection(&self, suggested_file_name: &'a str) -> bool

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Plugin<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Plugin<'a>> for Plugin<'a>

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

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

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

This method tests for !=.

impl<'a> Copy for Plugin<'a>

impl<'a> StructuralPartialEq for Plugin<'a>