improved type names

ts-lua/readme.md

@@ -1,5 +0,0 @@
-# notes
-
-- all `number` will be classified as `integer` or `float` in the `@remarks` or `@param`/`@returns`
-- `vector` in the docs is represented as a `table` in lua, which is just an `object` in typescript
-- `uint*_t` are `number`, not `Uint*Array`

ts-lua/types/2take1.d.ts

@@ -2,7 +2,7 @@
  * Menu Functions
  * @public
  */
-declare namespace lua2take1 {
+declare namespace type2take1 {
     type Player = number;
     type Entity = number;
     type Ped = number;
@@ -12,4 +12,13 @@ declare namespace lua2take1 {
     type Ptfx = number;
     type Any = number;
     type Thread = number;
+
+    type Feature = number;
+
+    type vector<T> = object;
+    type table<T> = vector<T>;
+    type uint32_t = number;
+    type integer = number;
+    type int = number;
+    type float = number;
 }

ts-lua/types/Menu.d.ts

@@ -1,45 +1,34 @@
+
+
 /**
  * Menu Functions
  * @public
  */
 declare namespace menu {
 
-    /**
-     * @param parent integer
-     */
-    export function add_feature(name: string, type: string, parent: number, script_handler: (feat: Feat) => void): Feat;
+    type featureTypes = "parent"|"toggle"|"action"|"value_i"|"action_value_i"|"autoaction_value_i";
 
-    /**
-     * @param id int
-     */
-    export function delete_feature(id: number): boolean;
+    export function add_feature(name: string, type: featureTypes, parent: type2take1.Feature, script_handler: (feat: Feat) => void): Feat;
+
+    export function delete_feature(id: type2take1.int): boolean;
 
     export function set_menu_can_navigate(): void;
 
     export function get_version(): void;
 
-    /**
-     * @param parent integer
-     */
-    export function add_player_feature(name: string, type: string, parent: number, script_handler: (feat: Feat) => void): PlayerFeat
+    export function add_player_feature(name: string, type: string, parent: type2take1.integer, script_handler: (feat: Feat) => void): PlayerFeat
 
-    /**
-     * @param i uint32_t
-     */
-    export function get_player_feature(i: number): PlayerFeat
+    export function get_player_feature(i: type2take1.uint32_t): PlayerFeat
 
-    /**
-     * @param mode int
-     */
-    export function is_threading_mode(mode: number): boolean
+    export function is_threading_mode(mode: type2take1.int): boolean
 
     /**
      * @privateRemarks callback declaration may be wrong
      */
-    export function create_thread(callback: () => void, context: any): lua2take1.Thread
+    export function create_thread(callback: () => void, context: any): type2take1.Thread
 
-    export function has_thread_finished(id: lua2take1.Thread): boolean
+    export function has_thread_finished(id: type2take1.Thread): boolean
 
-    export function delete_thread(id: lua2take1.Thread): boolean
+    export function delete_thread(id: type2take1.Thread): boolean
 
 }

ts-lua/types/RAGE/ScriptDraw.d.ts

@@ -4,7 +4,20 @@
  */
 declare namespace scriptdraw {
 
-    
+    //void               draw_text(string text, v2 pos, v2 size, float scale, uint32_t color, uint32_t flags)
+    //void               wdraw_text(wstring text, v2 pos, v2 size, float scale, uint32_t color, uint32_t flags)
+    //uint32_t           register_sprite(string path)
+    //void               draw_sprite(uint32_t id, v2 pos, float scale, float rot, uint32_t color)
+    //void               draw_line(v2 start, v2 end, uint32_t size, uint32_t color)
+    //void               draw_rect(v2 pos, v2 size, uint32_t color)
+    //float              pos_pixel_to_rel_x(float in)
+    //float              pos_pixel_to_rel_y(float in)
+    //float              pos_rel_to_pixel_x(float in)
+    //float              pos_rel_to_pixel_y(float in)
+    //float              size_pixel_to_rel_x(float in)
+    //float              size_pixel_to_rel_y(float in)
+    //float              size_rel_to_pixel_x(float in)
+    //float              size_rel_to_pixel_y(float in)
 
 }
 

ts-lua/types/structs/Feat.d.ts

@@ -43,35 +43,27 @@ declare class Feat {
 
     /**
      * value for integer features
-     * 
-     * @remarks integer
      */
-    public get value_i(): number;
-    public set value_i(value_i: number);
+    public get value_i(): type2take1.integer;
+    public set value_i(value_i: type2take1.integer);
 
     /**
      * min value
-     * 
-     * @remarks integer
      */
-    public get min_1(): number;
-    public set min_1(min_1: number);
+    public get min_1(): type2take1.integer;
+    public set min_1(min_1: type2take1.integer);
 
     /**
      * max value
-     * 
-     * @remarks integer
      */
-    public get max_i(): number;
-    public set max_i(max_i: number);
+    public get max_i(): type2take1.integer;
+    public set max_i(max_i: type2take1.integer);
 
     /**
      * step size
-     * 
-     * @remarks integer
      */
-    public get mod_i(): number;
-    public set mod_i(mod_i: number);
+    public get mod_i(): type2take1.integer;
+    public set mod_i(mod_i: type2take1.integer);
 
     /**
      * deprecated
@@ -90,14 +82,12 @@ declare class Feat {
      * @privateRemarks
      * 
      * it's only defined as `any` because I don't understand the d3d handler function enough
-     * 
      */
     public get renderer(): any;
     public set renderer(renderer: any);
 
     /**
-     * show/hide featur
-     * 
+     * show/hide feature
      */
     public get hidden(): boolean;
     public set hidden(hidden: boolean);
@@ -108,10 +98,6 @@ declare class Feat {
     public get data(): any;
     public set data(data: any);
 
-    /**
-     * 
-     * @returns Feat
-     */
     public toggle(): Feat;
 
 }

ts-lua/types/structs/MenuKey.d.ts

@@ -6,15 +6,10 @@ declare class MenuKey {
 
     /**
      * vector of virtual keys
-     * 
-     * @remarks table<uint32_t>
      */
-    readonly keys: object;
+    readonly keys: type2take1.table<type2take1.uint32_t>;
 
-    /**
-     * @param virtualKeyCode uint32_t
-     */
-    public push_vk(virtualKeyCode: number): void;
+    public push_vk(virtualKeyCode: type2take1.uint32_t): void;
 
     public push_str(key: string): boolean;
 

ts-lua/types/structs/RegexResult.d.ts

@@ -27,15 +27,10 @@ declare class RegexResult {
      * @example
      * 
      * new Feat("debug")
-     * 
      */
     constructor(type: "debug");
 
-    /**
-     * 
-     * @remarks integer
-     */
-    readonly count: number;
+    readonly count: type2take1.integer;
 
     readonly matches: string[];