A lot of GOOD API DOCUMENTATION

This commit is contained in:
Kam committed 2026-03-09 16:20:07 -04:00
1 parent a6c55ca331
commit 319e774518
131 files changed
+3363 -175

No files matched your search

+62 -1
View File
@@ -17,21 +17,51 @@ public interface IEnergyController {
/**
* Create an energy orb projectile. Not spawned until fire() is called.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @param size the orb size
* @return the energy orb entity
*/
IEnergyOrb createOrb(IWorld world, IEntity owner, double x, double y, double z, float size);
/**
* Create an energy beam projectile. Not spawned until fire() is called.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @param beamWidth the beam width
* @param headSize the head size
* @return the energy beam entity
*/
IEnergyBeam createBeam(IWorld world, IEntity owner, double x, double y, double z, float beamWidth, float headSize);
/**
* Create an energy disc projectile. Not spawned until fire() is called.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @param radius the disc radius
* @param thickness the disc thickness
* @return the energy disc entity
*/
IEnergyDisc createDisc(IWorld world, IEntity owner, double x, double y, double z, float radius, float thickness);
/**
* Create an energy laser projectile. Not spawned until fire() is called.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @param laserWidth the laser width
* @return the energy laser entity
*/
IEnergyLaser createLaser(IWorld world, IEntity owner, double x, double y, double z, float laserWidth);
@@ -40,12 +70,24 @@ public interface IEnergyController {
/**
* Create a hazard zone entity with defaults. Not spawned until spawn() is called.
* Hazards deal continuous damage to entities within the zone.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @return the energy zone entity
*/
IEnergyZone createHazard(IWorld world, IEntity owner, double x, double y, double z);
/**
* Create a trap zone entity with defaults. Not spawned until spawn() is called.
* Traps trigger when entities enter and deal burst damage.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @return the energy zone entity
*/
IEnergyZone createTrap(IWorld world, IEntity owner, double x, double y, double z);
@@ -54,6 +96,12 @@ public interface IEnergyController {
/**
* Create a sweeper entity with defaults. Not spawned until spawn() is called.
* Sweepers rotate a beam that damages entities in its path.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @return the energy sweeper entity
*/
IEnergySweeper createSweeper(IWorld world, IEntity owner, double x, double y, double z);
@@ -62,6 +110,12 @@ public interface IEnergyController {
/**
* Create a panel entity with defaults. Not spawned until spawn() is called.
* Panels are flat energy barriers that can deal damage on contact.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @return the energy panel entity
*/
IEnergyPanel createPanel(IWorld world, IEntity owner, double x, double y, double z);
@@ -69,7 +123,14 @@ public interface IEnergyController {
/**
* Create an energy explosion entity. Not spawned until spawn() is called.
* Visual-only by default. Set damage > 0 to enable area damage with falloff.
* Visual-only by default. Set damage > 0 to enable area damage with falloff.
* @param world the world
* @param owner the owning entity
* @param x X position
* @param y Y position
* @param z Z position
* @param radius the explosion radius
* @return the energy explosion entity
*/
IEnergyExplosion createExplosion(IWorld world, IEntity owner, double x, double y, double z, float radius);
}