Skip to main content

Jumper3DBehaviorOptions

@zylem/game-lib

@zylem/game-lib / behavior / Jumper3DBehaviorOptions

Interface: Jumper3DBehaviorOptions

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/jumper-3d.d.ts:53

Properties​

coyoteTimeMs?​

optional coyoteTimeMs?: 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/jumper-3d.d.ts:67

Coyote time in ms (default: 100)

debugGroundProbe?​

optional debugGroundProbe?: boolean

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/jumper-3d.d.ts:83

Enable debug visualization for ground probe rays (default: false)

fall?​

optional fall?: object

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/jumper-3d.d.ts:77

Fall tuning (optional)

fallGravityMultiplier​

fallGravityMultiplier: number

Gravity multiplier while falling (e.g. 1.5-2.5)

fastFallMultiplier?​

optional fastFallMultiplier?: number

Additional multiplier when fast-fall input is held

gravity?​

optional 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/jumper-3d.d.ts:57

Gravity magnitude applied by the behavior (default: 20)

groundRayLength?​

optional groundRayLength?: 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/jumper-3d.d.ts:79

Ground-detection ray length (default: 1.0)

jumpBufferMs?​

optional jumpBufferMs?: 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/jumper-3d.d.ts:69

Jump buffer in ms (default: 80)

jumpHeight?​

optional jumpHeight?: 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/jumper-3d.d.ts:55

Desired peak height in world units (default: 2.5)

maxFallSpeed?​

optional maxFallSpeed?: 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/jumper-3d.d.ts:59

Terminal fall speed (optional)

maxJumps?​

optional 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/jumper-3d.d.ts:61

Max concurrent jumps, 1 = single, 2 = double, etc. (default: 1)

minTimeBetweenJumpsMs?​

optional minTimeBetweenJumpsMs?: 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/jumper-3d.d.ts:71

Min cooldown between jumps in ms (optional)

planar?​

optional planar?: object

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/jumper-3d.d.ts:75

Planar control config (optional)

airControl?​

optional airControl?: object

airControl.acceleration​

acceleration: number

Acceleration per second while airborne

airControl.deceleration​

deceleration: number

Deceleration per second when no input

airControl.maxPlanarSpeed​

maxPlanarSpeed: number

launchPlanarSpeed?​

optional launchPlanarSpeed?: number

One-time planar speed applied at takeoff

preservePlanarSpeed?​

optional preservePlanarSpeed?: boolean

If true, preserve current planar speed instead of replacing it

resetJumpsOnGround?​

optional resetJumpsOnGround?: boolean

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/jumper-3d.d.ts:63

Reset jump counter on ground (default: true)

resetJumpsOnWall?​

optional resetJumpsOnWall?: boolean

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/jumper-3d.d.ts:65

Reset jump counter on wall contact (default: undefined)

snapToGroundDistance?​

optional 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/jumper-3d.d.ts:81

Max support distance that counts as grounded and can snap to ground

variableJump?​

optional variableJump?: object

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/jumper-3d.d.ts:73

Variable jump height config (optional)

cutGravityMultiplier​

cutGravityMultiplier: number

Gravity multiplier applied when jump is released early while ascending

enabled​

enabled: boolean

maxHoldMs?​

optional maxHoldMs?: number

Max hold duration before the cut triggers automatically (ms, optional)