Model

Groups parts and other instances so they can be moved, scaled, and queried together.

Functions

`instance:SetPrimaryPart`

Sets the part used as this model's primary reference part.

`instance:GetPrimaryPartCFrame`

Returns the PrimaryPart CFrame, or the WorldPivot when no PrimaryPart is set.

`instance:GetPivot`

Returns the model's world pivot CFrame.

`instance:SetPivot`

Sets the model pivot and moves child parts by the same transform offset.

`instance:PivotTo`

Moves the model to a new pivot CFrame.

`instance:MoveTo`

Moves the model pivot to a world position while preserving its orientation.

`instance:TranslateBy`

Offsets the model pivot and child parts by a world-space vector.

`instance:RotateBy`

Rotates the model around its current world pivot.

`instance:ScaleTo`

Scales BasePart descendants around the model pivot.

`instance:ScaleByFactor`

Scales sized descendants around the model pivot.

`instance:GetExtentsSize`

Returns the axis-aligned bounding size of all child parts.

`instance:GetBoundingBox`

Returns the model pivot and bounding size for all child parts.

`instance:GetCenter`

Returns the center point between child part positions.

`instance:GetAllParts`

Returns all descendant parts with Size and CFrame properties.

`recurse`

Returns all descendant parts with Size and CFrame properties.

`instance:IsEmpty`

Returns whether the model has no direct children.

`instance:SetVisible`

Sets descendant part transparency to visible or hidden.

`instance:SetTransparency`

Sets transparency on every descendant part.

`instance:SetPrimaryPart`

Sets the part used as this model's primary reference part.

Arguments

part: any

Returns

This function returns nothing.

`instance:GetPrimaryPartCFrame`

Returns the PrimaryPart CFrame, or the WorldPivot when no PrimaryPart is set.

Arguments

This function takes no arguments.

Returns

CFrame

`instance:GetPivot`

Returns the model's world pivot CFrame.

Arguments

This function takes no arguments.

Returns

CFrame

`instance:SetPivot`

Sets the model pivot and moves child parts by the same transform offset.

Arguments

cf: CFrame

Returns

This function returns nothing.

`instance:PivotTo`

Moves the model to a new pivot CFrame.

Arguments

cf: CFrame

Returns

This function returns nothing.

`instance:MoveTo`

Moves the model pivot to a world position while preserving its orientation.

Arguments

pos: Vector3

Returns

This function returns nothing.

`instance:TranslateBy`

Offsets the model pivot and child parts by a world-space vector.

Arguments

offset: Vector3

Returns

This function returns nothing.

`instance:RotateBy`

Rotates the model around its current world pivot.

Arguments

rotCF: CFrame

Returns

This function returns nothing.

`instance:ScaleTo`

Scales BasePart descendants around the model pivot.

Arguments

factor: number

Returns

This function returns nothing.

`instance:ScaleByFactor`

Scales sized descendants around the model pivot.

Arguments

factor: number

Returns

This function returns nothing.

`instance:GetExtentsSize`

Returns the axis-aligned bounding size of all child parts.

Arguments

This function takes no arguments.

Returns

Vector3

`instance:GetBoundingBox`

Returns the model pivot and bounding size for all child parts.

Arguments

This function takes no arguments.

Returns

CFrame, Vector3

`instance:GetCenter`

Returns the center point between child part positions.

Arguments

This function takes no arguments.

Returns

Vector3

`instance:GetAllParts`

Returns all descendant parts with Size and CFrame properties.

Arguments

This function takes no arguments.

Returns

{ any }

`recurse`

Returns all descendant parts with Size and CFrame properties.

Arguments

parent

Returns

{ any }

`instance:IsEmpty`

Returns whether the model has no direct children.

Arguments

This function takes no arguments.

Returns

boolean

`instance:SetVisible`

Sets descendant part transparency to visible or hidden.

Arguments

visible: boolean

Returns

This function returns nothing.

`instance:SetTransparency`

Sets transparency on every descendant part.

Arguments

t: number

Returns

This function returns nothing.

API

instance:SetPrimaryPart(part: any)
instance:GetPrimaryPartCFrame(): CFrame
instance:GetPivot(): CFrame
instance:SetPivot(cf: CFrame)
instance:PivotTo(cf: CFrame)
instance:MoveTo(pos: Vector3)
instance:TranslateBy(offset: Vector3)
instance:RotateBy(rotCF: CFrame)
instance:ScaleTo(factor: number)
instance:ScaleByFactor(factor: number)
instance:GetExtentsSize(): Vector3
instance:GetBoundingBox(): CFrame, Vector3
instance:GetCenter(): Vector3
instance:GetAllParts(): { any }
instance:recurse(parent): { any }
instance:IsEmpty(): boolean
instance:SetVisible(visible: boolean)
instance:SetTransparency(t: number)

Instances

All available instance classes in Kinemium Engine.

Accessory

A customizable mesh you can place on a character.