Wuzzy/repixture-cd2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add mini-documentation for rp_wielditem

Browse Source
This commit is contained in:
Wuzzy 2023-02-12 02:49:40 +01:00
parent f53defb1be
commit bb7ebc347c
3 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
DEVELOPERS.md
View File

@ -57,6 +57,7 @@ Mods with documented APIs:
* `rp_sounds`: Node sounds
* `rp_util`: Helper functions for Repixture
* `rp_tnt`: Ignite and blow up TNT, also spawn TNT-less explosions
* `rp_wielditem`: Custom rotation of item in hand in 3rd person view (in case it looks awkward)
* `tt`: Custom tooltips
Beware: Calling functions that are not documented are NOT guaranted to be stable

8
mods/rp_wielditem/API.md Normal file
View File

@ -0,0 +1,8 @@
Normally, you don't need to do anything special for this mod to work,
most items will show up correctly in 3rd person view.
Sometimes, an item might show up with the wrong rotation in 3rd person view,
so a correct angle has to be specified.
To do this, add `_rp_wielditem_rotation` to the node definition and set it
to a rotation value (between 0 and 360 degrees).

4
mods/rp_wielditem/README.txt
View File

@ -6,9 +6,7 @@ Shows the wield item in 3rd person view.
## For developers
If an item does not show up correctly in 3rd person view (bad rotation),
add `_rp_wielditem_rotation` to the node definition and set it to a rotation value
(between 0 and 360 degrees).
See `API.md`.
## Licensing