API:Class/Model

< API:Class(Redirected from Model)

Model icon.pngModel : Object Icon.pngPVInstance : Object Icon.pngInstance

Models are container objects, they hold objects and are used for grouping different objects together for organization purposes.

Properties

PropertiesmemberhiddenProperties [toggle]

Ref<BasePart>PrimaryPart

The object's primary part. When used with Models, it is the part which is positioned with MoveTo and SetPrimaryPartCFrame.

|RMD member="API:Class/Model/PrimaryPart"|The object's primary part. When used with Models, it is the part which is positioned with MoveTo and SetPrimaryPartCFrame.|/RMD|
The object's primary part. When used with Models, it is the part which is positioned with MoveTo and SetPrimaryPartCFrame.
Inherited from Object Icon.pngPVInstance:
CFrameCoordinateFrame [deprecated] [unscriptable] [writeonly]

Deprecated. Do not use.

|RMD member="API:Class/PVInstance/CoordinateFrame"|Deprecated. Do not use.|/RMD|
CoordinateFrame [deprecated] [unscriptable] [writeonly]
Deprecated. Do not use.
Inherited from Object Icon.pngInstance:
boolArchivable

Determines if an object can be Clone or saved to file.

|RMD member="API:Class/Instance/Archivable"|Determines if an object can be Clone or saved to file.|/RMD|
stringClassName [readonly]

The unique name of this type of Instance.

|RMD member="API:Class/Instance/ClassName"|The unique name of this type of Instance.|/RMD|
stringName

A non-unique identifier for the object.

|RMD member="API:Class/Instance/Name"|A non-unique identifier for the object.|/RMD|
Ref<Instance>Parent

The hierarchical parent of the object.

|RMD member="API:Class/Instance/Parent"|The hierarchical parent of the object.|/RMD|
intDataCost [RobloxPlaceSecurity] [deprecated] [readonly]

Deprecated. Do not use.

|RMD member="API:Class/Instance/DataCost"|Deprecated. Do not use.|/RMD|
boolRobloxLocked [PluginSecurity]

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.

|RMD member="API:Class/Instance/RobloxLocked"|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.|/RMD|
boolarchivable [deprecated] [hidden]

Deprecated in favor of Archivable.

|RMD member="API:Class/Instance/archivable"|Deprecated in favor of Archivable.|/RMD|
stringclassName [deprecated] [readonly]

Deprecated in favor of ClassName.

|RMD member="API:Class/Instance/className"|Deprecated in favor of ClassName.|/RMD|
Determines if an object can be Clone or saved to file.
ClassName [readonly]
The unique name of this type of Instance.
A non-unique identifier for the object.
The hierarchical parent of the object.
DataCost [RobloxPlaceSecurity] [deprecated] [readonly]
Deprecated. Do not use.
RobloxLocked [PluginSecurity]
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.
archivable [deprecated] [hidden]
Deprecated in favor of Archivable.
className [deprecated] [readonly]
Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

voidBreakJoints ( )

Breaks any surface connection with any adjacent part, including Welds and other JointInstances.

|RMD member="API:Class/Model/BreakJoints"|Breaks any surface connection with any adjacent part, including Welds and other JointInstances.|/RMD|
Vector3GetExtentsSize ( )

Returns the size of the smallest bounding box that contains all of the Parts in the Model.

|RMD member="API:Class/Model/GetExtentsSize"|Returns the size of the smallest bounding box that contains all of the Parts in the Model.|/RMD|
CFrameGetPrimaryPartCFrame ( )

Returns the CFrame of the Model's PrimaryPart.

|RMD member="API:Class/Model/GetPrimaryPartCFrame"|Returns the CFrame of the Model's PrimaryPart.|/RMD|
voidMakeJoints ( )

Goes through all parts contained in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint.

|RMD member="API:Class/Model/MakeJoints"|Goes through all parts contained in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint.|/RMD|
voidMoveTo ( Vector3 position )

Moves the center of the PrimaryPart to the given position.

|RMD member="API:Class/Model/MoveTo"|Moves the center of the PrimaryPart to the given position.|/RMD|
voidSetPrimaryPartCFrame ( CFrame cframe )

Sets the CFrame of the PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the PrimaryPart.

|RMD member="API:Class/Model/SetPrimaryPartCFrame"|Sets the CFrame of the PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the PrimaryPart.|/RMD|
voidTranslateBy ( Vector3 delta )

Shifts a model using a given offset.

