xray16 1.0.7 → 1.0.8

package/types/xr_ui/xr_ui_interface.d.ts

@@ -8,37 +8,63 @@ declare module "xray16" {
     public constructor();
 
     public IsShown(): boolean;
+
     public IsEnabled(): boolean;
+
     public IsAutoDelete(): boolean;
+
     public IsCursorOverWindow(): boolean;
 
     public GetFont(): CGameFont;
+
     public GetHeight(): f32;
+
     public GetWidth(): f32;
+
     public GetWndPos(): vector2;
+
     public GetAbsoluteRect(): Frect;
 
     public SetFont(font: CGameFont): void;
+
     public SetWndSize(vector2: vector2): void;
+
     public SetWndSize(width: f32, height: f32): void;
+
     public SetWindowName(name: string): void;
+
     public SetWndPos(vector2: vector2): void;
+
     public SetWndPos(x1: f32, y1: f32): void;
+
     public SetAutoDelete(auto_delete: boolean): void;
+
     public SetPPMode(): void;
+
     public SetHeight(height: f32): void;
+
     public SetWidth(width: f32): void;
+
     public SetWndRect(rect: Frect): void;
+
     public SetWndRect(x1: f32, y1: f32, x2: f32, y2: f32): void;
 
     public FocusReceiveTime(): u32;
+
     public Init(frect: Frect): void;
+
     public Init(x1: f32, y1: f32, x2: f32, y2: f32): void;
+
     public Enable(is_enabled: boolean): void;
+
     public AttachChild(child: CUIWindow): void;
+
     public DetachChild(child: CUIWindow): void;
+
     public WindowName(): string;
+
     public ResetPPMode(): void;
+
     public Show(show: boolean): void;
   }
 
@@ -52,13 +78,21 @@ declare module "xray16" {
     public static readonly ece_unique_nick_not_registred: 1;
 
     public SetPlayerName(name: string): void;
+
     public SetFilters(filters: SServerFilters): void;
+
     public RefreshList(value: boolean): void;
+
     public SetSortFunc(a: string, b: boolean): void;
+
     public NetRadioChanged(value: boolean): void;
+
     public ShowServerInfo(): void;
+
     public RefreshQuick(): void;
+
     public ConnectToSelected(): void;
+
     public SetConnectionErrCb(cb: connect_error_cb): void;
   }
 
