MineClone5/mods/PLAYER/mcl_playerplus/README.md

32 lines
909 B
Markdown
Raw Normal View History

# PlayerPlus mod for MineClone 2
## Features
- Hurt players touching cacti (0.5 hearts / 0.5s)
- Suffocation: Hurt players who have their head inside a solid block (0.5 hearts / 0.5s)
- Exhaustion for swimming and jumping
- Particle effects
Suffocation *not* dealt to player with the `noclip` privilege.
## Notes
This mod is based on PlayerPlus [`playerplus`] by TenPlus1. It is now
very different than the original, no compability is intended.
## API
Every half second the mod checks which node the player is standing on, which
node is at foot and head level and stores inside a global table to be used by mods:
- `mcl_playerplus[name].node_stand`
- `mcl_playerplus[name].node_stand_below`
- `mcl_playerplus[name].node_foot`
- `mcl_playerplus[name].node_head`
Setting the group `disable_suffocation=1` disables suffocation for nodes which
would otherwise deal suffocation damage.
## License
WTFPL.