|RMD member="API:Class/Model/TranslateBy"|Shifts a model using a given offset.|/RMD|
CFrameGetModelCFrame ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Model/GetModelCFrame"|Deprecated. Do not use.|/RMD|
Vector3GetModelSize ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Model/GetModelSize"|Deprecated. Do not use.|/RMD|
voidResetOrientationToIdentity ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Model/ResetOrientationToIdentity"|Deprecated. Do not use.|/RMD|
voidSetIdentityOrientation ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Model/SetIdentityOrientation"|Deprecated. Do not use.|/RMD|
voidbreakJoints ( ) [deprecated]

Deprecated in favor of BreakJoints.

|RMD member="API:Class/Model/breakJoints"|Deprecated in favor of BreakJoints.|/RMD|
voidmakeJoints ( ) [deprecated]

Deprecated in favor of MakeJoints.

|RMD member="API:Class/Model/makeJoints"|Deprecated in favor of MakeJoints.|/RMD|
voidmove ( Vector3 location ) [deprecated]

Deprecated in favor of MoveTo.

|RMD member="API:Class/Model/move"|Deprecated in favor of MoveTo.|/RMD|
voidmoveTo ( Vector3 location ) [deprecated]

Deprecated in favor of MoveTo.

|RMD member="API:Class/Model/moveTo"|Deprecated in favor of MoveTo.|/RMD|
Breaks any surface connection with any adjacent part, including Welds and other JointInstances.
Returns the size of the smallest bounding box that contains all of the Parts in the Model.
Returns the CFrame of the Model's PrimaryPart.
Goes through all parts contained in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint.
MoveTo ( Vector3 position )
Moves the center of the PrimaryPart to the given position.
Sets the CFrame of the PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the PrimaryPart.
Shifts a model using a given offset.
GetModelCFrame ( ) [deprecated]
Deprecated. Do not use.
GetModelSize ( ) [deprecated]
Deprecated. Do not use.
Deprecated. Do not use.
SetIdentityOrientation ( ) [deprecated]
Deprecated. Do not use.
breakJoints ( ) [deprecated]
Deprecated in favor of BreakJoints.
makeJoints ( ) [deprecated]
Deprecated in favor of MakeJoints.
move ( Vector3 location ) [deprecated]
Deprecated in favor of MoveTo.
moveTo ( Vector3 location ) [deprecated]
Deprecated in favor of MoveTo.
Inherited from Object Icon.pngInstance:
voidClearAllChildren ( )

Removes all descendants of the object.

|RMD member="API:Class/Instance/ClearAllChildren"|Removes all descendants of the object.|/RMD|
Ref<Instance>Clone ( )

Returns a copy of the object, including descendants, but only if the object is Archivable.

|RMD member="API:Class/Instance/Clone"|Returns a copy of the object, including descendants, but only if the object is Archivable.|/RMD|
voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

|RMD member="API:Class/Instance/Destroy"|Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.|/RMD|
Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestor"|Returns the first ancestor whose Name is equal to name, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorOfClass"|Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorWhichIsA"|Returns the first ancestor that inherits the class className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

|RMD member="API:Class/Instance/FindFirstChild"|Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.|/RMD|
Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

|RMD member="API:Class/Instance/FindFirstChildOfClass"|Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.|/RMD|
Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstChildWhichIsA"|Returns the first child that inherits the class className, or nil if none can be found.|/RMD|
array<Instance>GetChildren ( )

Returns an array of the object's children.

|RMD member="API:Class/Instance/GetChildren"|Returns an array of the object's children.|/RMD|
array<Instance>GetDescendants ( )

Returns an array containing all of the descendants of the instance.

|RMD member="API:Class/Instance/GetDescendants"|Returns an array containing all of the descendants of the instance.|/RMD|
stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

|RMD member="API:Class/Instance/GetFullName"|Returns a string which shows the object's ancestry chain.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

|RMD member="API:Class/Instance/IsA"|Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.|/RMD|
boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

|RMD member="API:Class/Instance/IsAncestorOf"|Returns true if the object is an ancestor of the given descendant.|/RMD|
boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

|RMD member="API:Class/Instance/IsDescendantOf"|Returns true if the object is a descendant of the given ancestor.|/RMD|
Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

|RMD member="API:Class/Instance/WaitForChild"|Yields the current thread until a child with the given name is found, then returns the child.

If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.|/RMD|

stringGetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]

Returns a coded string of the object's DebugId used internally by Roblox.

|RMD member="API:Class/Instance/GetDebugId"|Returns a coded string of the object's DebugId used internally by Roblox.|/RMD|
voidRemove ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Instance/Remove"|Deprecated. Do not use.|/RMD|
array<Instance>children ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/children"|Deprecated in favor of GetChildren.|/RMD|
Instanceclone ( ) [deprecated]

Deprecated in favor of Clone.

|RMD member="API:Class/Instance/clone"|Deprecated in favor of Clone.|/RMD|
voiddestroy ( ) [deprecated]

