Changes

Page history
Update Model authored by evlad's avatar evlad
Hide whitespace changes
Inline Side-by-side
Skills/Mechanics/Model.md
View page @ fe399cc7
[< Back to mechanic page](/Skills/Mechanics)
[\< Back to mechanic page](/Skills/Mechanics)
## Description
Add or remove a model from the targeted entity.
## Attributes
| Attribute | Aliases | Description | Type | Default |
|-----------|---------------|------------------------------------------|---------|---------|
| modelid | m, mid, model | The model id of the model | String | |
| remove | r | Is this mechanic used for removing model | Boolean | false |
| Attribute | Aliases | Description | Type | Default |
|-----------|---------|-------------|------|---------|
| modelid | m, mid, model | The model id of the model | String | |
| remove | r | Is this mechanic used for removing model | Boolean | false |
#### When remove = false
| Attribute | Aliases | Description | Type | Default |
|-----------------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------|
| hitbox | h | Should the model override the hitbox | Boolean | true |
| invisible | i, invis | Should the base entity be invisible | Boolean | true |
| damagetint | d, tint | Should the model flash red when damaged | Boolean | true |
| nametag | n, name | The tag bone used to display the name | String | |
| drive | | Can this model be driven | Boolean | false |
| ride | | Can this model have passengers | Boolean | false |
| lockpitch | lp, lpitch | Should the model's pitch be locked | Boolean | false |
| lockyaw | ly, lyaw | Should the model's yaw be locked | Boolean | false |
| step | s | The step height of the model | Double | 0.5 |
| radius | rad | Visible radius of the model.<br/>Values less than or equal to 0 will not be read | Integer | 0 |
| scale | | Scale of the model | Double | 1 |
| hitboxscale | | Collision hitbox scale of the model<br/>**Caution: Large hitboxes might cause server lag** | Double | scale |
| usestatemachine | usm, state, statemachine | Use the new animation system<br/>**Highly recommended to switch to this system** | Boolean | false |
| initrender | init | Whether the model should immediately be shown to players. If false, this allows you to further customize your model before showing with [RenderInit][] | Boolean | true |
| showhitbox | | Should the model's hitbox be visible.<br>If hidden, the player can no longer interact with the model. | Boolean | true |
| showshadow | | Should the shadow be visible | Boolean | true |
| syncbody | | Should the body rotation be synced to the head rotation | Boolean | true |
| save | | Should the model be saved on entity unload | Boolean | false |
| rootbone | root, rt | The [root bone](/Skills/Mechanics/RootMotion) of the model | String | |
| Attribute | Aliases | Description | Type | Default |
|-----------|---------|-------------|------|---------|
| hitbox | h | Should the model override the hitbox | Boolean | true |
| invisible | i, invis | Should the base entity be invisible | Boolean | true |
| damagetint | d, tint | Should the model flash red when damaged | Boolean | true |
| nametag | n, name | The tag bone used to display the name | String | |
| drive | | Can this model be driven | Boolean | false |
| ride | | Can this model have passengers | Boolean | false |
| lockpitch | lp, lpitch | Should the model's pitch be locked | Boolean | false |
| lockyaw | ly, lyaw | Should the model's yaw be locked | Boolean | false |
| step | s | The step height of the model | Double | 0.5 |
| radius | rad | Visible radius of the model.<br>Values less than or equal to 0 will not be read | Integer | 0 |
| scale | | Scale of the model | Double | 1 |
| hitboxscale | | Collision hitbox scale of the model<br>**Caution: Large hitboxes might cause server lag** | Double | scale |
| usestatemachine | usm, state, statemachine | Use the new animation system<br>**Highly recommended to switch to this system** | Boolean | false |
| initrender | init | Whether the model should immediately be shown to players. If false, this allows you to further customize your model before showing with [RenderInit](/Skills/Mechanics/RenderInit) | Boolean | true |
| showhitbox | | Should the model's hitbox be visible.<br>If hidden, the player can no longer interact with the model. | Boolean | true |
| showshadow | | Should the shadow be visible | Boolean | true |
| syncbody | | Should the body rotation be synced to the head rotation | Boolean | true |
| save | | Should the model be saved on entity unload | Boolean | false |
| rootbone | root, rt | The [root bone](/Skills/Mechanics/RootMotion) of the model | String | |
| track | | If set to false, the model will not be sent to other players. (Useful for disguising players without sending the model to other players) | Boolean | true |
#### When remove = true
| Attribute | Aliases | Description | Type | Default |
|-----------|---------|----------------------------------|---------|---------|
| killowner | ko | Should the base entity be killed | Boolean | false |
| Attribute | Aliases | Description | Type | Default |
|-----------|---------|-------------|------|---------|
| killowner | ko | Should the base entity be killed | Boolean | false |
## Examples
#### Adding a new model:
This will apply a model on entity spawn and load.
......@@ -55,12 +58,10 @@ Skills:
---
#### Remove a model:
This will remove the model and also kill the entity.
```yaml
Skills:
- model{m=kindletronsr;r=true;ko=true} @self
```
<!-- LINKS -->
[RenderInit]: /Skills/Mechanics/RenderInit
\ No newline at end of file
```
\ No newline at end of file