API reference
The public contract at a glance, with links to complete argument tables.
Module and ownership#
| API | Reference |
|---|---|
| Aroyn:CreateWindow(options) | Windows |
| Aroyn:AttachWindow(options) | Windows |
| Aroyn:CreateIcon(parent, key, size?, tint?) | Pages & icons |
| Window:CreatePage / SelectPage / SetMinimized / Destroy | Windows |
| Page:CreateSection / Select / Destroy | Pages |
| Section:Destroy | Sections |
Component constructors#
| Constructor | Value | Callback | Reference |
|---|---|---|---|
| Section:CreateButton(options) | Caption only | () | Button |
| Section:CreateToggle(options) | boolean | (boolean) | Toggle |
| Section:CreateTextInput(options) | string | (string) | Text Input |
| Section:CreateSlider(options) | number | (number) | Slider |
| Section:CreateDropdown(options) | string? or {string} | (value) | Dropdown / Multi |
| Section:CreateKeybind(options) | Enum.KeyCode? | (key); OnActivate(active,key,mode) | Keybind |
| Section:CreateColorPicker(options) | Color3 | (Color3) | ColorPicker |
Shared handle contract#
| Method | Returns | Behavior |
|---|---|---|
| GetValue() | Value | Reads the current typed value. Multi selections return a copy. |
| SetValue(value, notify?) | self | Silent by default; true calls Callback only after a changed normalized value. |
| SetDisabled(boolean) | self | Changes user availability without discarding the value. |
| IsDisabled() | boolean | Reads the requested disabled state. |
| Destroy() | nil | Removes this control and its subscriptions; safe to repeat. |
Exceptions and extra methods appear on each component page. Button uses GetText/SetText; Dropdown has option and popup methods; Keybind has mode/activation/capture; ColorPicker has hex and popup methods.
Overlays#
| API | Return | Reference |
|---|---|---|
| Window:Notify(options) | Toast: Id, GetState, GetDismissReason, Dismiss | Notifications |
| Window:Dialog(options) | Dialog: Id, GetState, GetDismissReason, GetAction, Close | Dialogs |
Configuration#
| Method | Returns | Behavior |
|---|---|---|
| ConfigureConfig(options?) | ok, info | Before the first Flag; cannot reconfigure. |
| RegisterConfig(control, flag, options?) | control | Register an existing owned control; options Persist/Sensitive. |
| GetConfigState() | table | Independent JSON-compatible snapshot; does not write a file. |
| GetConfigStatus() | table | Mode, Namespace, Path, Capabilities, AutoSave, AutoSaveConfig, AutoSaveDelay, LastResult. |
| SaveConfig(name) | ok, info | Save current registered values and valid deferred entries. |
| LoadConfig(name, options?) | ok, info | Restore; InvokeCallbacks=false by default. |
| ListConfigs() | ok, info | Sorted names in info.Names. |
| DeleteConfig(name) | ok, info | Delete profile; cancel pending save for its name. |
| ResetConfig(options?) | ok, info | Restore registered defaults, clear deferred; saved files remain. |
| SetConfigAutoSave(enabled, name?, delay?) | ok, info | Enable/disable; enabling does not write immediately. |
All options, result codes, flag constraints and schema fields are documented under Configuration manager.
Module fields#
| Field | Contract |
|---|---|
| Theme | Mutable existing groups before construction; no live retheme promise. |
| IconAtlas | Ready URI of the seven-cell core atlas. |
| Logo | Convenience field; must pass via window Logo explicitly. |
| MotionEnabled | false makes page/popup/morph instant, not every animation. |
Not public API#
Methods with an underscore, Scope, managers, Render/Reflow and internal GUI fields are implementation details. There is no AddTab, AddToggle, OnChanged, SetTheme, ApplyTheme, CreateMultiDropdown, control.Save, window Position or window Footer API.
Supported environments and distribution#
| Environment | Evidence |
|---|---|
| Windows PC / Potassium | Owner-tested public download, components, notifications, floating launcher and earlier configuration persistence. |
| Other Windows executors | Not verified. |
| Android / iOS | Not verified; browser viewport emulation does not prove library device compatibility. |
| Roblox Studio | Not established as officially supported; executor file/custom-asset APIs are not standard Studio APIs. |
Version 0.1.0 is an early product version, not a permanently frozen API promise. Missing filesystem/custom-asset capabilities use documented Session/degraded asset behavior. No Dashboard authentication is required.