Instance

Class fields

Field	XML type	Value
`Name`	string	Instance
`Browsable`	bool	false

Properties

Archivable

bool

Field	XML type	Value
`Name`	string	Archivable
`summary`	string	Determines whether or not an Instance can be saved when the game closes/attempts to save the game. Note: this only applies to games that use Data Persistence, or Personal Build Servers.

AttributesSerialize

BinaryString

Field	XML type	Value
`Name`	string	AttributesSerialize
`Browsable`	bool	false
`summary`	string	Internal serialized custom attribute payload.

DataCost

int

Field	XML type	Value
`Name`	string	DataCost
`Browsable`	bool	false

Name

string

Field	XML type	Value
`Name`	string	Name

Parent

Object

Field	XML type	Value
`Name`	string	Parent
`summary`	string	The Instance that is directly above this Instance in the tree.

RobloxLocked

bool

Field	XML type	Value
`Name`	string	RobloxLocked
`Browsable`	bool	false

Field	XML type	Value
`Name`	string	Tags
`Browsable`	bool	false
`summary`	string	Internal serialized tag payload.

Field	XML type	Value
`Name`	string	archivable

Functions

AddTag

(tag: string) → void

Field	XML type	Value
`Name`	string	AddTag
`summary`	string	Adds a tag to this instance.

ClearAllChildren

() → void

Field	XML type	Value
`Name`	string	ClearAllChildren
`summary`	string	Removes all children (but not this object) from the workspace.

Clone

() → Instance

Field	XML type	Value
`Name`	string	Clone
`summary`	string	Returns a copy of this Object and all its children. The copy's Parent is nil

Destroy

() → void

Field	XML type	Value
`Name`	string	Destroy
`summary`	string	Removes object and all of its children from the workspace. Disconnects object and all children from open connections. Object and children may not be usable after calling Destroy.

FindFirstChild

(name: string, recursive: bool = …) → Instance

Field	XML type	Value
`Name`	string	FindFirstChild
`summary`	string	Returns the first child of this Instance that matches the first argument 'name'. The second argument 'recursive' is an optional boolean (defaults to false) that will force the call to traverse down thru all of this Instance's descendants until it finds an object with a name that matches the 'name' argument. The function will return nil if no Instance is found.

FindFirstChildOfClass

(className: string) → Instance

Field	XML type	Value
`Name`	string	FindFirstChildOfClass

FindFirstChildWhichIsA

(className: string, recursive: bool = …) → Instance

Field	XML type	Value
`Name`	string	FindFirstChildWhichIsA

GetActor

() → Instance

Field	XML type	Value
`Name`	string	GetActor

GetAttribute

(attribute: string) → Variant

Field	XML type	Value
`Name`	string	GetAttribute
`summary`	string	Returns the custom attribute with the given name, or nil.

GetAttributeChangedSignal

(attribute: string) → RBXScriptSignal

Field	XML type	Value
`Name`	string	GetAttributeChangedSignal
`summary`	string	Returns a signal for changes to the named custom attribute.

GetAttributes

() → Dictionary

Field	XML type	Value
`Name`	string	GetAttributes
`summary`	string	Returns a copy of this instance's custom attributes.

GetChildren

() → Objects

Field	XML type	Value
`Name`	string	GetChildren
`summary`	string	Returns a read-only table of this Object's children

GetDebugId

(scopeLength: int = …) → string

Field	XML type	Value
`Name`	string	GetDebugId
`Browsable`	bool	false
`summary`	string	This function is for internal testing. Don't use in production code

GetDescendants

() → Objects

Field	XML type	Value
`Name`	string	GetDescendants
`summary`	string	Returns a read-only table of this Object's descendants

GetFullName

() → string

Field	XML type	Value
`Name`	string	GetFullName
`summary`	string	Returns a string that shows the path from the root node (DataModel) to this Instance. This string does not include the root node (DataModel).

GetTags

() → Array

Field	XML type	Value
`Name`	string	GetTags
`summary`	string	Returns this instance's tags in insertion order.

HasTag

(tag: string) → bool

Field	XML type	Value
`Name`	string	HasTag
`summary`	string	Returns whether this instance has a tag.

IsAncestorOf

(descendant: Instance) → bool

Field	XML type	Value
`Name`	string	IsAncestorOf

IsDescendantOf

(ancestor: Instance) → bool

Field	XML type	Value
`Name`	string	IsDescendantOf

Remove

() → void

Field	XML type	Value
`Name`	string	Remove
`summary`	string	Deprecated. Use ClearAllChildren() to get rid of all child objects, or Destroy() to invalidate this object and its descendants
`Deprecated`	bool	true

RemoveTag

(tag: string) → void

Field	XML type	Value
`Name`	string	RemoveTag
`summary`	string	Removes a tag from this instance.

SetAttribute

(attribute: string, value: Variant) → void

Field	XML type	Value
`Name`	string	SetAttribute
`summary`	string	Sets a custom attribute, or removes it when value is nil.

children

() → Objects

Field	XML type	Value
`Name`	string	children
`Deprecated`	bool	true
`summary`	string	Use GetChildren() instead

clone

() → Instance

Field	XML type	Value
`Name`	string	clone
`Deprecated`	bool	true
`summary`	string	Use Clone() instead

destroy

() → void

Field	XML type	Value
`Name`	string	destroy

findFirstChild

(name: string, recursive: bool = …) → Instance

Field	XML type	Value
`Name`	string	findFirstChild
`Deprecated`	bool	true
`summary`	string	Use FindFirstChild() instead

getChildren

() → Objects

Field	XML type	Value
`Name`	string	getChildren
`Deprecated`	bool	true
`summary`	string	Use GetChildren() instead

isDescendantOf

(ancestor: Instance) → bool

Field	XML type	Value
`Name`	string	isDescendantOf

remove

() → void

Field	XML type	Value
`Name`	string	remove
`Deprecated`	bool	true
`summary`	string	Use Remove() instead

Yield functions

WaitForChild

(childName: string) → Instance

Field	XML type	Value
`Name`	string	WaitForChild

Events

AncestryChanged

(child: Instance, parent: Instance) → void

Field	XML type	Value
`Name`	string	AncestryChanged
`summary`	string	Fired when any of this object's ancestors change. First argument 'child' is the object whose parent changed. Second argument 'parent' is the first argument's new parent.

AttributeChanged

(attribute: string) → void

Field	XML type	Value
`Name`	string	AttributeChanged
`summary`	string	Fired after a custom attribute changes.

ChildAdded

(child: Instance) → void

Field	XML type	Value
`Name`	string	ChildAdded

ChildRemoved

(child: Instance) → void

Field	XML type	Value
`Name`	string	ChildRemoved

DescendantAdded

(descendant: Instance) → void

Field	XML type	Value
`Name`	string	DescendantAdded
`summary`	string	Fired after an Instance is parented to this object, or any of this object's descendants. The 'descendant' argument is the Instance that is being added.

DescendantRemoving

(descendant: Instance) → void

Field	XML type	Value
`Name`	string	DescendantRemoving
`summary`	string	Fired after an Instance is unparented from this object, or any of this object's descendants. The 'descendant' argument is the Instance that is being added.

Destroying

() → void

Field	XML type	Value
`Name`	string	Destroying
`summary`	string	Fires immediately before this Instance or one of its ancestors is destroyed.

childAdded

(child: Instance) → void

Field	XML type	Value
`Name`	string	childAdded