scalePreset

@three-blocks/pro
scalePreset(basePreset : PhysicsModel, scales : Object, name : string) : PhysicsModel

Creates a preset with scaled physics values.

Note: This utility targets legacy presets that expose getForceMultiplier, getGravityBonus, getFriction, and getJumpVelocity.

Parameters
basePresetPhysicsModel
The preset to scale.
scalesObject
Scale factors for each property.
  • forceoptionalnumber
    Force multiplier scale.
    Default is 1.
  • gravityoptionalnumber
    Gravity bonus scale.
    Default is 1.
  • frictionoptionalnumber
    Friction scale.
    Default is 1.
  • jumpoptionalnumber
    Jump velocity scale.
    Default is 1.
nameoptionalstring
Optional name for the scaled preset.
Returns
PhysicsModel
Example
const heavy = scalePreset( legacyModel, { gravity: 1.5, jump: 0.8 }, 'heavy' );