Reference · Cube engine and views
GuideSteptype
The movement a guide asks for now.
Import it
import type { GuideStep } from "@johnmorrisdotca/kyuubu";
Definition
type GuideStep = {
moves: CubeMove[];
whole: CubeMove[];
text: string;
left: string;
rotation: boolean;
index: number;
total: number;
stage?: SolveStage;
};
Members
| Name | Type | Description |
|---|---|---|
moves | CubeMove[] | What is still to turn of it: the whole movement at first, less any layer or quarter already made. |
whole | CubeMove[] | The movement as asked for. |
text | string | The movement in notation: |
left | string | What is still to turn, in notation: |
rotation | boolean | Whether it turns the whole cube, which no drag on a sticker does. |
index | number | Which movement it is, from 0, in the list or in the method's step. |
total | number | How many movements the list, or the method's step, has. |
stage (optional) | SolveStage | undefined | The method's stage it belongs to, following the method. |
Examples
import type { GuideStep } from "@johnmorrisdotca/kyuubu";
import { Guide, solvedCube } from "@johnmorrisdotca/kyuubu";
const value: GuideStep = new Guide(solvedCube(3), 3, { moves: "R U" }).next!;
console.log(value.text);RWhat it prints (run when this page was built)