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

Write LÖVE 2D projects with TypeScript

declare module "love.physics" {
  import { Type } from "love";

  type JointTypes =
    | "DistanceJoint"
    | "FrictionJoint"
    | "GearJoint"
    | "MotorJoint"
    | "MouseJoint"
    | "PrismaticJoint"
    | "PulleyJoint"
    | "RevoluteJoint"
    | "RopeJoint"
    | "WeldJoint"
    | "WheelJoint";

  /**
   * Attach multiple bodies together to interact in unique ways.
   * @link [Joint](https://love2d.org/wiki/Joint)
   */
  interface Joint<T extends JointTypes = JointTypes> extends Type<T> {
    /**
     * Explicitly destroys the Joint. When you don't have time to wait for garbage
     * collection, this function may be used to free the object immediately, but note
     * that an error will occur if you attempt to use the object after calling this
     * function.
     *
     * @link [Joint:destroy](https://love2d.org/wiki/Joint:destroy)
     */
    destroy(): void;

    /**
     * Get the anchor points of the joint.
     *
     * @return x1, The x component of the anchor on Body 1.
     * @return y1, The y component of the anchor on Body 1.
     * @return x2, The x component of the anchor on Body 2.
     * @return y2, The y component of the anchor on Body 2.
     * @link [Joint:getAnchors](https://love2d.org/wiki/Joint:getAnchors)
     */
    getAnchors(): LuaMultiReturn<
      [x1: number, y2: number, x2: number, y2: number]
    >;

    /**
     * Gets the bodies that the Joint is attached to.
     *
     * @return bodyA, The first Body.
     * @return bodyB, The second Body.
     * @link [Joint:getBodies](https://love2d.org/wiki/Joint:getBodies)
     */
    getBodies(): LuaMultiReturn<[bodyA: Body, bodyB: Body]>;

    /**
     * Gets whether the connected Bodies collide.
     *
     * @return c, True if they collide, false otherwise.
     * @link [Joint:getCollideConnected](https://love2d.org/wiki/Joint:getCollideConnected)
     */
    getCollideConnected(): boolean;

    /**
     * Gets the reaction force on Body 2 at the joint anchor.
     *
     * @param invdt How long the force applies. Usually the inverse time step or 1/dt.
     * @return x, The x component of the force.
     * @return y, The y component of the force.
     * @link [Joint:getReactionForce](https://love2d.org/wiki/Joint:getReactionForce)
     */
    getReactionForce(invdt: number): LuaMultiReturn<[x: number, y: number]>;

    /**
     * Returns the reaction torque on the second body.
     *
     * @param invdt How long the force applies. Usually the inverse time step or 1/dt.
     * @return torque, The reaction torque on the second body.
     * @link [Joint:getReactionTorque](https://love2d.org/wiki/Joint:getReactionTorque)
     */
    getReactionTorque(invdt: number): number;

    /**
     * Gets a string representing the type.
     *
     * @return type, A string with the name of the Joint type.
     * @link [Joint:getType](https://love2d.org/wiki/Joint:getType)
     */
    getType(): JointType;

    /**
     * Returns the Lua value associated with this Joint.
     *
     * @return value, The Lua value associated with the Joint.
     * @link [Joint:getUserData](https://love2d.org/wiki/Joint:getUserData)
     */
    getUserData(): any;

    /**
     * Gets whether the Joint is destroyed. Destroyed joints cannot be used.
     *
     * @return destroyed, Whether the Joint is destroyed.
     * @link [Joint:isDestroyed](https://love2d.org/wiki/Joint:isDestroyed)
     */
    isDestroyed(): boolean;

    /**
     * Associates a Lua value with the Joint.
     *
     * To delete the reference, explicitly pass _nil/undefined_.
     *
     * @param value The Lua value to associate with the Joint.
     * @link [Joint:setUserData](https://love2d.org/wiki/Joint:setUserData)
     */
    setUserData(value: any): void;
  }
}