@@ -83,7 +117,9 @@ declare module "xray16" {
    */
   export class CUICheckButton extends CUI3tButton {
     public SetCheck(value: boolean): void;
+
     public GetCheck(): boolean;
+
     public SetDependControl(window: CUIWindow): void;
   }
 
@@ -94,16 +130,27 @@ declare module "xray16" {
    */
   export class CUIComboBox extends CUIWindow {
     public enable_id(id: i32): void;
+
     public disable_id(id: i32): void;
+
     public ClearList(): void;
+
     public SetText(text: string): void;
+
     public AddItem(label: string, id: i32): void;
+
     public GetText(): string;
+
     public SetListLength(length: i32): void;
+
     public CurrentID(): i32;
+
     public GetTextOf(id: i32): string;
+
     public SetCurrentOptValue(): void;
+
     public SetVertScroll(enabled: boolean): void;
+
     public SetCurrentID(id: i32): void;
   }
 
@@ -114,8 +161,11 @@ declare module "xray16" {
    */
   export class CUICustomEdit extends CUIWindow {
     public GetText(): string;
+
     public SetText(text: string): void;
+
     public SetNextFocusCapturer(edit: CUICustomEdit): void;
+
     public CaptureFocus(value: boolean): void;
   }
 
@@ -136,8 +186,11 @@ declare module "xray16" {
 
   export class CUIDialogWnd extends CUIWindow {
     public HideDialog(): void;
+
     public ShowDialog(show: boolean): void;
+
     public GetHolder(): CDialogHolder;
+
     public SetHolder(holder: CDialogHolder): void;
   }
 
@@ -150,19 +203,33 @@ declare module "xray16" {
     public constructor();
 
     public OnKeyboard(key: TXR_DIK_key, event: TXR_ui_event): boolean;
+
     public Update(): void;
+
     public AddCallback(name: string, event: number, cb: (this: void) => void, source?: CUIWindow): void;
+
     public Dispatch(command: number, parameter: number): boolean;
+
     public Register(window: CUIWindow, name: string): void;
+
     public Load(value: string): boolean;
+
     public GetListWnd(id: string): CUIListWnd | null;
+
     public GetDialogWnd(id: string): CUIDialogWnd | null;
+
     public GetEditBox(id: string): CUIEditBox | null;
+
     public GetListBox(id: string): CUIListBox | null;
+
     public GetFrameLineWnd(id: string): CUIFrameLineWnd | null;
+
     public GetTabControl(id: string): CUITabControl | null;
+
     public GetProgressBar(id: string): CUIProgressBar | null;
+
     public GetFrameWindow(id: string): CUIFrameWindow | null;
+
     public GetStatic(id: string): CUIStatic | null;
   }
 
@@ -209,10 +276,15 @@ declare module "xray16" {
    */
   export class CUILines {
     public GetText(): string;
+
     public SetElipsis(value: boolean): void;
+
     public SetFont(value: CGameFont): void;
+
     public SetText(text: string): void;
+
     public SetTextColor(color_code: u32): void;
+
     public SetTextST(text: string): void;
   }
 
@@ -223,18 +295,29 @@ declare module "xray16" {
    */
   export class CUIListBox<T extends CUIListBoxItem = CUIListBoxItem> extends CUIScrollView {
     public GetSize(): u32;
+
     public GetItem(index: u32): CUIWindow;
+
     public GetItemByIndex(index: i32): T;
+
     public GetSelectedIndex(): u32;
+
     public GetSelectedItem(): T | null;
+
     public GetItemHeight(): f32;
 
     public AddExistingItem(item: T): void;
+
     public AddTextItem(text: string): T;
+
     public RemoveItem(window: CUIWindow): void;
+
     public RemoveAll(): void;
+
     public ShowSelectedItem(value: boolean): void;
+
     public SetItemHeight(height: f32): void;
+
     public SetSelectedIndex(index: u32): void;
   }
 
@@ -249,8 +332,11 @@ declare module "xray16" {
     public constructor(target: CUIListBoxItem, height: f32);
 
     public AddIconField(value: f32): CUIStatic;
+
     public SetTextColor(color: u32): void;
+
     public AddTextField(text: string, width: f32): CUITextWnd;
+
     public GetTextItem(): CUITextWnd;
   }
 
@@ -272,7 +358,9 @@ declare module "xray16" {
     public static readonly epi_new_network_game: 2;
 
     public ShowPage(page_id: TXR_MMShniaga_page): void;
+
     public SetPage(page_id: TXR_MMShniaga_page, xml: string, selector: string): void;
+
     public SetVisibleMagnifier(visible: boolean): void;
   }
 
@@ -297,17 +385,29 @@ declare module "xray16" {
    */
   export class CUIMapList extends CUIWindow {
     public ClearList(): void;
+
     public GetCommandLine<T extends string>(value: string): T;
+
     public GetCurGameType(): TXR_GAME_TYPE;
+
     public IsEmpty(): boolean;
+
     public LoadMapList(): void;
+
     public OnModeChange(): void;
+
     public SaveMapList(): void;
+
     public SetMapInfo(info: CUIMapInfo): void;
+
     public SetMapPic(picture: CUIStatic): void;
+
     public SetModeSelector(modeSelector: CUISpinText): void;
+
     public SetServerParams(params: string): void;
+
     public SetWeatherSelector(selector: CUIComboBox): void;
+
     public StartDedicatedServer(): void;
   }
 
@@ -318,7 +418,9 @@ declare module "xray16" {
    */
   export class CUIMessageBox extends CUIStatic {
     public InitMessageBox(value: string): boolean;
+
     public GetPassword(): string;
+
     public GetHost(): string;
   }
 
@@ -329,8 +431,11 @@ declare module "xray16" {
    */
   export class CUIMessageBoxEx extends CUIDialogWnd {
     public InitMessageBox(selector: string): void;
+
     public SetText(text: string): void;
+
     public GetPassword(): string;
+
     public GetHost(): string;
   }
 
@@ -341,8 +446,11 @@ declare module "xray16" {
    */
   export class CUIProgressBar extends CUIWindow {
     public GetRange_max(): f32;
+
     public GetRange_min(): f32;
+
     public SetProgressPos(value: f32): void;
+
     public GetProgressPos(): f32;
   }
 
@@ -359,6 +467,7 @@ declare module "xray16" {
     public Hide(): void;
 
     public Show(show: boolean): void;
+
     public Show(int1: i32, int2: i32): void;
   }
 
@@ -371,8 +480,11 @@ declare module "xray16" {
     public constructor();
 
     public GetItemsCount(): u64;
+
     public SwitchToSelectedVersion(): void;
+
     public GetCurrentVersionDescr(): string;
+
     public GetCurrentVersionName(): string;
   }
 
@@ -383,14 +495,23 @@ declare module "xray16" {
    */
   export class CUIScrollView extends CUIWindow {
     public SetScrollPos(position: i32): void;
+
     public RemoveWindow(window: CUIWindow): void;
+
     public ScrollToBegin(): void;
+
     public GetCurrentScrollPos(): i32;
+
     public AddWindow(window: CUIWindow, value: boolean): void;
+
     public GetMaxScrollPos(): i32;
+
     public GetMinScrollPos(): i32;
+
     public ScrollToEnd(): void;
+
     public Clear(): void;
+
     public SetFixedScrollBar(fixed: boolean): void;
   }
 
@@ -429,29 +550,53 @@ declare module "xray16" {
    */
   export class CUIStatic extends CUIWindow {
     public GetColor(): u32;
+
     public TextControl(): CUILines;
+
     public GetTextureRect(): Frect;
+
     public GetStretchTexture(): boolean;
+
     public SetStretchTexture(stretch: boolean): void;
+
     public SetTextureRect(frect: Frect): void;
+
     public InitTexture(texture: string): void;
+
     public SetTextColor(r: i32, g: i32, b: i32, a: i32): void;
+
     public SetHeading(number: f32): void;
+
     public SetTextST(string: string): void;
+
     public SetTextAlign(align: u32): void;
+
     public GetTextAlign(): u32;
+
     public GetText(): string;
+
     public InitTextureEx(first: string, second: string): void;
+
     public SetTextX(x: f32): void;
+
     public SetTextY(x: f32): void;
+
     public GetTextY(x: f32): void;
+
     public GetTextX(): f32;
+
     public SetTextureOffset(x: f32, y: f32): void;
+
     public SetColor(color: u32): void;
+
     public SetElipsis(a: i32, b: i32): void;
+
     public GetHeading(): f32;
+
     public SetText(text: string): void;
+
     public GetOriginalRect(): Frect;
+
     public SetOriginalRect(frect: Frect): void;
   }
 
@@ -469,16 +614,27 @@ declare module "xray16" {
    */
   export class CUITabControl extends CUIWindow {
     public GetActiveId(): string;
+
     public SetActiveTab(id: string): void;
+
     public SetActiveTab(id: u32): void;
+
     public GetTabsCount(): u32;
+
     public GetButtonById(id: string): CUITabButton;
+
     public RemoveAll(): void;
+
     public AddItem(item: CUITabButton): void;
+
     public AddItem(id: string, name: string, top_left: vector2, bot_right: vector2): void;
+
     public RemoveItem(id: string): void;
+
     public GetButtonByIndex(index: u32): CUITabButton;
+
     public SetNewActiveTab(index: u32): void;
+
     public GetActiveIndex(): i32;
   }
 
@@ -489,16 +645,27 @@ declare module "xray16" {
    */
   export class CUITextWnd extends CUIWindow {
     public SetTextOffset(x: f32, y: f32): void;
+
     public SetText(text: string): void;
+
     public SetTextAlignment(align: TXR_CGameFont_alignment): void;
+
     public SetTextComplexMode(complex: boolean): void;
+
     public GetText(): string;
+
     public GetTextColor(): u32;
+
     public SetTextColor(color: u32): void;
+
     public SetTextST(text: string): void;
+
     public AdjustHeightToText(): void;
+
     public AdjustWidthToText(): void;
+
     public SetEllipsis(value: boolean): void;
+
     public SetVTextAlignment(alignment: TXR_CGameFont_alignment): void;
   }
 
@@ -509,13 +676,21 @@ declare module "xray16" {
    */
   export class CUITrackBar extends CUIWindow {
     public SetCheck(value: boolean): void;
+
     public SetCurrentValue(): void;
+
     public SetCurrentValue(value: f32): void;
+
     public SetCurrentValue(value: i32): void;
+
     public GetCheck(): boolean;
+
     public GetIValue(): i32;
+
     public GetFValue(): f32;
+
     public SetOptIBounds(min: i32, max: i32): void;
+
     public SetOptFBounds(min: f32, max: f32): number;
   }
 
@@ -526,10 +701,15 @@ declare module "xray16" {
    */
   export class CDialogHolder {
     public RemoveDialogToRender(window: CUIWindow): void;
+
     public AddDialogToRender(window: CUIWindow): void;
+
     public TopInputReceiver(): CUIDialogWnd;
+
     public SetMainInputReceiver(window: CUIDialogWnd, find_remove: boolean): boolean;
+
     public MainInputReceiver(): CUIDialogWnd;
+
     public start_stop_menu(window: CUIWindow, value: boolean): void;
   }
 
@@ -544,12 +724,15 @@ declare module "xray16" {
     private constructor();
 
     public Draw(): void;
+
     public Update(): void;
 
     public IsActual(): boolean;
+
     public SetText(text: string): void;
 
     public destroy(): void;
+
     public wnd(): CUIStatic;
   }
 
@@ -560,26 +743,47 @@ declare module "xray16" {
    */
   export class CUIListWnd extends CUIWindow {
     public SetVertFlip(flip: boolean): void;
+
     public RemoveItem(index: i32): void;
+
     public ScrollToPos(position: i32): void;
+
     public ShowSelectedItem(show: boolean): void;
+
     public EnableScrollBar(enable: boolean): void;
+
     public GetItem(index: i32): CUIListItem;
+
     public GetVertFlip(): boolean;
+
     public SetTextColor(color: i32): void;
+
     public GetSelectedItem(): i32;
+
     public ScrollToEnd(): void;
+
     public SetFocusedItem(index: i32): void;
+
     public ActivateList(flag: boolean): void;
+
     public GetSize(): i32;
+
     public IsScrollBarEnabled(): boolean;
+
     public ScrollToBegin(): void;
+
     public RemoveAll(): void;
+
     public AddItem(item: CUIListItem): boolean;
+
     public SetItemHeight(height: f32): void;
+
     public GetItemPos(item: CUIListItem): i32;
+
     public IsListActive(): boolean;
+
     public GetFocusedItem(): i32;
+
     public ResetFocusCapture(): void;
   }
 
@@ -608,6 +812,7 @@ declare module "xray16" {
     public constructor();
 
     public GetHintText(): string;
+
     public SetHintText(hint: string): void;
   }
 
@@ -620,7 +825,9 @@ declare module "xray16" {
     public constructor();
 
     public SetActiveSubdialog(section: string): void;
+
     public GetActiveSection(): string;
+
     public GetTabControl(): CUITabControl;
   }
 
@@ -633,12 +840,15 @@ declare module "xray16" {
     public constructor();
 
     public get_drag_item(): game_object | null;
+
     public highlight_section_in_slot(section: string, type: TXR_EDDListType, slot_id: u16): void;
+
     public highlight_for_each_in_slot(
       functor: (object: game_object) => boolean,
       type: TXR_EDDListType,
       slot_id: u16
     ): void;
+
     public refresh_current_cell_item(): void;
   }
 
@@ -662,5 +872,8 @@ declare module "xray16" {
     private constructor();
   }
 
+  /**
+   * @group xr_ui_interface
+   */
   export type TXR_EDDListType = EnumeratedStaticsValues<typeof EDDListType>;
 }