ModelPart

docs.modelpart

ModelPart.getParent

docs.modelpart.getparent

overload 1:
                        
models:getParent()  
 Method Property Fluent Description Representation
Return Value either a ModelPart or nil ModelPart | nil

Method Property	Fluent Description	Representation
Return Value	either a ModelPart or nil	`ModelPart \| nil`

ModelPart.getType

docs.modelpart.gettype

overload 1:
                        
models:getType()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ModelPart.getChildren

docs.modelpart.getchildren

overload 1:
                        
models:getChildren()  
 Method Property Fluent Description Representation
Return Value an array of ModelParts ModelPart[]

Method Property	Fluent Description	Representation
Return Value	an array of ModelParts	`ModelPart[]`

ModelPart.setColor

docs.modelpart.setcolor

overload 1:
                        
models:setColor(color)  
 Method Property Fluent Description Representation
color accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
models:setColor(r, g, b)  
 Method Property Fluent Description Representation
r accepts a Number Number 
   
g accepts a Number Number 
   
b accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
color accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
r accepts	a Number	`Number`
g accepts	a Number	`Number`
b accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.setScale

docs.modelpart.setscale

overload 1:
                        
models:setScale(scale)  
 Method Property Fluent Description Representation
scale accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
models:setScale(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
scale accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.getTask

docs.modelpart.gettask

overload 1:
                        
models:getTask(taskName)  
 Method Property Fluent Description Representation
taskName accepts a String String 
   
Return Value a table mapping a String to a RenderTask Table<String, RenderTask>

Method Property	Fluent Description	Representation
taskName accepts	a String	`String`
Return Value	a table mapping a String to a RenderTask	`Table<String, RenderTask>`

ModelPart.addItem

docs.modelpart.additem

overload 1:
                        
models:addItem(taskName)  
 Method Property Fluent Description Representation
taskName accepts a String String 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
taskName accepts	a String	`String`
Return Value	a RenderTask	`RenderTask`

ModelPart.getVisible

docs.modelpart.getvisible

overload 1:
                        
models:getVisible()  
 Method Property Fluent Description Representation
Return Value either a Boolean or nil Boolean | nil

Method Property	Fluent Description	Representation
Return Value	either a Boolean or nil	`Boolean \| nil`

ModelPart.setVisible

docs.modelpart.setvisible

overload 1:
                        
models:setVisible(visible)  
 Method Property Fluent Description Representation
visible accepts a Boolean Boolean 
   
Return Value nil nil

Method Property	Fluent Description	Representation
visible accepts	a Boolean	`Boolean`
Return Value	nil	`nil`

ModelPart.setPos

docs.modelpart.setpos

overload 1:
                        
models:setPos(pos)  
 Method Property Fluent Description Representation
pos accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
models:setPos(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
pos accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.getScale

docs.modelpart.getscale

overload 1:
                        
models:getScale()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.getPos

docs.modelpart.getpos

overload 1:
                        
models:getPos()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.getOpacity

docs.modelpart.getopacity

overload 1:
                        
models:getOpacity()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

ModelPart.offsetPivot

docs.modelpart.offsetpivot

overload 1:
                        
models:offsetPivot(offsetPivot)  
 Method Property Fluent Description Representation
offsetPivot accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
models:offsetPivot(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
offsetPivot accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.getAnimRot

docs.modelpart.getanimrot

overload 1:
                        
models:getAnimRot()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.getAnimScale

docs.modelpart.getanimscale

overload 1:
                        
models:getAnimScale()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.offsetRot

docs.modelpart.offsetrot

overload 1:
                        
models:offsetRot(offsetRot)  
 Method Property Fluent Description Representation
offsetRot accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
models:offsetRot(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
offsetRot accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.getAnimPos

docs.modelpart.getanimpos

overload 1:
                        
models:getAnimPos()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.getNormalMatrix

docs.modelpart.getnormalmatrix

overload 1:
                        
models:getNormalMatrix()  
 Method Property Fluent Description Representation
Return Value a Matrix3 Matrix3

Method Property	Fluent Description	Representation
Return Value	a Matrix3	`Matrix3`

ModelPart.setPivot

docs.modelpart.setpivot

overload 1:
                        
models:setPivot(pivot)  
 Method Property Fluent Description Representation
pivot accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
models:setPivot(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
pivot accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.getOffsetRot

docs.modelpart.getoffsetrot

overload 1:
                        
models:getOffsetRot()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.getPivot

docs.modelpart.getpivot

overload 1:
                        
models:getPivot()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.getOffsetPivot

docs.modelpart.getoffsetpivot

overload 1:
                        
models:getOffsetPivot()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.setRot

docs.modelpart.setrot

overload 1:
                        
models:setRot(rot)  
 Method Property Fluent Description Representation
rot accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
models:setRot(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
rot accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.getNormalMatrixRaw

docs.modelpart.getnormalmatrixraw

overload 1:
                        
models:getNormalMatrixRaw()  
 Method Property Fluent Description Representation
Return Value a Matrix3 Matrix3

Method Property	Fluent Description	Representation
Return Value	a Matrix3	`Matrix3`

ModelPart.getPositionMatrix

docs.modelpart.getpositionmatrix

overload 1:
                        
models:getPositionMatrix()  
 Method Property Fluent Description Representation
Return Value a Matrix4 Matrix4

Method Property	Fluent Description	Representation
Return Value	a Matrix4	`Matrix4`

ModelPart.getRot

docs.modelpart.getrot

overload 1:
                        
models:getRot()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ModelPart.setMatrix

docs.modelpart.setmatrix

overload 1:
                        
models:setMatrix(matrix)  
 Method Property Fluent Description Representation
matrix accepts a Matrix4 Matrix4 
   
Return Value nil nil

Method Property	Fluent Description	Representation
matrix accepts	a Matrix4	`Matrix4`
Return Value	nil	`nil`

ModelPart.resetVisible

docs.modelpart.resetvisible

overload 1:
                        
models:resetVisible()  
 Method Property Fluent Description Representation
Return Value nil nil

Method Property	Fluent Description	Representation
Return Value	nil	`nil`

ModelPart.getTextureSize

docs.modelpart.gettexturesize

overload 1:
                        
models:getTextureSize()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2

Method Property	Fluent Description	Representation
Return Value	a Vector2	`Vector2`

ModelPart.setUVMatrix

docs.modelpart.setuvmatrix

overload 1:
                        
models:setUVMatrix(matrix)  
 Method Property Fluent Description Representation
matrix accepts a Matrix3 Matrix3 
   
Return Value nil nil

Method Property	Fluent Description	Representation
matrix accepts	a Matrix3	`Matrix3`
Return Value	nil	`nil`

ModelPart.setPrimaryTexture

docs.modelpart.setprimarytexture

overload 1:
                        
models:setPrimaryTexture(textureType)  
 Method Property Fluent Description Representation
textureType accepts a String String 
   
Return Value nil nil 
   
overload 2:
                        
models:setPrimaryTexture(resource, path)  
 Method Property Fluent Description Representation
resource accepts a String String 
   
path accepts a String String 
   
Return Value nil nil

Method Property	Fluent Description	Representation
textureType accepts	a String	`String`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
resource accepts	a String	`String`
path accepts	a String	`String`
Return Value	nil	`nil`

ModelPart.partToWorldMatrix

docs.modelpart.parttoworldmatrix

overload 1:
                        
models:partToWorldMatrix()  
 Method Property Fluent Description Representation
Return Value a Matrix4 Matrix4

Method Property	Fluent Description	Representation
Return Value	a Matrix4	`Matrix4`

ModelPart.setUVPixels

docs.modelpart.setuvpixels

overload 1:
                        
models:setUVPixels(uv)  
 Method Property Fluent Description Representation
uv accepts a Vector2 Vector2 
   
Return Value nil nil 
   
overload 2:
                        
models:setUVPixels(u, v)  
 Method Property Fluent Description Representation
u accepts a Number Number 
   
v accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
uv accepts	a Vector2	`Vector2`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
u accepts	a Number	`Number`
v accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.setOpacity

docs.modelpart.setopacity

overload 1:
                        
models:setOpacity(opacity)  
 Method Property Fluent Description Representation
opacity accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
opacity accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.setUV

docs.modelpart.setuv

overload 1:
                        
models:setUV(uv)  
 Method Property Fluent Description Representation
uv accepts a Vector2 Vector2 
   
Return Value nil nil 
   
overload 2:
                        
models:setUV(u, v)  
 Method Property Fluent Description Representation
u accepts a Number Number 
   
v accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
uv accepts	a Vector2	`Vector2`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
u accepts	a Number	`Number`
v accepts	a Number	`Number`
Return Value	nil	`nil`

ModelPart.addText

docs.modelpart.addtext

overload 1:
                        
models:addText(taskName)  
 Method Property Fluent Description Representation
taskName accepts a String String 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
taskName accepts	a String	`String`
Return Value	a RenderTask	`RenderTask`

ModelPart.addBlock

docs.modelpart.addblock

overload 1:
                        
models:addBlock(taskName)  
 Method Property Fluent Description Representation
taskName accepts a String String 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
taskName accepts	a String	`String`
Return Value	a RenderTask	`RenderTask`

ModelPart.setLight

docs.modelpart.setlight

overload 1:
                        
models:setLight(light)  
 Method Property Fluent Description Representation
light accepts a Vector2 Vector2 
   
Return Value nil nil 
   
overload 2:
                        
models:setLight(blockLight, skyLight)  
 Method Property Fluent Description Representation
blockLight accepts an Integer Integer 
   
skyLight accepts an Integer Integer 
   
Return Value nil nil

Method Property	Fluent Description	Representation
light accepts	a Vector2	`Vector2`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
blockLight accepts	an Integer	`Integer`
skyLight accepts	an Integer	`Integer`
Return Value	nil	`nil`

ModelPart.getLight

docs.modelpart.getlight

overload 1:
                        
models:getLight()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2

ModelPart.setParentType

docs.modelpart.setparenttype

overload 1:
                        
models:setParentType(parentType)  
 Method Property Fluent Description Representation
parentType accepts a String String 
   
Return Value nil nil

ModelPart.getParentType

docs.modelpart.getparenttype

overload 1:
                        
models:getParentType()  
 Method Property Fluent Description Representation
Return Value a String String

ModelPart.removeTask

docs.modelpart.removetask

overload 1:
                        
models:removeTask(taskName)  
 Method Property Fluent Description Representation
taskName accepts a String String 
   
Return Value nil nil

ModelPart.getColor

docs.modelpart.getcolor

overload 1:
                        
models:getColor()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

ModelPart.getPositionMatrixRaw

docs.modelpart.getpositionmatrixraw

overload 1:
                        
models:getPositionMatrixRaw()  
 Method Property Fluent Description Representation
Return Value a Matrix4 Matrix4

ModelPart.getSecondaryRenderType

docs.modelpart.getsecondaryrendertype

overload 1:
                        
models:getSecondaryRenderType()  
 Method Property Fluent Description Representation
Return Value either a RenderTypes or nil RenderTypes | nil

ModelPart.getPrimaryRenderType

docs.modelpart.getprimaryrendertype

overload 1:
                        
models:getPrimaryRenderType()  
 Method Property Fluent Description Representation
Return Value either a RenderTypes or nil RenderTypes | nil

ModelPart.setSecondaryRenderType

docs.modelpart.setsecondaryrendertype

overload 1:
                        
models:setSecondaryRenderType(renderType)  
 Method Property Fluent Description Representation
renderType accepts a String String 
   
Return Value nil nil

ModelPart.setPrimaryRenderType

docs.modelpart.setprimaryrendertype

overload 1:
                        
models:setPrimaryRenderType(renderType)  
 Method Property Fluent Description Representation
renderType accepts a String String 
   
Return Value nil nil

ModelPart.setSecondaryTexture

docs.modelpart.setsecondarytexture

overload 1:
                        
models:setSecondaryTexture(textureType)  
 Method Property Fluent Description Representation
textureType accepts a String String 
   
Return Value nil nil 
   
overload 2:
                        
models:setSecondaryTexture(resource, path)  
 Method Property Fluent Description Representation
resource accepts a String String 
   
path accepts a String String 
   
Return Value nil nil

ModelPart.name

docs.modelpart.name

field signature:

name

Method Property	Fluent Description	Representation
Field Type	a String	`String`

Global Objects

Miscellaneous Types

action_wheel

world

keybind

model

math

event

nameplate

entity

misc

Miscellaneous Enums