Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Instance

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is not browsable. It is not visible in Studio's object browser.
Memory categoryInstances
Tags: [NotCreatable, NotBrowsable]

Member index 68

HistoryMember
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

History 218

Members 68

AddTag

Parameters (1)
tagstring
Returns (1)
null
Thread safetyUnsafe

History 1

AncestryChanged

Parameters (2)
childInstance
parentInstance
Thread safetyUnsafe

History 2

Archivable

TypeDefault
bool
Thread safetyReadSafe
CategoryBehavior
Loaded/Savedfalse

History 4

AttributeChanged

Parameters (1)
attributestring
Thread safetyUnsafe

History 2

Capabilities

TypeDefault
SecurityCapabilities
SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryPermissions
Loaded/Savedtrue

History 6

Changed

Parameters (1)
propertystring
Thread safetyUnsafe

History 2

ChildAdded

Parameters (1)
childInstance
Thread safetyUnsafe

History 2

ChildRemoved

Parameters (1)
childInstance
Thread safetyUnsafe

History 2

ClassName

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 4

Tags: [ReadOnly, NotReplicated]

ClearAllChildren

Parameters (0)
No parameters.
Returns (1)
null
Thread safetyUnsafe

History 3

Clone

Parameters (0)
No parameters.
Returns (1)
Instance
Thread safetyUnsafe

History 2

DescendantAdded

Parameters (1)
descendantInstance
Thread safetyUnsafe

History 2

DescendantRemoving

Parameters (1)
descendantInstance
Thread safetyUnsafe

History 2

Destroy

Parameters (0)
No parameters.
Returns (1)
null
Thread safetyUnsafe

History 3

Destroying

Parameters (0)
No parameters.
Thread safetyUnsafe

History 1

FindFirstAncestor

Parameters (1)
namestring
Returns (1)
Instance
Thread safetySafe

History 6

FindFirstAncestorOfClass

Parameters (1)
classNamestring
Returns (1)
Instance
Thread safetySafe

History 3

FindFirstAncestorWhichIsA

Parameters (1)
classNamestring
Returns (1)
Instance
Thread safetySafe

History 3

FindFirstChild

Parameters (2)Default
namestring
recursiveboolfalse
Returns (1)
Instance
Thread safetySafe

History 3

FindFirstChildOfClass

Parameters (1)
classNamestring
Returns (1)
Instance
Thread safetySafe

History 3

FindFirstChildWhichIsA

Parameters (2)Default
classNamestring
recursiveboolfalse
Returns (1)
Instance
Thread safetySafe

History 3

FindFirstDescendant

Parameters (1)
namestring
Returns (1)
Instance
Thread safetySafe

History 2

GetActor

Parameters (0)
No parameters.
Returns (1)
Actor
Thread safetySafe

History 4

GetAttribute

Parameters (1)
attributestring
Returns (1)
Variant
Thread safetySafe

History 3

GetAttributeChangedSignal

Parameters (1)
attributestring
Returns (1)
RBXScriptSignal
Thread safetyUnsafe

History 2

GetAttributes

Parameters (0)
No parameters.
Returns (1)
Dictionary
This function has a custom internal state. It may behave in a non-standard way.
Thread safetySafe

History 4

Tags: [CustomLuaState]

GetChildren

Parameters (0)
No parameters.
Returns (1)
Objects
Thread safetySafe

History 3

GetDebugId

Parameters (1)Default
scopeLengthint4
Returns (1)
string
This function is not browsable. It is not visible in Studio's object browser.
SecurityPluginSecurity
Thread safetyUnsafe

History 3

Tags: [NotBrowsable]

GetDescendants

Parameters (0)
No parameters.
Returns (1)
Array
This function has a custom internal state. It may behave in a non-standard way.
Thread safetySafe

History 4

Tags: [CustomLuaState]

GetFullName

Parameters (0)
No parameters.
Returns (1)
string
Thread safetySafe

History 3

GetPropertyChangedSignal

