Skip to content

API Reference ​

  • ink: Roblox UI beyond the instance tree.
    • after: Returns true after the specified duration of seconds has elapsed.
    • align: Positions a composite inside a container rect using 0 to 1 anchors for each axis.
    • aspect_cover: Returns the smallest rect with the given aspect ratio (width over height) that covers the specified container.
    • aspect_fit: Returns the largest rect with the given aspect ratio (width over height) that fits inside the specified container.
    • async: Runs a computation in a separate thread, returning a default value until its result is ready.
    • clip: Restricts a composite's visible area to a rect, discarding anything entirely outside it.
    • color: Oklab and Oklch implementation, alongside Color3 extension methods.
    • compose: Combines composites into one.
    • context
    • corners
    • destruction
    • distribute: Distributes fixed and fractional lengths to a container length.
    • edges
    • every: Returns true each time another interval of the specified duration in seconds has elapsed.
    • expensive: Caches a computation's results, recomputing only when its arguments change.
    • gradient
    • h_stack: Arranges composites left to right, optionally aligning them within the tallest one.
    • hit_region: Creates an invisible interactive region.
    • hoarcekat_story: Wraps a component as a Hoarcekat story.
    • image: Creates a composite containing an image.
    • input_collector: Collects player input from an input source, such as UserInputService or a GuiObject.
    • inset_rect: Shrinks a rect by a separate amount on each side.
    • intersect_rects: Returns the overlap of two rects.
    • is_equal_rects: Returns whether two optional Rects have the same position and size.
    • is_in_rect: Returns whether a point lies inside a Rect.
    • lerp: Interpolates between two values of the same type.
    • log
    • map_primitives: Returns a new composite with fn applied to a copy of each primitive.
    • masonry: Places each composite in whichever column is currently shortest.
    • mount
    • pad: Grows a composite's bounds by a separate amount on each side, without moving its contents.
    • place: Moves each composite so its top-left corner is at the matching position.
    • rect: Creates a rect from a position and size.
    • rect_sized: Creates a rect of the given size at the origin.
    • rect_squared: Creates a rect of the given side length at the origin.
    • renderer
    • resolve_input
    • rotate: Rotates a composite around its centre, or around a given pivot.
    • round: Rounds the corners of every primitive in a composite.
    • scope: Stores state between frames at named keys.
    • shadow
    • solid: Creates a composite containing a solid rectangle.
    • spring: Animates towards a target with physically simulated motion, keeping its momentum when the target changes.
    • stack_layout: Returns the top-left position each item should move to.
    • stroke
    • text: Creates a composite containing measured text.
    • text_field
    • timer: Returns the time elapsed since the timer's key was first requested.
    • tint: Recolors and/or fades every primitive in a composite, including modifiers.
    • translate: Moves a composite by a pixel offset.
    • tween: Animates towards a target over a fixed duration with easing, restarting from the current value when the target changes.
    • ui_labs_story: Wraps a component as a UI Labs story.
    • union_rects: Returns the smallest rect containing both rects.
    • units
    • v_stack: Arranges composites top to bottom, optionally aligning them within the longest one.
    • visible_range: Returns the range of items which are visible for a given scroll offset, as seen in scrolling views.