From 459d36c30271f951447b4332116baa89ddac38ee Mon Sep 17 00:00:00 2001
From: dragoncoder047 <101021094+dragoncoder047@users.noreply.github.com>
Date: Thu, 30 Jan 2025 21:23:15 -0500
Subject: [PATCH] clarify meaning of ignoreSides in platformEffector

---
 src/components/physics/effectors.ts | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/components/physics/effectors.ts b/src/components/physics/effectors.ts
index 36f097ab..9bda60f4 100644
--- a/src/components/physics/effectors.ts
+++ b/src/components/physics/effectors.ts
@@ -152,9 +152,12 @@ export function constantForce(opts: ConstantForceCompOpt): ConstantForceComp {
 export type PlatformEffectorCompOpt = {
     /**
      * If the object is about to collide and the collision normal direction is
-     * in here, the object won't collide.
+     * in here (i.e. the object is moving roughly in this direction), the object won't collide.
      *
      * Should be a list of unit vectors `LEFT`, `RIGHT`, `UP`, or `DOWN`.
+     * 
+     * Defaults to `[UP]`, i.e. the object will only be able to pass through when it
+     * is jumping upwards, but will collide when it is moving downwards or sideways.
      */
     ignoreSides?: Vec2[];
     /**