Script API - v26.60.25
    Preparing search index...

    Class WidgetGizmoRotation

    The rotation surface of a gizmo component. It configures which rotation rings are shown, where they are centered, how large they are, and how a live drag is drawn, and it delivers the rotation lifecycle events the rings produce.

    Rotation is disabled until at least one axis is enabled through rotationAxes.

    export class WidgetGizmoRotation {
        private constructor();
        preferredRingRadius: number;
        rotationAxes: Axis;
        rotationOriginOffset: minecraftserver.Vector3;
        visualStepDegrees: number;
        setStateChangeEvent(eventFunction?: (arg0: WidgetGizmoRotationEvent) => void): void;
    }
    Index

    Constructors

    constructor

    Properties

    preferredRingRadius rotationAxes rotationOriginOffset visualStepDegrees

    Methods

    setStateChangeEvent

    Constructors

    Properties

    preferredRingRadius: number

    A preferred radius for rotation rings, in world units. The rendered radius remains at least its normal camera-sized radius and may be reduced to the screen-space cap when the preferred radius would exceed the usable viewport. Set zero to use camera-sized rings.

    This property affects rotation rings only and does not change translation handles.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    Throws InvalidWidgetComponentError when the gizmo component this rotation belongs to is no longer valid. Also throws when the radius is negative or is not a finite number.

    This property can't be read in early-execution mode.

    rotationAxes: Axis

    The world axes the gizmo shows a rotation ring for. Set Axis.None to remove the rings. This throws if the gizmo also has no translation axes.

    Changing this rebuilds the gizmo and clears its activated state. Activate the component again afterwards; activation is not preserved across the rebuild.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    Throws InvalidWidgetComponentError when the gizmo component this rotation belongs to is no longer valid. Throws when removing the rings would leave the gizmo with no translation or rotation axes, or when the value contains bits other than Axis.X, Axis.Y, or Axis.Z.

    This property can't be read in early-execution mode.

    rotationOriginOffset: Vector3

    The point the rings are centered on and rotate about, in world units relative to the owner widget's origin. Every component must be finite. A zero offset centers the rings on the widget origin itself.

    This is independent of where the translation handles are drawn.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    Throws InvalidWidgetComponentError when the gizmo component this rotation belongs to is no longer valid. Throws when any offset component is NaN or Infinity.

    This property can't be read in early-execution mode.

    visualStepDegrees: number

    The width, in degrees, of the step cell drawn on the ring during a drag, for consumers that commit rotation in fixed steps. The value must be finite and nonnegative. Set zero to draw no step cell.

    This is visual only. It does not snap the drag and does not change the deltaDegrees or totalDegrees values reported by rotation events. A consumer that wants stepped rotation must apply its own snapping.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    Throws InvalidWidgetComponentError when the gizmo component this rotation belongs to is no longer valid. Throws when the value is negative, NaN, or Infinity.

    This property can't be read in early-execution mode.

    Methods

    • Parameters

      Returns void

      Set the handler called for every rotation lifecycle event on this gizmo's rings. Call with no argument to remove the current handler.

      Each ring drag reports one Grabbed event, any number of Moved events, and exactly one terminal Released or Cancelled event. Rotation is a separate consumer-owned input stream. It does not select the translation gizmo or invoke widget-group mouse-down, drag, or mouse-up behavior. The consumer owns snapping and state application.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      Throws InvalidWidgetComponentError when the gizmo component this rotation belongs to is no longer valid.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods