Document newton task

Mubelotix · Jan 4, 2024 · 3f0b69b · 3f0b69b
1 parent 1298a82
commit 3f0b69b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/minecraft-server/src/entities/tasks/newton.rs b/minecraft-server/src/entities/tasks/newton.rs
@@ -2,6 +2,13 @@ use crate::CollisionShape;
 
 use super::*;
 
+/// This task applies gravity and velocity to an entity.
+/// It has minimal performance impact.
+/// 
+/// It can be used by other larger tasks.
+/// In that case, other tasks should stick to modifying `x`, `z`, `vx`, `vz` and `vy`.
+/// This task shall be called at the end of their tick.
+/// See the [ZombieTask] for an example.
 pub struct NewtonTask {
     width: f64,
     height: f64,