xray16 1.3.2 → 1.4.0

package/types/xr_lib/xr_properties.d.ts

@@ -1,166 +1,455 @@
-declare module "xray16" {
-  /**
-   * @source C++ class token
-   * @customConstructor token
-   * @group xr_properties
-   */
-  export class token {
-    public id: i32;
-    public name: string;
-
-    private constructor();
-  }
-
-  /**
-   * @source C++ class rtoken_list
-   * @customConstructor rtoken_list
-   * @group xr_properties
-   */
-  export class rtoken_list {
-    public constructor();
-
-    public remove(index: u32): void;
-
-    public get(index: u32): string;
-
-    public count(): u32;
-
-    public add(token: string): void;
-
-    public clear(): void;
-  }
-
-  /**
-   * @source C++ class token_list
-   * @customConstructor token_list
-   * @group xr_properties
-   */
-  export class token_list {
-    public constructor();
-
-    public remove(token: string): void;
-
-    public id(token: string): i32;
-
-    public name(int: i32): string;
-
-    public add(token: string, index: i32): void;
-
-    public clear(): void;
-  }
-
-  /**
-   * @source C++ class properties_list_helper
-   * @customConstructor properties_list_helper
-   * @group xr_properties
-   */
-  export class properties_list_helper extends EngineBinding {
-    public create_vangle(): unknown;
-
-    public create_angle(): unknown;
-
-    public create_time(): unknown;
-
-    public create_color(): unknown;
-
-    public create_vcolor(): unknown;
-
-    public create_fcolor(): unknown;
-
-    public create_list(): unknown;
-
-    public create_token8(): unknown;
-
-    public create_token16(): unknown;
-
-    public create_token32(): unknown;
-
-    public create_flag8(): unknown;
-
-    public create_flag16(): unknown;
-
-    public create_flag32(): unknown;
-
-    public create_vector(): unknown;
-
-    public create_bool(
-      items: LuaTable<number>,
-      path: string,
-      object: cse_abstract,
-      value: unknown,
-      id: number | string
-    ): boolean;
-
-    public create_float(): unknown;
-
-    public create_u8(): unknown;
-
-    public create_u16(): unknown;
-
-    public create_u32(): unknown;
-
-    public create_s32(): unknown;
-
-    public create_s16(): unknown;
-
-    public create_choose(): unknown;
-
-    public create_button(): unknown;
-
-    public create_canvas(): unknown;
-
-    public create_caption(): unknown;
-
-    public float_on_after_edit(): unknown;
-
-    public float_on_before_edit(): unknown;
-
-    public name_after_edit(): unknown;
-
-    public name_before_edit(): unknown;
-
-    public vector_on_before_edit(): unknown;
-
-    public vector_on_after_edit(): unknown;
-  }
-
-  /**
-   * @source C++ class properties_helper
-   * @customConstructor properties_helper
-   * @group xr_properties
-   */
-  export class properties_helper extends properties_list_helper {}
-
-  /**
-   * @source C++ class prop_value
-   * @customConstructor prop_value
-   * @group xr_properties
-   */
-  export class prop_value {
-    public token16_value(): unknown;
-
-    public flag32_value(): unknown;
-
-    public text_value(): unknown;
-
-    public bool_value(): unknown;
-
-    public u16_value(): unknown;
-
-    public s16_value(): unknown;
-    public button_value(): unknown;
-
-    public caption_value(): unknown;
-  }
-
-  /**
-   * @source C++ class TEX_INFO
-   * @customConstructor TEX_INFO
-   * @group xr_properties
-   */
-  export class TEX_INFO {
-    public get_rect(): Frect;
-
-    public get_file_name(): string;
-  }
-}
+declare module "xray16" {
+  /**
+   * Named integer token used by editor property lists.
+   *
+   * @source C++ class token
+   * @customConstructor token
+   * @group xr_properties
+   */
+  export class token {
+    /**
+     * Numeric value stored for this token.
+     */
+    public id: i32;
+
+    /**
+     * Display name used in editor lists.
+     */
+    public name: string;
+
+    private constructor();
+  }
+
+  /**
+   * Ordered list of string tokens for runtime-selectable editor values.
+   *
+   * @source C++ class rtoken_list
+   * @customConstructor rtoken_list
+   * @group xr_properties
+   */
+  export class rtoken_list {
+    /**
+     * Create an empty token list.
+     */
+    public constructor();
+
+    /**
+     * Remove token by zero-based index.
+     *
+     * @param index - Token index.
+     */
+    public remove(index: u32): void;
+
+    /**
+     * Get token text by zero-based index.
+     *
+     * @param index - Token index.
+     * @returns Token text.
+     */
+    public get(index: u32): string;
+
+    /**
+     * Get number of tokens in the list.
+     *
+     * @returns Token count.
+     */
+    public count(): u32;
+
+    /**
+     * Append a token.
+     *
+     * @param token - Token text.
+     */
+    public add(token: string): void;
+
+    /**
+     * Remove all tokens.
+     */
+    public clear(): void;
+  }
+
+  /**
+   * Name-to-id token list for editor dropdown values.
+   *
+   * @source C++ class token_list
+   * @customConstructor token_list
+   * @group xr_properties
+   */
+  export class token_list {
+    /**
+     * Create an empty token list.
+     */
+    public constructor();
+
+    /**
+     * Remove token by text.
+     *
+     * @param token - Token text.
+     */
+    public remove(token: string): void;
+
+    /**
+     * Find numeric id for a token.
+     *
+     * @param token - Token text.
+     * @returns Token id, or engine-defined missing value.
+     */
+    public id(token: string): i32;
+
+    /**
+     * Find token text by numeric id.
+     *
+     * @param id - Token id.
+     * @returns Token text.
+     */
+    public name(id: i32): string;
+
+    /**
+     * Add a token/id pair.
+     *
+     * @param token - Token text.
+     * @param id - Numeric token id.
+     */
+    public add(token: string, id: i32): void;
+
+    /**
+     * Remove all tokens.
+     */
+    public clear(): void;
+  }
+
+  /**
+   * Helper for building editor property rows for spawned objects.
+   *
+   * @source C++ class properties_list_helper
+   * @customConstructor properties_list_helper
+   * @group xr_properties
+   */
+  export class properties_list_helper extends EngineBinding {
+    /**
+     * Create a 3-axis angle property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_vangle(): unknown;
+
+    /**
+     * Create an angle property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_angle(): unknown;
+
+    /**
+     * Create a time property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_time(): unknown;
+
+    /**
+     * Create a color property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_color(): unknown;
+
+    /**
+     * Create a vector color property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_vcolor(): unknown;
+
+    /**
+     * Create a float color property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_fcolor(): unknown;
+
+    /**
+     * Create a runtime token list property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_list(): unknown;
+
+    /**
+     * Create an 8-bit token property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_token8(): unknown;
+
+    /**
+     * Create a 16-bit token property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_token16(): unknown;
+
+    /**
+     * Create a 32-bit token property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_token32(): unknown;
+
+    /**
+     * Create an 8-bit flag property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_flag8(): unknown;
+
+    /**
+     * Create a 16-bit flag property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_flag16(): unknown;
+
+    /**
+     * Create a 32-bit flag property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_flag32(): unknown;
+
+    /**
+     * Create a vector property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_vector(): unknown;
+
+    /**
+     * Create a boolean property bound to an object field.
+     *
+     * @param items - Property item list to append to.
+     * @param path - Property path or caption.
+     * @param object - Spawn object owning the property.
+     * @param value - Property storage descriptor.
+     * @param id - Field identifier used by the editor bridge.
+     * @returns Whether the property was created.
+     */
+    public create_bool(
+      items: LuaTable<number>,
+      path: string,
+      object: cse_abstract,
+      value: unknown,
+      id: number | string
+    ): boolean;
+
+    /**
+     * Create a float property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_float(): unknown;
+
+    /**
+     * Create an unsigned 8-bit integer property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_u8(): unknown;
+
+    /**
+     * Create an unsigned 16-bit integer property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_u16(): unknown;
+
+    /**
+     * Create an unsigned 32-bit integer property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_u32(): unknown;
+
+    /**
+     * Create a signed 32-bit integer property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_s32(): unknown;
+
+    /**
+     * Create a signed 16-bit integer property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_s16(): unknown;
+
+    /**
+     * Create an asset/object chooser property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_choose(): unknown;
+
+    /**
+     * Create a button property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_button(): unknown;
+
+    /**
+     * Create a custom canvas property.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_canvas(): unknown;
+
+    /**
+     * Create a read-only caption row.
+     *
+     * @returns Engine property value handle.
+     */
+    public create_caption(): unknown;
+
+    /**
+     * Callback used after editing a float property.
+     *
+     * @returns Engine callback result.
+     */
+    public float_on_after_edit(): unknown;
+
+    /**
+     * Callback used before editing a float property.
+     *
+     * @returns Engine callback result.
+     */
+    public float_on_before_edit(): unknown;
+
+    /**
+     * Callback used after editing an object name.
+     *
+     * @returns Engine callback result.
+     */
+    public name_after_edit(): unknown;
+
+    /**
+     * Callback used before editing an object name.
+     *
+     * @returns Engine callback result.
+     */
+    public name_before_edit(): unknown;
+
+    /**
+     * Callback used before editing a vector property.
+     *
+     * @returns Engine callback result.
+     */
+    public vector_on_before_edit(): unknown;
+
+    /**
+     * Callback used after editing a vector property.
+     *
+     * @returns Engine callback result.
+     */
+    public vector_on_after_edit(): unknown;
+  }
+
+  /**
+   * Global editor properties helper.
+   *
+   * @source C++ class properties_helper
+   * @customConstructor properties_helper
+   * @group xr_properties
+   * @remarks Only available when the editor property helper library is loaded.
+   */
+  export class properties_helper extends properties_list_helper {}
+
+  /**
+   * Base editor property value wrapper.
+   *
+   * @source C++ class prop_value
+   * @customConstructor prop_value
+   * @group xr_properties
+   */
+  export class prop_value {
+    /**
+     * Treat this property value as a 16-bit token value.
+     *
+     * @returns Engine property value handle.
+     */
+    public token16_value(): unknown;
+
+    /**
+     * Treat this property value as a 32-bit flag value.
+     *
+     * @returns Engine property value handle.
+     */
+    public flag32_value(): unknown;
+
+    /**
+     * Treat this property value as text.
+     *
+     * @returns Engine property value handle.
+     */
+    public text_value(): unknown;
+
+    /**
+     * Treat this property value as a boolean.
+     *
+     * @returns Engine property value handle.
+     */
+    public bool_value(): unknown;
+
+    /**
+     * Treat this property value as an unsigned 16-bit integer.
+     *
+     * @returns Engine property value handle.
+     */
+    public u16_value(): unknown;
+
+    /**
+     * Treat this property value as a signed 16-bit integer.
+     *
+     * @returns Engine property value handle.
+     */
+    public s16_value(): unknown;
+
+    /**
+     * Treat this property value as a button.
+     *
+     * @returns Engine property value handle.
+     */
+    public button_value(): unknown;
+
+    /**
+     * Treat this property value as a caption.
+     *
+     * @returns Engine property value handle.
+     */
+    public caption_value(): unknown;
+  }
+
+  /**
+   * Texture atlas entry exposed by UI texture metadata.
+   *
+   * @source C++ class TEX_INFO
+   * @customConstructor TEX_INFO
+   * @group xr_properties
+   */
+  export class TEX_INFO {
+    /**
+     * Get rectangle occupied by this texture in the atlas.
+     *
+     * @returns Texture rectangle.
+     */
+    public get_rect(): Frect;
+
+    /**
+     * Get source texture file name.
+     *
+     * @returns Texture file name.
+     */
+    public get_file_name(): string;
+  }
+}