VanillaModelPart
Represents a model part in a vanilla model
This page is a WIP. It contains all the information in Figura's documentation but we're working on adding more helpful descriptions.
Can be queried for vanilla transform values
setOffsetRot()
Aliases: offsetRot()
Offsets this part's rotation, adding on top of the vanilla values
- Overload 1
- Overload 2
setOffsetRot(offsetRot)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| offsetRot | Vector3 | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
setOffsetRot(x, y, z)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| x | Number | - | - |
| y | Number | - | - |
| z | Number | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
Example:
vanilla_model.HEAD:setOffsetRot(0, 90, 0)
getOffsetRot()
Gets this part's rotation offset
getOffsetRot()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.HEAD:getOffsetRot()
setOffsetScale()
Aliases: offsetScale()
Offsets this part's scale, multiplying with the vanilla values
- Overload 1
- Overload 2
setOffsetScale(offsetScale)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| offsetScale | Vector3 | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
setOffsetScale(x, y, z)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| x | Number | - | - |
| y | Number | - | - |
| z | Number | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
Example:
vanilla_model.HEAD:setOffsetScale(2, 2, 2)
getOffsetScale()
Gets this part's scale offset
getOffsetScale()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.HEAD:getOffsetScale()
getOriginPos()
Gets the position offset to this vanilla model part currently applied by Minecraft
getOriginPos()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.HEAD:getOriginPos()
getOriginRot()
Gets the rotation to this vanilla model part currently applied by Minecraft
getOriginRot()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.HEAD:getOriginRot()
getOriginScale()
Gets the scale to this vanilla model part currently applied by Minecraft
getOriginScale()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.HEAD:getOriginScale()
getOriginVisible()
Gets if this vanilla model part is visible or not, without interference from your script
getOriginVisible()
Returns:
| Type | Description |
|---|---|
Boolean | - |
Example:
vanilla_model.HEAD:getOriginVisible()
setPos()
Aliases: pos()
Set this part's position, preserving the previous values
- Overload 1
- Overload 2
setPos(x, y, z)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| x | Number | - | - |
| y | Number | - | - |
| z | Number | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
Example:
vanilla_model.HEAD:setPos(0, 10, 0)
getPos()
Get this part's set position
Returns the value set by the "set" function
getPos()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.HEAD:getPos()
setRot()
Aliases: rot()
Set this part's rotation
- Overload 1
- Overload 2
setRot(x, y, z)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| x | Number | - | - |
| y | Number | - | - |
| z | Number | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
Example:
vanilla_model.HEAD:setRot(0, 90, 0)
getRot()
Get this part's set rotation
Returns the value set by the "set" function
getRot()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.HEAD:getRot()
setScale()
Aliases: scale()
Set this part's scale
- Overload 1
- Overload 2
setScale(scale)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| scale | Vector3 | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
setScale(x, y, z)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| x | Number | - | - |
| y | Number | - | - |
| z | Number | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
Example:
vanilla_model.HEAD:setScale(2, 2, 2)
getScale()
Get this part's set scale
Returns the value set by the "set" function
getScale()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.HEAD:getScale()
setVisible()
Aliases: visible()
Sets this part to be visible or invisible
setVisible(visible)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| visible | Boolean | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
Example:
vanilla_model.HEAD:setVisible(false)
getVisible()
Gets whether you have set this part to be visible or invisible
getVisible()
Returns:
| Type | Description |
|---|---|
Boolean | - |
Example:
vanilla_model.HEAD:getVisible()