Reference · Rockets, variants, parts and the fit check
lockupfunction
A lock-up of a big registry with the name set smaller above it, justified to its width, and an optional pinstripe between them: the arrangement of a ship's exterior marking. The registry's cap height is place.height
and its anchor is the middle of the lettering; the name stands 0.4 of that, a third of a registry height above.
Import it
import { lockup } from "@johnmorrisdotca/uchusen-rockets";Definition
function lockup(registry: string, name: string, place: MarkingPlace, style?: MarkingStyle, pinstripe?: MaterialName, nameRatio?: number): Piece[]Parameters
| Name | Type | Description |
|---|---|---|
registry | string | The big line, such as "SPX-207". |
name | string | The small line, such as "ISV KAMINARI". |
place | MarkingPlace | Where the registry goes. |
style (optional) | MarkingStyle | The face, paint and inline outline for both lines. |
pinstripe (optional) | "fin" | "deck" | "white" | "tile" | "dark" | "bell" | "foam" | "steel" | "tile-plain" | "soot" | "bell-inside" | "engine-metal" | "engine-pale" | "fin-dark" | "black" | "ink-worn" | "gold" | "solar" | "glass" | "blue" | "yellow" | "concrete" | "ground" | "sand" | "water" | "red" | "hull-white" | "hull-white-worn" | "hull-orange" | "hull-orange-worn" | "hull-dawn" | "hull-dawn-worn" | "hull-yellow" | "hull-grey" | "hull-grey-dark" | "hull-blue" | "panel-dark" | "coolant" | "blanket" | "copper" | "coil" | "radiator" | "radiator-hot" | "hazard" | "frost" | "lamp-amber" | "lamp-blue" | "lamp-red" | "plant" | "fuel" | "core" | "blanket-worn" | "foil" | "kapton" | "pipe-steel" | "window" | "coil-lit" | "nav-red" | "nav-green" | "nav-white" | "strobe" | "beacon" | "flood" | "light-pool" | "light-pool-mid" | "light-pool-edge" | "halo-port" | "halo-port-soft" | "halo-starboard" | "halo-starboard-soft" | "halo-stern" | "halo-stern-soft" | "halo-strobe" | "halo-strobe-soft" | "halo-beacon" | "halo-beacon-soft" | "halo-window" | "glass-clear" | "sky-wash" | "grow-lamp" | "leaf" | "soil" | "fabric" | "wood" | "lawn" | "lawn-dark" | "meadow" | "shrub" | "bark" | "flower" | "crop-gold" | "crop-green" | "water-clear" | undefined | A paint colour for a thin stripe between the two lines, as wide as the registry. |
nameRatio (optional) | number | The name's capital height as a share of the registry's; 0.4 by default. |
Returns
Piece[]
The pieces.
Examples
import { lockup } from "@johnmorrisdotca/uchusen-rockets";
const pieces = lockup("SPX-207", "ISV KAMINARI", { radius: 40, y: 200, az: 0, height: 6, align: "middle" }, { face: "orbitron", inline: "hull-white" }, "red");
console.log(pieces.length > 100);trueWhat it prints (run when this page was built)