xray16 1.0.0

package/src/xr_ui/README.md

@@ -0,0 +1,277 @@
+# 🏀 C_UI
+
+Base classes bindings to work with UI interface elements.
+
+## 🧩 C_UI_CORE
+
+Core classes for work with UI elements.
+
+## 🧩 C_XML
+
+Base classes for work with xml parsing.
+
+## 🧩 C_UI_INTERFACE
+
+Base classes for creation of UI elements and windows.
+
+### 🧱 CUIWindow
+
+<p>
+Base element for representation of nested components. Basically grid.
+</p>
+
+### 🧱 CUIStatic
+
+<p>
+Any static element in ui that represents simple label, animation or image.
+Example: main menu background.
+</p>
+
+<img src="demo\CUIStatic.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIButton
+
+<p>
+Base button core with logic, normally 'CUI3tButton' is preferred (?).
+</p>
+
+### 🧱 CUI3tButton
+
+<p>
+Generic button element used everywhere, from settings to different modal windows.
+Example: any action button.
+</p>
+
+<img src="demo\CUI3tButton.png" alt="screenshot" width="200"/>
+
+### 🧱 CUICheckButton
+
+<p>
+Generic checkbox button for settings true/false values.
+Example: settings options.
+</p>
+
+### 🧱 CUIComboBox
+
+<p>
+Generic combobox with list of items for selection.
+Example: settings selection.
+</p>
+
+<img src="demo\CUIComboBox.png" alt="screenshot" width="400"/>
+
+### 🧱 CUICustomEdit
+
+<p>
+Generic component with text or number input.
+Example: login inputs for multiplayer, cd key input.
+</p>
+
+<img src="demo\CUICustomEdit.png" alt="screenshot" width="600"/>
+
+### 🧱 CUICustomSpin
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUICustomSpin.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIDialogWnd
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIDialogWnd.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIScriptWnd
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIScriptWnd.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIEditBox
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIEditBox.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIFrameLineWnd
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIFrameLineWnd.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIFrameWindow
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIFrameWindow.png" alt="screenshot" width="600"/>
+
+### 🧱 CUILines
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUILines.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIListBox
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIListBox.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIListBoxItem
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIListBoxItem.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIListBoxItemMsgChain
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIListBoxItemMsgChain.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIMMShniaga
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIMMShniaga.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIMapInfo
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIMapInfo.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIMapList
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIMapList.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIMessageBox
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIMessageBox.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIProgressBar
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIProgressBar.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIPropertiesBox
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIPropertiesBox.png" alt="screenshot" width="600"/>
+
+### 🧱 CUIScrollView
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUIScrollView.png" alt="screenshot" width="600"/>
+1
+### 🧱 CUISleepStatic
+<p>
+todo;
+</p>
+
+<img src="demo\CUISleepStatic.png" alt="screenshot" width="600"/>
+
+### 🧱 CUISpinFlt
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUISpinFlt.png" alt="screenshot" width="600"/>
+
+### 🧱 CUISpinNum
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUISpinNum.png" alt="screenshot" width="600"/>
+
+### 🧱 CUISpinText
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUISpinText.png" alt="screenshot" width="600"/>
+
+### 🧱 CUITabButton
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUITabButton.png" alt="screenshot" width="600"/>
+
+### 🧱 CUITabControl
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUITabControl.png" alt="screenshot" width="600"/>
+
+### 🧱 CUITrackBar
+
+<p>
+Generic slider used for settings adjustments. Useful to set configs in specific range.
+</p>
+
+<img src="demo\CUITrackBar.png" alt="screenshot" width="600"/>
+
+### 🧱 CUITextWnd
+
+<p>
+todo;
+</p>
+
+<img src="demo\CUITextWnd.png" alt="screenshot" width="600"/>
+
+### 🧱 CServerList
+
+<p>
+Default UI modal element for multiplayer list of servers display.
+</p>
+
+<img src="demo\CServerList.png" alt="screenshot" width="600"/>

package/src/xr_ui/xr_ui_core.d.ts

