Skip to content

Commit b0c1c26

Browse files
more nut.anim info for those in need
1 parent f2549ac commit b0c1c26

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

docs/developer/libraries/nut.anim.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,26 @@ Supports model class assignments and forced animation sequences for roleplay pur
66
## Functions
77
???+ realm-shared "<a id=nut.anim.setModelClass></a>nut.anim.setModelClass (model, class)"
88
##### sh_nut.anim.setModelClass {#nut.anim.setmodelclass}
9-
Sets the animation class for a specified model.
9+
Sets the animation class for a specified model. Use this to fix models using incorrect animations or T-Posing
10+
11+
!!! warning "This function does not transform models"
12+
`nut.anim.setModelClass` doesn't give a model animations, it translates gmod inputs meant for typical playermodels to those used by stuff like NPC models.
13+
If a model does not have animations baked into them, it won't play them.
14+
There are ways to achieve that but not base NS.
15+
16+
<h3>Supported classes:</h3>
17+
18+
|Class|Description|
19+
|-----------|-----------|
20+
|`citizen_male`| Male Human NPC animations. Use this for models using the male HL2 Citizen model as a base |
21+
|`citizen_female`| Female Human NPC animations. Use this for models using the female HL2 Citizen model as a base |
22+
|`metrocop`| Metrocop animations. Use this for models using the HL2 Metrocop model as a base |
23+
|`overwatch`| Overwatch animations. Use this for models using the HL2 Overwatch Elite model as a base |
24+
|`vort`| Vortiguant animations. Use this for models using the HL2 Vort model as a base |
25+
|`zombie`| Zombie animations. Use this for models using the HL2 Zombie model as a base |
26+
|`fastZombie`| Fast Zombie animations. Use this for models using the HL2 Fast Zombie model as a base |
27+
|`player`| Player animations. Use this for models meant to be used as player models (typically have `/player/` in their model path) |
28+
1029
<h3>Parameters:</h3>
1130
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
1231
<span class="parameter">model</span>

0 commit comments

Comments
 (0)