phaser - v4.0.0-rc.4
    Preparing search index...

    Interface Friction

    Contains methods for changing the friction of a Game Object's Matter Body. Should be used a mixin, not called directly.

    interface Friction {
        setFriction(value: number, air?: number, fstatic?: number): this;
        setFrictionAir(value: number): this;
        setFrictionStatic(value: number): this;
    }

    Implemented by

    Index

    Methods

    setFriction setFrictionAir setFrictionStatic

    Methods

    • Sets new friction values for this Game Object's Matter Body.

      Parameters

      • value: number

        The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.

      • Optionalair: number

        If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.

      • Optionalfstatic: number

        If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never "stick" when it is nearly stationary.

      Returns this

    • Sets a new air resistance for this Game Object's Matter Body. A value of 0 means the Body will never slow as it moves through space. The higher the value, the faster a Body slows when moving through space.

      Parameters

      • value: number

        The new air resistance for the Body.

      Returns this

    • Sets a new static friction for this Game Object's Matter Body. A value of 0 means the Body will never "stick" when it is nearly stationary. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.

      Parameters

      • value: number

        The new static friction for the Body.

      Returns this

    Settings

    Member Visibility

    On This Page

    Methods