Справочник публичного API
Все классы, методы и типы с переходами к примерам.
Все публичные классы core и адаптера собраны ниже. Ссылка ведёт к короткому уроку с примером. Импортируем из @gamedevland/cyber-ui; ToolkitComponent, PanelReveal и тип UiViewport — из @gamedevland/cyber-ui-sdk.
Классы и методы
| API | Методы и поля | Применение |
|---|---|---|
TerminalUi | plate, icon, traces, etch, clippedRect | Плашки, знаки, декор и контуры |
TerminalGlass | draw, focus | Стекло и акценты |
PanelSurface | draw | Информационная панель |
ButtonSurface | draw, segmentTrack, toggle | 10 вариантов кнопок и групповые подложки |
ButtonPrice | layout | Измеренная строка подписи и цены |
CyberPreset | palette, triangle, trianglePalette, textEcho, glitch | Замороженные настройки по умолчанию |
BinaryField | draw | Узор по seed и целому кадру |
TriangleLoader | update, draw, outerRadius | Контуры и частицы |
SignalBrackets | draw | Скобки вокруг эмблемы |
TerminalSweep | draw | Сканирование down/right |
TextEcho | update, draw, offset | Сдвиг основного текста и копии |
SurfaceGlitch | show, update, hide | Полосы на живом Graphics |
FaultGlyph | draw | Знак предупреждения |
SignalLost | draw | Экран ошибки и положение подписи |
PanelTransition | origin | Геометрия появления и закрытия |
AnimatedEffect | elapsedSeconds, update, setActive, setReducedMotion, dispose | База времени и lifecycle |
ToolkitComponent | ownEffect, setUiReducedMotion, uiViewport | Компонент адаптера SDK |
PanelReveal | runAction | Действие адаптера SDK |
TriangleLoader, TextEcho и SurfaceGlitch также имеют elapsedSeconds, setActive(), setReducedMotion() и dispose(). Они наследуют общий lifecycle от AnimatedEffect.
Типы и поля
| Тип | Поля / значения |
|---|---|
UiBounds | x, y, w, h |
PanelPalette | surface, edge, accent |
ButtonVariant | primary, module, danger, icon, nav, segment, tab, switch, utility, line |
ButtonSurfaceOptions | width, height, variant, enabled, selected, explicitAccent?, ready? |
ButtonPalette | background, panel, inset, panelEdge, signal, focus, accent, steel, sapphire, text, muted, danger |
TerminalIcon | 27 имён |
TriangleOptions | cycleMs, spinDelayMs, spinDurationMs, layers, layerGap, layerLift, strokeWidth, haloWidth, haloAlpha, echoAlpha, particles, particleSize, particleSpread, particleAlpha, seed |
TrianglePalette | accent, secondary, highlight, text |
TriangleLayout | x, y, radius, scale |
TextEchoOptions | frameMs, cycleMs, shift |
GlitchOptions | durationMs, minDelayMs, spreadMs, seed |
GlitchTarget | surface, x, y, w, h |
BracketOptions | cycleMs, travel, scale, jitter, distanceRatio, maxDistance, halfHeight, bevel, strokeWidth, alpha, peakAlpha, markerSize, markerAlpha |
SignalPalette | background, danger, accent, highlight |
PanelTransitionInput | offset, axis?, pivotX?, pivotY?, closing? |
UiEffect | update, setActive, setReducedMotion, dispose |
UiViewport | width, height, cssWidth, cssHeight, scale |
Общие правила
- Координаты и размеры — локальные логические единицы PixiJS. Поверхности используют левый верхний угол, иконки — центр.
update()принимает секунды; поля*Msи времяSignalBrackets— миллисекунды. ПрогрессTerminalSweep—[0, 1),SignalLost—[0, 1].- Рисование дописывает геометрию. Очищаем слой перед перестроением;
TriangleLoader.draw()сам очищает две выделенные поверхности. - Цвета — числовой RGB. Внешний JSON предварительно проверяем декодером приложения.
- Приложение владеет текстом, layout, вводом, шрифтами, звуком, паузой и reduced motion. Эффекты освобождаем до уничтожения переданных им объектов.