Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify meaning of ignoreSides in platformEffector #601

Merged
merged 1 commit into from
Feb 9, 2025
+4 −1
Merged

doc: clarify meaning of ignoreSides in platformEffector #601

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/components/physics/effectors.ts
View file
Open in desktop
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