@@ -0,0 +1,185 @@
+declare module "xray16" {
+  /**
+   * @source C++ class COptionsManager
+   * @customConstructor COptionsManager
+   * @group xr_ui_core
+   */
+  export class COptionsManager {
+    public constructor();
+
+    public SendMessage2Group(group: string, message: string): void;
+    public UndoGroup(group: string): void;
+    public SaveBackupValues(group: string): void;
+    public IsGroupChanged(group: string): boolean;
+    public SaveValues(group: string): void;
+    public SetCurrentValues(group: string): void;
+    public NeedSystemRestart(): boolean;
+    public NeedVidRestart(): boolean;
+    public OptionsPostAccept(): void;
+  }
+
+  /**
+   * @source C++ class CMainMenu
+   * @customConstructor CMainMenu
+   * @group xr_ui_core
+   */
+  export class CMainMenu {
+    public GetCDKey(): string;
+    public GetAccountMngr(): account_manager;
+    public GetDemoInfo(fileName: string): demo_info | null;
+    public GetPatchProgress(): Patch_Dawnload_Progress;
+    public GetProfileStore(): profile_store;
+    public GetGSVer(): string;
+    public GetLoginMngr(): login_manager;
+    public GetPlayerName(): string;
+    public CancelDownload(): void;
+    public ValidateCDKey(): boolean;
+  }
+
+  /**
+   * @source C++ class CUIGameCustom
+   * @customConstructor CUIGameCustom
+   * @group xr_ui_core
+   */
+  export class CUIGameCustom {
+    public AddCustomStatic(id: string, b: boolean): StaticDrawableWrapper;
+    public AddCustomStatic(id: string, b: boolean, n: f32): StaticDrawableWrapper;
+    public AddDialogToRender(window: CUIWindow): void;
+    public CurrentItemAtCell(): game_object;
+    public GetCustomStatic(value: string): StaticDrawableWrapper | null;
+    public HideActorMenu(): void;
+    public ShowActorMenu(): boolean;
+    public HidePdaMenu(): void;
+    public RemoveCustomStatic(id: string): void;
+    public RemoveDialogToRender(window: CUIWindow): void;
+    public UpdateActorMenu(): void;
+    public enable_fake_indicators(enabled: boolean): void;
+    public hide_messages(): void;
+    public show_messages(): void;
+    public update_fake_indicators(u8: number, enabled: boolean): void;
+    public update_fake_indicators(u8: number, value: f32): void;
+  }
+
+  /**
+   * @source C++ class CScriptXmlInit
+   * @customConstructor CScriptXmlInit
+   * @group xr_ui_core
+   */
+  export class CScriptXmlInit {
+    public constructor();
+
+    public ParseFile(path: string): void;
+    public ParseShTexInfo(path: string): void;
+
+    public Init3tButton(selector: string, window: CUIWindow | null): CUI3tButton;
+    public InitAnimStatic(selector: string, window: CUIWindow | null): CUIStatic;
+    public InitCDkey(selector: string, window: CUIWindow | null): CUIEditBox;
+    public InitCheck(selector: string, window: CUIWindow | null): CUICheckButton;
+    public InitComboBox(selector: string, window: CUIWindow | null): CUIComboBox;
+    public InitEditBox(selector: string, window: CUIWindow | null): CUIEditBox;
+    public InitFrame(selector: string, window: CUIWindow | null): CUIFrameWindow;
+    public InitFrameLine(selector: string, window: CUIWindow | null): CUIFrameLineWnd;
+    public InitKeyBinding(selector: string, window: CUIWindow | null): CUIWindow;
+    public InitLabel(selector: string, window: CUIWindow | null): CUIStatic;
+    public InitList(selector: string, window: CUIWindow | null): CUIListWnd;
+    public InitListBox<T extends CUIListBoxItem = CUIListBoxItem>(
+      selector: string,
+      window: CUIWindow | null
+    ): CUIListBox<T>;
+    public InitMMShniaga(selector: string, window: CUIWindow | null): CUIMMShniaga;
+    public InitMPPlayerName(selector: string, window: CUIWindow | null): CUIEditBox;
+    public InitMapInfo(selector: string, window: CUIWindow | null): CUIMapInfo;
+    public InitMapList(selector: string, window: CUIWindow | null): CUIMapList;
+    public InitProgressBar(selector: string, window: CUIWindow | null): CUIProgressBar;
+    public InitScrollView(selector: string, window: CUIWindow | null): CUIScrollView;
+    public InitServerList(selector: string, window: CUIWindow | null): CServerList;
+    public InitSleepStatic(selector: string, window: CUIWindow | null): CUISleepStatic;
+    public InitSpinFlt(selector: string, window: CUIWindow | null): CUISpinFlt;
+    public InitSpinNum(selector: string, window: CUIWindow | null): CUISpinNum;
+    public InitSpinText(selector: string, window: CUIWindow | null): CUISpinText;
+    public InitStatic(selector: string, window: CUIWindow | null): CUIStatic;
+    public InitTab(selector: string, window: CUIWindow | null): CUITabControl;
+    public InitTextWnd(selector: string, window: CUIWindow | null): CUITextWnd;
+    public InitTrackBar(selector: string, window: CUIWindow | null): CUITrackBar;
+    public InitVerList(selector: string, window: CUIWindow | null): CUIVersionList;
+    public InitWindow(selector: string, index: i32, window: CUIWindow | null): void;
+  }
+
+  /**
+   * @source C++ class UIStyleManager
+   * @customConstructor UIStyleManager
+   * @group xr_ui_core
+   */
+  export class UIStyleManager {
+    private constructor();
+
+    public GetAllStyles(): LuaIterable<token>;
+    public DefaultStyleIsSet(): boolean;
+    public GetCurrentStyleId(): u32;
+    public SetStyle(id: u32, reload_ui?: boolean): void;
+  }
+
+  /**
+   * @source C++ class CGameFont
+   * @customConstructor CGameFont
+   * @group xr_ui_core
+   */
+  export class CGameFont {
+    public static readonly alCenter: 2;
+    public static readonly alLeft: 0;
+    public static readonly alRight: 1;
+
+    private constructor();
+  }
+
+  /**
+   * EVTextAlignment.
+   *
+   * @group xr_ui_core
+   */
+  export type TXR_CGameFont_alignment = EnumeratedStaticsValues<typeof CGameFont>;
+
+  /**
+   * @source C++ class ui_events
+   * @customConstructor ui_events
+   * @group xr_ui_core
+   */
+  export class ui_events {
+    public static readonly BUTTON_CLICKED: 19;
+    public static readonly BUTTON_DOWN: 20;
+    public static readonly CHECK_BUTTON_RESET: 23;
+    public static readonly CHECK_BUTTON_SET: 22;
+    public static readonly EDIT_TEXT_COMMIT: 79;
+    public static readonly LIST_ITEM_CLICKED: 37;
+    public static readonly LIST_ITEM_SELECT: 38;
+    public static readonly LIST_ITEM_UNSELECT: 39;
+    public static readonly MAIN_MENU_RELOADED: 84;
+    public static readonly MESSAGE_BOX_CANCEL_CLICKED: 47;
+    public static readonly MESSAGE_BOX_COPY_CLICKED: 48;
+    public static readonly MESSAGE_BOX_NO_CLICKED: 46;
+    public static readonly MESSAGE_BOX_OK_CLICKED: 42;
+    public static readonly MESSAGE_BOX_QUIT_GAME_CLICKED: 45;
+    public static readonly MESSAGE_BOX_QUIT_WIN_CLICKED: 44;
+    public static readonly MESSAGE_BOX_YES_CLICKED: 43;
+    public static readonly PROPERTY_CLICKED: 41;
+    public static readonly RADIOBUTTON_SET: 24;
+    public static readonly SCROLLBAR_HSCROLL: 34;
+    public static readonly SCROLLBAR_VSCROLL: 33;
+    public static readonly SCROLLBOX_MOVE: 32;
+    public static readonly TAB_CHANGED: 21;
+    public static readonly WINDOW_KEYBOARD_CAPTURE_LOST: 16;
+    public static readonly WINDOW_KEY_PRESSED: 12;
+    public static readonly WINDOW_KEY_RELEASED: 13;
+    public static readonly WINDOW_LBUTTON_DB_CLICK: 11;
+    public static readonly WINDOW_LBUTTON_DOWN: 0;
+    public static readonly WINDOW_LBUTTON_UP: 3;
+    public static readonly WINDOW_MOUSE_MOVE: 6;
+    public static readonly WINDOW_RBUTTON_DOWN: 1;
+    public static readonly WINDOW_RBUTTON_UP: 4;
+  }
+
+  /**
+   * @group xr_ui_core
+   */
+  type TXR_ui_event = EnumeratedStaticsValues<typeof ui_events>;
+}