PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

PluginMenu

Show deprecated

PluginMenu

Show deprecated

A context menu that can be shown in Studio. It displays a list of PluginActions and supports submenus.

PluginMenus must be created using the Plugin/CreatePluginMenu function in order to work as expected.

See also

  • articles/Intro to Plugins, an introductory article to plugin use and development
  • PluginAction, an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Button.
  • Plugin/CreatePluginAction, creates a PluginAction
  • PluginMenu/Title, the text to be displayed when used as a sub menu
  • PluginMenu/Icon, the icon to be displayed when used as a sub menu
  • PluginMenu/AddAction, adds the given action to the menu
  • PluginMenu/AddNewAction, creates a temporary action that is hidden from Studio’s customize shortcuts window
  • PluginMenu/AddMenu, adds the given menu as a separator
  • PluginMenu/AddSeparator, adds a separator between items in the menu
  • PluginMenu/Clear, clears the menu
  • PluginMenu/ShowAsync, shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed. The selected action fires its Triggered event

Properties

string

Icon

[NotReplicated]

The icon to be displayed when used as a sub menu

string

Title

[NotReplicated]

The text to be displayed when used as a sub menu

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]

The cost of saving the instance using data persistence.

Instance

Parent

Determines the hierarchical parent of the Instance.

bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to.

string

Name

A non-unique identifier of the Instance.

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

Functions

void

AddAction ( Instance action )

Adds the given action to the menu

void

AddMenu ( Instance menu )

Adds the given menu as a separator

Instance

AddNewAction ( string actionId , string text , string icon )

Creates a temporary action that is hidden from Studio’s customize shortcuts window

  • This function creates a temporary action that is hidden from Studio’s customize shortcuts window.

See also

  • articles/Intro to Plugins, an introductory article to plugin use and development
  • PluginAction, an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Button.
  • Plugin/CreatePluginAction, creates a PluginAction
  • PluginMenu/Title, the text to be displayed when used as a sub menu
  • PluginMenu/Icon, the icon to be displayed when used as a sub menu
  • PluginMenu/AddAction, adds the given action to the menu
  • PluginMenu/AddMenu, adds the given menu as a separator
  • PluginMenu/AddSeparator, adds a separator between items in the menu
  • PluginMenu/Clear, clears the menu
  • PluginMenu/ShowAsync, shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed. The selected action fires its Triggered event
void

AddSeparator ( )

Adds a separator between items in the menu

void

Clear ( )

Clears the menu

Instance

ShowAsync ( )

[Yields]

Shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed

Inherited from Instance: Show Hide

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

bool

IsA ( string className )

Returns true if an Instance's class matches or inherits from a given class

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance.

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.