Deprecated in favor of Destroy.

|RMD member="API:Class/Instance/destroy"|Deprecated in favor of Destroy.|/RMD|
InstancefindFirstChild ( string name, bool recursive = false ) [deprecated]

Deprecated in favor of FindFirstChild.

|RMD member="API:Class/Instance/findFirstChild"|Deprecated in favor of FindFirstChild.|/RMD|
array<Instance>getChildren ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/getChildren"|Deprecated in favor of GetChildren.|/RMD|
boolisA ( string className ) [deprecated]

Deprecated in favor of IsA.

|RMD member="API:Class/Instance/isA"|Deprecated in favor of IsA.|/RMD|
boolisDescendantOf ( Instance ancestor ) [deprecated]

Deprecated in favor of IsDescendantOf.

|RMD member="API:Class/Instance/isDescendantOf"|Deprecated in favor of IsDescendantOf.|/RMD|
voidremove ( ) [deprecated]

Deprecated in favor of Remove.

|RMD member="API:Class/Instance/remove"|Deprecated in favor of Remove.|/RMD|
Removes all descendants of the object.
Clone ( )
Returns a copy of the object, including descendants, but only if the object is Archivable.
Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Returns the first ancestor that inherits the class className, or nil if none can be found.
FindFirstChild ( string name, bool recursive = false )
Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
FindFirstChildWhichIsA ( string className, bool recursive = false )
Returns the first child that inherits the class className, or nil if none can be found.
Returns an array of the object's children.
Returns an array containing all of the descendants of the instance.
Returns a string which shows the object's ancestry chain.
Returns a signal that is fired when the specified property is changed on this object.
IsA ( string className )
Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
IsAncestorOf ( Instance descendant )
Returns true if the object is an ancestor of the given descendant.
Returns true if the object is a descendant of the given ancestor.
WaitForChild ( string childName, double timeOut )
Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]
Returns a coded string of the object's DebugId used internally by Roblox.
Remove ( ) [deprecated]
Deprecated. Do not use.
children ( ) [deprecated]
Deprecated in favor of GetChildren.
clone ( ) [deprecated]
Deprecated in favor of Clone.
destroy ( ) [deprecated]
Deprecated in favor of Destroy.
findFirstChild ( string name, bool recursive = false ) [deprecated]
Deprecated in favor of FindFirstChild.
getChildren ( ) [deprecated]
Deprecated in favor of GetChildren.
isA ( string className ) [deprecated]
Deprecated in favor of IsA.
isDescendantOf ( Instance ancestor ) [deprecated]
Deprecated in favor of IsDescendantOf.
remove ( ) [deprecated]
Deprecated in favor of Remove.


Events

EventsmemberhiddenEvents [toggle]

Inherited from Object Icon.pngInstance:
AncestryChanged ( Instance child, Instance parent )

Fires when the Parent property of the object or one of its ancestors is changed.

|RMD member="API:Class/Instance/AncestryChanged"|Fires when the Parent property of the object or one of its ancestors is changed.|/RMD|
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
ChildAdded ( Instance child )

Fires when a child is added to the object.

|RMD member="API:Class/Instance/ChildAdded"|Fires when a child is added to the object.|/RMD|
ChildRemoved ( Instance child )

Fires when a child is removed from the object.

|RMD member="API:Class/Instance/ChildRemoved"|Fires when a child is removed from the object.|/RMD|
DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

|RMD member="API:Class/Instance/DescendantAdded"|Fires when a descendant is added to the object.|/RMD|
DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

|RMD member="API:Class/Instance/DescendantRemoving"|Fires before a descendant of the object is removed.|/RMD|
childAdded ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

|RMD member="API:Class/Instance/childAdded"|Deprecated in favor of ChildAdded.|/RMD|
Fires when the Parent property of the object or one of its ancestors is changed.
Changed ( string property )
Fires after a property of the object changes.
Fires when a child is added to the object.
Fires when a child is removed from the object.
DescendantAdded ( Instance descendant )
Fires when a descendant is added to the object.
Fires before a descendant of the object is removed.
childAdded ( Instance child ) [deprecated]
Deprecated in favor of ChildAdded.

Inherited Classes

Workspace icon.pngWorkspace
|RMD member="API:Class/Model"|Models are container objects, they hold objects and are used for grouping different objects together for organization purposes. |/RMD|


Notes

  • When a Humanoid and a Part (named "Head") are parented under a model, a name-tag GUI will appear with the name of the model.
  • Models allow for you to move a large amount of parts at the same time, which is useful for builders.
  • If a part hits the FallenPartsDestroyHeight, and it was the last object inside of a Model, the Model will be destroyed as well.