Class Instance

Constructors

constructor

new Instance(className: string, notComplete?: boolean): Instance
Parameters
- className: string
- notComplete: boolean = false
Returns Instance
- Defined in rblx/rbx.ts:758

Properties

`Optional`_name

_name?: string

Deprecated

Use .Prop("Name") instead

_properties

_properties: Map<string, Property> = ...

Deprecated

Do not use this directly

AncestryChanged

AncestryChanged: Event = ...

Changed

Changed: Event = ...

ChildAdded

ChildAdded: Event = ...

ChildRemoved

ChildRemoved: Event = ...

`Optional`classID

classID?: number

className

className: string

destroyed

destroyed: boolean = false

Destroying

Destroying: Event = ...

`Optional`objectFormat

objectFormat?: number

`Optional`parent

parent?: Instance = undefined

referencedByChanged

referencedByChanged: Event = ...

wrapperInitialized

wrapperInitialized: boolean = false

Accessors

id

get id(): string
Returns string
- Defined in rblx/rbx.ts:777

name

get name(): string
Returns string
- Defined in rblx/rbx.ts:785
set name(value: string): void
Parameters
- value: string
Returns void
- Defined in rblx/rbx.ts:781

Parent

get Parent(): Instance | undefined
Returns Instance | undefined
- Defined in rblx/rbx.ts:789

w

get w(): InstanceWrapper | undefined
Returns InstanceWrapper | undefined
- Defined in rblx/rbx.ts:803

Methods

addConnectionReference

addConnectionReference(connection: Connection): void
Parameters
- connection: Connection
Returns void
- Defined in rblx/rbx.ts:807

addProperty

addProperty(property: Property, value?: unknown): void
Parameters
- property: Property
- Optionalvalue: unknown
Returns void
- Defined in rblx/rbx.ts:849

addReferencedBy

addReferencedBy(instance: Instance): void
Parameters
- instance: Instance
Returns void
- Defined in rblx/rbx.ts:820

Child

Child(name: string): Instance | undefined
Parameters
- name: string
Returns Instance | undefined
- Defined in rblx/rbx.ts:1177

createWrapper

createWrapper(): InstanceWrapper | undefined
Returns InstanceWrapper | undefined
- Defined in rblx/rbx.ts:793

Destroy

Destroy(): void
Returns void
- Defined in rblx/rbx.ts:1079

FindFirstChild

FindFirstChild(name: string): Instance | undefined
Parameters
- name: string
Returns Instance | undefined
- Defined in rblx/rbx.ts:1161

FindFirstChildOfClass

FindFirstChildOfClass(className: string): Instance | undefined
Parameters
- className: string
Returns Instance | undefined
- Defined in rblx/rbx.ts:1181

FindFirstDescendant

FindFirstDescendant(name: string): Instance | undefined
Parameters
- name: string
Returns Instance | undefined
- Defined in rblx/rbx.ts:1169

FindLastChildOfClass

FindLastChildOfClass(className: string): Instance | undefined
Parameters
- className: string
Returns Instance | undefined
- Defined in rblx/rbx.ts:1189

fixPropertyName

fixPropertyName(name: string): string
Parameters
- name: string
Returns string
- Defined in rblx/rbx.ts:864

GetChildren

GetChildren(): Instance[]
Returns Instance[]
- Defined in rblx/rbx.ts:1141

GetDescendants

GetDescendants(): Instance[]
Returns Instance[]
- Defined in rblx/rbx.ts:1151

GetFullName

GetFullName(): string
Returns string
- Defined in rblx/rbx.ts:1133

getPropertyNames

getPropertyNames(): string[]
Returns string[]
- Defined in rblx/rbx.ts:1034

getReferencedBy

getReferencedBy(): Instance[]
Returns Instance[]
- Defined in rblx/rbx.ts:845

HasProperty

HasProperty(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in rblx/rbx.ts:944

IsA

IsA(className: string): boolean
Parameters
- className: string
Returns boolean
- Defined in rblx/rbx.ts:1201

IsDescendantOf

IsDescendantOf(instance: Instance): boolean
Parameters
- instance: Instance
Returns boolean
- Defined in rblx/rbx.ts:1210

preRender

preRender(): void
Returns void
- Defined in rblx/rbx.ts:1223

Prop

Prop(name: string): unknown
Returns the value of a property
Parameters
- name: string
  Name of property
Returns unknown
Property's value

Throws
When property doesn't exist, PropOrDefault is a safer alternative
- Defined in rblx/rbx.ts:1022

Property

Property(name: string): unknown
Returns the value of a property
Parameters
- name: string
  Name of property
Returns unknown
Property's value

Throws
When property doesn't exist, PropOrDefault is a safer alternative
- Defined in rblx/rbx.ts:957

PropertyType

PropertyType(name: string): number | undefined
Parameters
- name: string
Returns number | undefined
- Defined in rblx/rbx.ts:1030

PropOrDefault

PropOrDefault(name: string, def: unknown): unknown
Parameters
- name: string
- def: unknown
Returns unknown
- Defined in rblx/rbx.ts:1026

removeConnectionReference

removeConnectionReference(connection: Connection): void
Parameters
- connection: Connection
Returns void
- Defined in rblx/rbx.ts:813

removeReferencedBy

removeReferencedBy(instance: Instance): void
Parameters
- instance: Instance
Returns void
- Defined in rblx/rbx.ts:828

setParent

setParent(instance: Instance | null | undefined, fireEvents?: boolean): void
Parameters
- instance: Instance | null | undefined
- fireEvents: boolean = true
Returns void
- Defined in rblx/rbx.ts:1038

setProperty

setProperty(name: string, value: unknown, supressEvents?: boolean): void
Parameters
- name: string
- value: unknown
- supressEvents: boolean = false
Returns void
- Defined in rblx/rbx.ts:891