VanillaModelGroup
Represents a group of model parts 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.
Used for easy reference of normal parts
All changes also applies to all children parts
setOffsetRot()
Aliases: offsetRot()
Offsets this part and its children'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.ALL:setOffsetRot(0, 90, 0)
getOffsetRot()
Gets this part's rotation offset
getOffsetRot()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.ALL:getOffsetRot()
setOffsetScale()
Aliases: offsetScale()
Offsets this part and its children'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.ALL:setOffsetScale(2, 2, 2)
getOffsetScale()
Gets this part's scale offset
getOffsetScale()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
vanilla_model.ALL:getOffsetScale()
setPos()
Aliases: pos()
Set this part and its children'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.ALL: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.ALL:getPos()
setRot()
Aliases: rot()
Set this part and its children'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.ALL: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.ALL:getRot()
setScale()
Aliases: scale()
Set this part and its children'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.ALL: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.ALL:getScale()
setVisible()
Aliases: visible()
Sets this part and its children to be visible or invisible
setVisible(visible)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| visible | Boolean | - | - |
Returns:
| Type | Description |
|---|---|
VanillaPart | - |
Example:
vanilla_model.ALL:setVisible(false)
getVisible()
Gets whether you have set this part to be visible or invisible
getVisible()
Returns:
| Type | Description |
|---|---|
Boolean | - |
Example:
vanilla_model.ALL:getVisible()