https://github.com/liteldev/legacyparticleapi
ParticleAPI ported from LiteLoaderBDS
https://github.com/liteldev/legacyparticleapi
Last synced: 8 months ago
JSON representation
ParticleAPI ported from LiteLoaderBDS
- Host: GitHub
- URL: https://github.com/liteldev/legacyparticleapi
- Owner: LiteLDev
- License: gpl-3.0
- Created: 2024-01-18T12:24:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-02T11:58:09.000Z (9 months ago)
- Last Synced: 2025-10-02T13:39:25.726Z (9 months ago)
- Language: C++
- Homepage:
- Size: 82 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# LegacyParticleAPI
English | [简体中文](README.zh.md)
**You shou install [LiteLoaderBDS-CUI](https://github.com/OEOTYAN/LiteLoaderBDS-CUI/releases) on your server firstly if you want to see the particle**
You can just decompress the resource pack to `./plugins/LegacyParticleAPI/ResourcePacks`
## Usage
ParticleAPI provides a rich and easy-to-use particle generation interface for plugin development, which intuitive design and efficient and stable performance support developers to write better plugins.
Including header `#include "LegacyParticleAPI/ParticleAPI.h"` is the first step to use ParticleAPI。
It provides the generation class `ParticleAPI` which is closer to the bottom layer and the further encapsulated CUI class `ParticleCUI`. The difference between the two is very small, and only the members of the CUI class are introduced here.
### CUI
| Type | Name | Illustration |
| ---- | ------------------- | ------------------------- |
| Var | displayRadius: uint | maximum visible distance |
| Var | highDetial: bool | draw type HD option |
| Var | doubleSide: bool | draw type two-side option |
| Func | spawnParticle | generate the particle |
| Func | spawnPoint | generate the point |
| Func | spawnNumber | generate the number |
| Func | drawOrientedLine | draw oriented line |
| Func | drawCuboid | draw 3D rectangle |
| Func | drawCircle | draw 2D circle |