Skip to content

Commit

Permalink
doc: clarify meaning of ignoreSides in platformEffector (#601)
Browse files Browse the repository at this point in the history
  • Loading branch information
dragoncoder047 authored Feb 9, 2025
1 parent 53e9fe0 commit 0139c81
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/components/physics/effectors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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[];
/**
Expand Down

0 comments on commit 0139c81

Please sign in to comment.