love-typescript-definitions/typings/love.physics/types/WheelJoint.d.ts

Write LÖVE 2D projects with TypeScript

declare module "love.physics" {
  /**
   * Restricts a point on the second body to a line on the first body.
   * @link [WheelJoint](https://love2d.org/wiki/WheelJoint)
   */
  interface WheelJoint extends Joint<"WheelJoint"> {
    /**
     * Gets the world-space axis vector of the Wheel Joint.
     *
     * @return x, The x-axis coordinate of the world-space axis vector.
     * @return y, The y-axis coordinate of the world-space axis vector.
     * @link [WheelJoint:getAxis](https://love2d.org/wiki/WheelJoint:getAxis)
     */
    getAxis(): LuaMultiReturn<[x: number, y: number]>;

    /**
     * Returns the current joint translation speed.
     *
     * @return speed, The translation speed of the joint in meters per second.
     * @link [WheelJoint:getJointSpeed](https://love2d.org/wiki/WheelJoint:getJointSpeed)
     */
    getJointSpeed(): number;

    /**
     * Returns the current joint translation.
     *
     * @return position, The translation of the joint in meters.
     * @link [WheelJoint:getJointTranslation](https://love2d.org/wiki/WheelJoint:getJointTranslation)
     */
    getJointTranslation(): number;

    /**
     * Returns the maximum motor torque.
     *
     * @return maxTorque, The maximum torque of the joint motor in newton meters.
     * @link [WheelJoint:getMaxMotorTorque](https://love2d.org/wiki/WheelJoint:getMaxMotorTorque)
     */
    getMaxMotorTorque(): number;

    /**
     * Returns the speed of the motor.
     *
     * @return speed, The speed of the joint motor in radians per second.
     * @link [WheelJoint:getMotorSpeed](https://love2d.org/wiki/WheelJoint:getMotorSpeed)
     */
    getMotorSpeed(): number;

    /**
     * Returns the current torque on the motor.
     *
     * @param invdt How long the force applies. Usually the inverse time step or 1/dt.
     * @return torque, The torque on the motor in newton meters.
     * @link [WheelJoint:getMotorTorque](https://love2d.org/wiki/WheelJoint:getMotorTorque)
     */
    getMotorTorque(invdt: number): number;

    /**
     * Returns the damping ratio.
     *
     * @return ratio, The damping ratio.
     * @link [WheelJoint:getSpringDampingRatio](https://love2d.org/wiki/WheelJoint:getSpringDampingRatio)
     */
    getSpringDampingRatio(): number;

    /**
     * Returns the spring frequency.
     *
     * @return freq, The frequency in hertz.
     * @link [WheelJoint:getSpringFrequency](https://love2d.org/wiki/WheelJoint:getSpringFrequency)
     */
    getSpringFrequency(): number;

    /**
     * Checks if the joint motor is running.
     * @return on, The status of the joint motor.
     * @link [WheelJoint:isMotorEnabled](https://love2d.org/wiki/WheelJoint:isMotorEnabled)
     */
    isMotorEnabled(): boolean;

    /**
     * Sets a new maximum motor torque.
     *
     * @param maxTorque The new maximum torque for the joint motor in newton meters.
     * @link [WheelJoint:setMaxMotorTorque](https://love2d.org/wiki/WheelJoint:setMaxMotorTorque)
     */
    setMaxMotorTorque(maxTorque: number): void;

    /**
     * Starts and stops the joint motor.
     *
     * @param enable True turns the motor on and false turns it off.
     * @link [WheelJoint:setMotorEnabled](https://love2d.org/wiki/WheelJoint:setMotorEnabled)
     */
    setMotorEnabled(enable: boolean): void;

    /**
     * Sets a new speed for the motor.
     *
     * @param speed The new speed for the joint motor in radians per second.
     * @link [WheelJoint:setMotorSpeed](https://love2d.org/wiki/WheelJoint:setMotorSpeed)
     */
    setMotorSpeed(speed: number): void;

    /**
     * Sets a new damping ratio.
     *
     * @param ratio The new damping ratio.
     * @link [WheelJoint:setSpringDampingRatio](https://love2d.org/wiki/WheelJoint:setSpringDampingRatio)
     */
    setSpringDampingRatio(ratio: number): void;

    /**
     * Sets a new spring frequency.
     *
     * @param freq The new frequency in hertz.
     * @link [WheelJoint:setSpringFrequency](https://love2d.org/wiki/WheelJoint:setSpringFrequency)
     */
    setSpringFrequency(freq: number): void;
  }
}