|
|
| (17 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| {{CatUp|Class reference}} | | {{redirect|Instance|Instance (Table)|the table}} |
| __NOTOC__
| | {{Uncreatable}} |
|
| |
|
| <div class="tabber">
| | {{ObjectPage|name=Instance|Base class for all objects in game hierarchy. You cannot directly create {{type|instance=Instance|Instances}}, instead you use these on any game object.}} |
| <div class="tabbertab" title="Info" style="padding: 5px 0px">{{:Object:Instance|float:right; margin-left:5px}}{{EmphasisBox|margin-top: 0}}Base class for all objects in Game hierarchy. Also called Global methods, properties, and events. You cannot directly create Instances, instead you use these on any Game object.
| |
| </div>
| |
| </div>
| |
| <div class="tabbertab" title="Methods">
| |
| {{:Object:Instance/methods}}
| |
| </div>
| |
| <div class="tabbertab" title="Properties">
| |
| {{:Object:Instance/properties}}
| |
| </div>
| |
| <div class="tabbertab" title="Events">
| |
| {{:Object:Instance/events}}
| |
| </div>
| |
| </div>
| |
| | |
| [[Category:ROBLOX Lua Objects]]
| |
Uncreatable:This object cannot be created with the Instance.new function.
Base class for all objects in game hierarchy. You cannot directly create
Instances, instead you use these on any game object.
 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
|
| 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
|
| 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
|
 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
|
Clone( )
GetDebugId( int scopeLength )
RobloxLocked
AncestryChanged ( Instance child, Instance parent )