Parameters (1)
propertystring
Returns (1)
RBXScriptSignal
Thread safetyUnsafe

History 6

GetTags

Parameters (0)
No parameters.
Returns (1)
Array
Thread safetySafe

History 1

HasTag

Parameters (1)
tagstring
Returns (1)
bool
Thread safetySafe

History 1

IsA

Parameters (1)
classNamestring
Returns (1)
bool
This function has a custom internal state. It may behave in a non-standard way.
Thread safetySafe

History 4

  • 486 Change ThreadSafety of IsA from ReadOnly to Safe
  • 462 Change ThreadSafety of IsA from to ReadOnly
  • 384 Change Tags of IsA from [] to [CustomLuaState]
  • 47 Add IsA
Tags: [CustomLuaState]

IsAncestorOf

Parameters (1)
descendantInstance
Returns (1)
bool
Thread safetySafe

History 3

IsDescendantOf

Parameters (1)
ancestorInstance
Returns (1)
bool
Thread safetySafe

History 3

IsPropertyModified

Parameters (1)
namestring
Returns (1)
bool
Thread safetyUnsafe

History 1

Name

TypeDefault
string
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

  • 553 Change Default of Name from to
  • 486 Change ThreadSafety of Name from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Name from to ReadOnly
  • 47 Add Name

Parent

TypeDefault
Instance
This property is not replicated. Its interface does not cross the network boundary.
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue/false

History 5

Tags: [NotReplicated]

Remove

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

RemoveTag

Parameters (1)
tagstring
Returns (1)
null
Thread safetyUnsafe

History 1

ResetPropertyToDefault

Parameters (1)
namestring
Returns (1)
null
Thread safetyUnsafe

History 1

Sandboxed

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.
SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryPermissions
Loaded/Savedfalse

History 4

  • 635 Change ReadSecurity of Sandboxed from RobloxSecurity to RobloxScriptSecurity
  • 635 Change Tags of Sandboxed from [NotReplicated, NotScriptable] to [NotReplicated]
  • 635 Change WriteSecurity of Sandboxed from RobloxSecurity to RobloxScriptSecurity
  • 619 Add Sandboxed
Tags: [NotReplicated]

SetAttribute

Parameters (2)
attributestring
valueVariant
Returns (1)
null
Thread safetyUnsafe

History 3

UniqueId

TypeDefault
UniqueId
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
SecurityRobloxSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

  • 616 Change Tags of UniqueId from [Hidden, NotReplicated, NotScriptable] to [NotReplicated, NotScriptable]
  • 553 Add UniqueId
Tags: [NotReplicated, NotScriptable]

WaitForChild

Parameters (2)
childNamestring
timeOutdouble
Returns (1)
Instance
This function can yield. It may or may not block the calling thread until completion.
This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 9

Tags: [CustomLuaState, CanYield]

childAdded

Parameters (1)
childInstance
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. ChildAdded should be used instead.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

children

Parameters (0)
No parameters.
Returns (1)
Objects
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetChildren should be used instead.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

className

TypeDefault
string
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. ClassName should be used instead.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 6

Tags: [ReadOnly, NotReplicated, Deprecated]

clone

Parameters (0)
No parameters.
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Clone should be used instead.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

destroy

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Destroy should be used instead.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

findFirstChild

Parameters (2)Default
namestring
recursiveboolfalse
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. FindFirstChild should be used instead.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

getChildren

Parameters (0)
No parameters.
Returns (1)
Objects
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetChildren should be used instead.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

isA

Parameters (1)
classNamestring
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 3

  • 462 Change ThreadSafety of isA from to Unsafe
  • 384 Change Tags of isA from [Deprecated] to [Deprecated, CustomLuaState]
  • 47 Add isA
Tags: [Deprecated, CustomLuaState]

isDescendantOf

Parameters (1)
ancestorInstance
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. IsDescendantOf should be used instead.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

remove

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Remove should be used instead.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

Settings