Platformer2DMovementComponent
@zylem/game-lib / behavior / Platformer2DMovementComponent
Interface: Platformer2DMovementComponent
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:12
Platformer 2D Components
Components for 2D platformer movement on the X/Y plane: walking/running on X, jumping with multi-jump support, and falling/landing states.
Properties
autostep
autostep:
false| \{maxHeight:number;minWidth:number; \}
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:36
Autostep configuration for SNES-style step-ups, or false to disable
characterOffset
characterOffset:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:43
Character controller offset (small gap kept between collider and environment)
coyoteTime
coyoteTime:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:24
Coyote time in seconds (grace period after leaving ground)
gravity
gravity:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:22
Gravity force
jumpBufferTime
jumpBufferTime:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:26
Jump buffer time in seconds (queue jump input before landing)
jumpCutMultiplier
jumpCutMultiplier:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:28
Velocity multiplier when releasing jump button early (0-1)
jumpForce
jumpForce:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:18
Initial jump force/velocity
maxJumps
maxJumps:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:20
Maximum number of jumps (1 = single jump, 2 = double jump, etc.)
multiJumpWindowTime
multiJumpWindowTime:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:30
Time in seconds before multi-jump becomes available (0 = after button release)
runSpeed
runSpeed:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:16
Sprint/run speed
slopeClimbAngle
slopeClimbAngle:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:32
Maximum slope angle (degrees) the character can walk up
slopeSlideAngle
slopeSlideAngle:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:34
Slope angle (degrees) past which the character slides down
snapToGroundDistance
snapToGroundDistance:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:41
Snap-to-ground distance (keeps the character glued going downhill)
walkSpeed
walkSpeed:
number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/platformer-2d.d.ts:14
Base walking speed