Cosmos Journeyer API Documentation - v1.10.1
    Preparing search index...

    Type Alias LandingPlanStep

    One step in a plan of action for a transformable object subject to physics

    type LandingPlanStep = {
        getTargetTransform: () => | { position: Vector3; rotation: Quaternion }
        | null;
        maxVelocity: { linearY: number; rotation: number };
        maxVelocityAtTarget: { linear: number; rotation: number };
        tolerance: { position: number; rotation: number };
    }
    Index

    Properties

    getTargetTransform maxVelocity maxVelocityAtTarget tolerance

    Properties

    getTargetTransform: () => { position: Vector3; rotation: Quaternion } | null

    Type declaration

      • (): { position: Vector3; rotation: Quaternion } | null

      • Returns { position: Vector3; rotation: Quaternion } | null

        The target position and rotation for the transformable object in this step

        • { position: Vector3; rotation: Quaternion }
          • position: Vector3

            The position to reach

          • rotation: Quaternion

            The rotation to reach

        • null
    maxVelocity: { linearY: number; rotation: number }

    The maximum velocity at any point during the step

    maxVelocityAtTarget: { linear: number; rotation: number }

    The maximum velocity when reaching the target before the step is considered complete

    tolerance: { position: number; rotation: number }

    The tolerance margin to consider the step complete

    Type declaration

    • position: number

      The maximum distance to the target position

    • rotation: number

      The maximum deviation between the target and current up vectors

    Settings

    Member Visibility

    On This Page

    Properties