RBX.lua.Selection (Service): Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
>Anaminus
cat: Services
>Tomtomn00
No edit summary
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{CatUp|Class reference}}
{{ObjectPage|name=Selection|The Selection service helps control the objects that are selected in the 3D view.
{{stub}}
__NOTOC__


The Selection object.
'''Usage'''<br>
In Studio or Edit mode, first select some bricks then:
{{Example|<pre>
local cf = CFrame.Angles( 0,math.pi,0 )
for _,v in pairs(game.Selection:Get()) do
  v.CFrame = cf * v.CFrame
end
</pre>}}


{{Service}}
Also, you can set which objects are selected with the Set method. So then you can do stuff like select all objects with a certain name, then quickly edit their properties as desired.


==Functions==
{{Example|<pre>
In addition to the global functions, the Selection also has these functions:
local select = {}
''<font color="red"># indicates a locked function. These should NOT be tampered with.</font>''
for _,v in pairs(workspace:GetChildren()) do
  if v.Name = "Part" then
    table.insert(select,v)
  end
end


*<font color="red">#</font>Get
game.Selection:Set(select)
*<font color="red">#</font>Set
</pre>}}}}
 
==Properties==
The Selection object only incorporates the global properties.
 
==Events==
The Selection object only incorporates the global events.
 
 
[[Category:ROBLOX Lua Services]]
[[Category:Stubs]]

Latest revision as of 19:59, 18 August 2011

Derived Classes
None
The Selection service helps control the objects that are selected in the 3D view.

Usage
In Studio or Edit mode, first select some bricks then:

Example
local cf = CFrame.Angles( 0,math.pi,0 )
for _,v in pairs(game.Selection:Get()) do 
  v.CFrame = cf * v.CFrame 
end


Also, you can set which objects are selected with the Set method. So then you can do stuff like select all objects with a certain name, then quickly edit their properties as desired.

Example
local select = {} 
for _,v in pairs(workspace:GetChildren()) do 
  if v.Name = "Part" then 
    table.insert(select,v) 
  end 
end 

game.Selection:Set(select)
Get( )
Returns Table Selection
Description: Returns a table of the selected objects
Member of: Selection
Protected:This item is protected. Attempting to use it in a Script or LocalScript will cause an error.
Set( Table selection )
Returns nil
Description: Set's the client's selected objects to all of those in the table. You can select objects you wouldn't normally be able to like DataModel, SocialService, and other non-browsable Instances.
Member of: Selection
Clone( )
Returns Instance
Description: Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of: Instance
FindFirstChild( string name, bool recursive = false )
Returns Instance
Description: Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of: Instance
GetChildren( )
Returns table
Description: Returns a read-only table of the object's children.
Member of: Instance
GetDebugId( int scopeLength )
Returns string
Description: Returns a coded string of the object's DebugId used internally by Roblox.
Member of: Instance
GetFullName( )
Returns String path to object
Description: Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of: Instance
IsA( string className )
Returns bool
Description: Returns true if the Instance is that class or a subclass.
Member of: Instance
IsAncestorOf( Instance descendant )
Returns boolean is ancestor
Description: Returns true if the object is an ancestor of descendant.
Member of: Instance
IsDescendantOf( Instance ancestor )
Returns bool
Description: Returns true if the object is an descendant of ancestor.
Member of: Instance
Destroy( )
Returns nil
Description: Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Member of: Instance
ClearAllChildren( )
Returns nil
Description: Removes all descendants of the Instance, but leaves the Instance itself.
Member of: Instance
Name
Type string
Description The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of Instance
Parent
Type Instance
Description The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of Instance
Archivable
Type bool
Description Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of Instance
ClassName
Type string
Description A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of Instance
RobloxLocked
Type bool
Description If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
Member of Instance
DataCost
Type int
Description How much saving this instance with SaveInstance will add to DataComplexity
Member of Instance
AncestryChanged ( Instance child, Instance parent )
Description Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of: Instance
Changed ( Property property )
Description Fired whenever a property of the object changes.
Member of: Instance
ChildAdded ( Instance child )
Description Fired after a child is added.
Member of: Instance
ChildRemoved ( Instance child )
Description Fired when a child is removed from the object.
Member of: Instance
DescendantAdded ( Instance descendant )
Description Fired when a descendant is added to the object.
Member of: Instance
DescendantRemoving ( Instance descendant )
Description Fired when a descendant is being removed.
Member of: Instance