Skip to main content

Enum

Enum is a utility module providing predefined constants for various purposes. These constants simplify coding by replacing magic strings or numbers with descriptive identifiers.

Enum
Utility
Read-only
​

Enum is a read-only module, meaning its values cannot be changed.

WindowStyle​

  • Predefined window styles for creating and managing windows.
  • Dialog — The default, a resizable dialog.
  • Fixed — A fixed size dialog.
  • Float — A tiny floating window.
  • Single — Fixed size with system menu (minimizable).
  • Raw — Fixed size without title bar or borders.

EasingStyle​

  • Predefined easing styles for TweenService.

CursorStyle​

  • Predefined mouse cursor types.
  • Arrow — Default Windows cursor.
  • Cross — Crosshair.
  • Working — Arrow with small hourglass.
  • Hand — Hand pointer.
  • Help — Arrow with question mark.
  • IBeam — Text cursor.
  • Forbidden — Slashed circle.
  • Cardinal — Four-pointed arrow.
  • Horizontal — Double-pointed right-left.
  • Vertical — Double-pointed up-down.
  • LeftDiagonal — Top-right to bottom-left.
  • RightDiagonal — Top-left to bottom-right.
  • Up — Arrow up.
  • Wait — Hourglass.
  • None — No cursor displayed.

WindowAlign​

  • Predefined alignment options for windows relative to their parent.
    • All — Aligned along all borders.
    • Bottom — Aligned to bottom.
    • Top — Aligned to top.
    • Right — Aligned to right.
    • Left — Aligned to left.

IconStyle​

  • Predefined icons for notifications.
    • Window — Use current window icon (default).
    • None — No icon.
    • Info — Information icon.
    • Warning — Warning icon.
    • Error — Error icon.

InputType​

  • Types of input events.
  • Keyboard
  • Mouse

VirtualKeyCodes​

  • Predefined virtual key codes for keyboard and mouse.
    • Mouse — LBUTTON, RBUTTON, MBUTTON, XBUTTON1, XBUTTON2
    • Key — Standart keyboard keys.

Check the VirtualKeyCodes documentation for more details.

Check the LuaRT Supported Keys documentation for more details.

FontStyle​

Font style constants for UI text.

  • Normal
  • Italic
  • Oblique