Selection

Show Deprecated
Not Creatable
Service

The Selection service controls the Instances that are selected in Roblox Studio.

This service is particularly useful when developing Plugins, as it allows the developer to access and manipulate the current selection.

Currently selected Instances can be obtained and set using the Selection:Get() and Selection:Set() functions. The Selection.SelectionChanged event fires whenever the current selection changes.

For more information on using Selection and Plugins, see Plugin.

Selection is also often used in the command bar, to set hidden properties or run functions for selected Instances.

Note this class only applies to Roblox Studio and has no applicability to games.

Code Samples

Selection
local Selection = game:GetService("Selection")



for _, object in pairs(Selection:Get()) do

	if object:IsA("BasePart") then

		object.CFrame = object.CFrame * CFrame.Angles(0, math.pi / 2, 0)

	end

end

Summary

Methods

  • Add(instancesToAdd : Instances):void
    Plugin Security
  • Get():Instances
    Plugin Security

    Returns an array of currently selected Instances in Roblox Studio.

  • Remove(instancesToRemove : Instances):void
    Plugin Security
  • Set(selection : Instances):void
    Plugin Security

    Sets the currently selected objects in Roblox Studio to Instances in the given array.

View all inherited from Instance
View all inherited from Object

Properties

SelectionThickness

number
Read Only
Not Replicated
Read Parallel
View all inherited from Instance
View all inherited from Object

Methods

Add

void
Plugin Security

Parameters

instancesToAdd: Instances

Returns

void

Get

Instances
Plugin Security

Returns an array of currently selected Instances in Roblox Studio.

If no Instances are selected, the array returned be empty. This function can be used in conjunction with the Selection.SelectionChanged event to get the selection whenever it changes.

Note, this function can only be used in Plugins or the command line.

For changing the current selection, please see Selection:Set().


Returns

Instances

An array of currently selected Instances.

Code Samples

Selection
local Selection = game:GetService("Selection")



for _, object in pairs(Selection:Get()) do

	if object:IsA("BasePart") then

		object.CFrame = object.CFrame * CFrame.Angles(0, math.pi / 2, 0)

	end

end
Selection.SelectionChanged
local selection = game:GetService("Selection")



selection.SelectionChanged:Connect(function()

	print("Selection contains " .. #selection:Get() .. " items.")

end)

Remove

void
Plugin Security

Parameters

instancesToRemove: Instances

Returns

void

Set

void
Plugin Security

Sets the currently selected objects in Roblox Studio to Instances in the given array.

Calling this function will cause the Selection.SelectionChanged event to fire, unless the new selection set is identical to the previous selection.

Note this function overwrites the existing selection. However, using Selection:Get() an Instance can be added to the existing selection like so:

local selected = Selection:Get()

table.insert(selected, object)

Selection:Set(selected)

Parameters

selection: Instances

An array of Instances to set the current selection to.


Returns

void

Code Samples

Selection Set
local Selection = game:GetService("Selection")



local newSelection = {}

for _, object in pairs(workspace:GetDescendants()) do

	if object:IsA("BasePart") and object.BrickColor == BrickColor.new("Bright red") then

		table.insert(newSelection, object)

	end

end



Selection:Set(newSelection)
View all inherited from Instance
View all inherited from Object

Events

SelectionChanged

Fires when the Instances selected in Roblox Studio changes.

Note this event does not give the new selection. Developers will need to use the Selection:Get() function to obtain the current selection.

Although this event can be used outside of plugins and the command bar, it only applies to the selection in Roblox Studio and therefore has no functionality outside of Studio.

To change the selection use the Selection:Set() function.


Code Samples

Selection.SelectionChanged
local selection = game:GetService("Selection")



selection.SelectionChanged:Connect(function()

	print("Selection contains " .. #selection:Get() .. " items.")

end)
View all inherited from Instance
View all inherited from Object