Skip to content

API Reference ​

  • MainModule
    • Auth
    • Chat: Delivers admin messages (hints, messages, notifications, private messages, votes, text to speech and announcements) to the admin UI of each recipient, as text the server filtered for broadcast.
    • Defaults
    • Flux: Flux: fine-grained reactive UI for Roblox.
      • Async: Async resources: a fetcher runs off the graph, and its progress is exposed as nodes (data, error, loading, state).
      • Bind
      • Clock: Clock: the one source of time for Flux and the code built on it.
      • Conditional: Control flow, list mapping, and keyed selection: show, showKeyed, switch and presence mount one branch at a time in its own scope; pick and fallback choose between values without mounting anything; forValue and forIndex map reactive arrays; selector tracks which key matches a source in O(1).
      • Edit
      • Graph: The reactive graph: signals hold values, computeds derive them lazily, effects react to them, and scopes own the reactions and cleanups created inside them.
      • Interact: Interaction state as read-only boolean nodes (hover, press, selected, focused) and the hit tests pointIn, sunk and covered.
      • Layout: Layout instances with friendly, reactive arguments: padding, corner, stroke, list, grid, flex, gradient, aspectRatio, sizeConstraint, textSizeConstraint.
      • Motion: Animation: spring and tween return nodes that animate toward a reactive target, stepped once per frame.
      • Responsive: The screen and the player as shared nodes: viewport, UI scale, breakpoint, input device and accessibility settings.
      • Store: Deep reactive stores: Flux.store(table) returns a proxy whose fields are tracked per key, with Flux.Store helpers for arrays, snapshots and teardown.
    • Hook
    • Process
    • Registry
    • Remote: Single-remote networking wrapper with byte-packed IDs and auto-batching.
    • Service
    • UI
      • Fonts
      • Theme: A directory of Flux state for UI components to use as theme variables
    • Util
    • VIP
    • Z