PokéRogue
    Preparing search index...

    Interface Velocity

    Contains methods for changing the velocity of a Matter Body. Should be used as a mixin and not called directly.

    interface Velocity {
        getAngularSpeed(): number;
        getAngularVelocity(): number;
        getVelocity(): Vector2Like;
        setAngularSpeed(speed: number): this;
        setAngularVelocity(velocity: number): this;
        setVelocity(x: number, y?: number): this;
        setVelocityX(x: number): this;
        setVelocityY(y: number): this;
    }

    Implemented by

    Index
    getAngularSpeed getAngularVelocity getVelocity setAngularSpeed setAngularVelocity setVelocity setVelocityX setVelocityY

    • Gets the current rotational speed of the body. Equivalent to the magnitude of its angular velocity.undefined

      Returns number

      The current angular speed of the body.

    • Gets the current rotational velocity of the body.undefined

      Returns number

      The current angular velocity of the body.

    • Gets the current linear velocity of the physics body.undefined

      Returns Vector2Like

      The current linear velocity of the body.

    • Sets the current rotational speed of the body. Direction is maintained. Affects body angular velocity.

      Parameters

      • speed: number

        The angular speed.

      Returns this

      This Game Object instance.

    • Sets the angular velocity of the body instantly. Position, angle, force etc. are unchanged.

      Parameters

      • velocity: number

        The angular velocity.

      Returns this

      This Game Object instance.

    • Sets both the horizontal and vertical velocity of the physics body.

      Parameters

      • x: number

        The horizontal velocity value.

      • Optionaly: number

        The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the x value. Default x.

      Returns this

      This Game Object instance.

    • Sets the horizontal velocity of the physics body.

      Parameters

      • x: number

        The horizontal velocity value, in pixels per second.

      Returns this

      This Game Object instance.

    • Sets the vertical velocity of the physics body.

      Parameters

      • y: number

        The vertical velocity value, in pixels per second.

      Returns this

      This Game Object instance.

    Settings
    Member Visibility

    On This Page
    Methods