Reference · Cube engine and views
faceMovefunction
A face turned, depth layers in from it (1 is the face itself), on a cube of this size; null where the cube has no such layer.
Import it
import { faceMove } from "@johnmorrisdotca/kyuubu";
Definition
function faceMove(face: CubeFaceLetter, depth: number, amount: "cw" | "half" | "ccw", n: number): CubeMove | null
Parameters
| Name | Type | Description |
|---|---|---|
face | CubeFaceLetter | The face letter: U, R, F, D, L or B. |
depth | number | The layer depth counted from the named face, starting at 1. |
amount | "cw" | "half" | "ccw" | The turn direction: cw, half or ccw. |
n | number | The cube’s side length. |
Returns
CubeMove | null
A face turned, depth layers in from it (1 is the face itself), on a cube of this size; null where the cube has no such layer.
Examples
import { faceMove } from "@johnmorrisdotca/kyuubu";
console.log(faceMove("R", 1, "cw", 3));{ axis: 0, layer: 2, turns: 3 }What it prints (run when this page was built)