Skip to content

Commit

Permalink
Updated typed definitions for MTASA 1.5.9
Browse files Browse the repository at this point in the history
  • Loading branch information
Toliak committed Nov 23, 2021
1 parent b433e2b commit 5a34ec4
Show file tree
Hide file tree
Showing 125 changed files with 572 additions and 490 deletions.
1 change: 1 addition & 0 deletions client/event/browser.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/colshape.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/element.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/input.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/marker.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/object.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/other.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/ped.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/pickup.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/player.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/projectile.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/resource.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/sound.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/vehicle.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/event/weapon.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
21 changes: 11 additions & 10 deletions client/function/audio.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down Expand Up @@ -108,10 +109,10 @@ export declare function getSoundBufferLength(theSound: Element): number;

/**
* @see https://wiki.multitheftauto.com/wiki/GetSoundEffectParameters
* @param sound : the sound element.
* @param effectName : the name of the effect whose parameters you want to retrieve.
* @param sound : The sound element to get the sound effect parameters of.
* @param effectName : The name of the effect whose parameters you want to retrieve:
* @return returns a table with the parameter names as the keys, and their values. if the specified
* effect name is not valid, an error is raised.
* effect name is not valid, false is returned.
* @noSelf
*/
export declare function getSoundEffectParameters(
Expand Down Expand Up @@ -292,7 +293,7 @@ export declare function getSoundWaveData(
/**
* @see https://wiki.multitheftauto.com/wiki/IsSoundLooped
* @param theSound The sound element which you want to get the loop state.
* @return returns true if the sound element is seted to loop, false otherwise.
* @return returns true if the sound element is looped, false otherwise.
* @noSelf
*/
export declare function isSoundLooped(theSound: Element): boolean;
Expand Down Expand Up @@ -485,11 +486,11 @@ export declare function setSoundEffectEnabled(

/**
* @see https://wiki.multitheftauto.com/wiki/SetSoundEffectParameter
* @param sound : the sound element.
* @param effectName : the name of the effect whose parameter you want to change.
* @param effectParam : the parameter #Effects Parameters|name.
* @param paramValue : the parameter #Effects Parameters|value.
* @return returns true if everything went well, error is raised otherwise.
* @param sound : The sound element.
* @param effectName : The name of the effect whose parameter you want to change:
* @param effectParam : The parameter #Effects Parameters|name.
* @param paramValue : The parameter #Effects Parameters|value.
* @return returns true if effect have been set successfully, false otherwise.
* @noSelf
*/
export declare function setSoundEffectParameter(
Expand All @@ -503,7 +504,7 @@ export declare function setSoundEffectParameter(
* @see https://wiki.multitheftauto.com/wiki/SetSoundLooped
* @param theSound The sound element to set the loop.
* @param bool A boolean representing whether the sound will be looped.
* @return returns true if the sound element loop was successfully changed, false otherwise.
* @return returns true if the sound element loop state was successfully changed, false otherwise.
* @noSelf
*/
export declare function setSoundLooped(
Expand Down
1 change: 1 addition & 0 deletions client/function/blip.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
9 changes: 9 additions & 0 deletions client/function/browser.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down Expand Up @@ -272,6 +273,14 @@ export declare function isBrowserFocused(webBrowser: Browser): boolean;
*/
export declare function isBrowserLoading(webBrowser: Browser): boolean;

/**
* @see https://wiki.multitheftauto.com/wiki/IsBrowserRenderingPaused
* @param webBrowser The browser element to get the rendering state of.
* @return returns true if the browser rendering is paused, false otherwise.
* @noSelf
*/
export declare function isBrowserRenderingPaused(webBrowser: Browser): boolean;

/**
* This function loads the specified URL.
* @see https://wiki.multitheftauto.com/wiki/LoadBrowserURL
Expand Down
1 change: 1 addition & 0 deletions client/function/camera.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
1 change: 1 addition & 0 deletions client/function/clothes.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
5 changes: 3 additions & 2 deletions client/function/collision.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down Expand Up @@ -220,7 +221,7 @@ export declare function createColTube(
/**
* By default, a colshape polygon is infinitely tall.}}
* @see https://wiki.multitheftauto.com/wiki/GetColPolygonHeight
* @param shape The colshape polygon
* @param shape The colshape polygon.
* @return returns two floats, indicating the floor and ceiling of the colshape height, false if
* invalid arguments were passed.
* @noSelf
Expand Down Expand Up @@ -323,7 +324,7 @@ export declare function removeColPolygonPoint(
/**
* By default, a colshape polygon is infinitely tall.}}
* @see https://wiki.multitheftauto.com/wiki/SetColPolygonHeight
* @param shape The colshape polygon
* @param shape The colshape polygon.
* @param floor The polygon floor (lowest Z coordinate). Parse false to reset this value to 0.
* @param ceil The polygon ceiling (highest Z coordinate). Parse false to reset this value to infinitely
* tall.
Expand Down
1 change: 1 addition & 0 deletions client/function/cursor.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
20 changes: 10 additions & 10 deletions client/function/drawing.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down Expand Up @@ -148,7 +149,7 @@ export declare function dxCreateScreenSource(
/**
* This function creates a shader element that can be used in the dxDraw functions.
* Successful shader creation is not guaranteed unless the shader|Effect File contains a
* fallback technique which will work on every PC in the universe.
* fallback technique which will work on every existing PC.
* <syntaxhighlight lang=lua>
* element, string dxCreateShader ( string filepath / string raw_data , float priority = 0,
* float maxDistance = 0, bool layered = false, string elementTypes =
Expand Down Expand Up @@ -213,7 +214,6 @@ export declare function dxCreateScreenSource(
* *element: A shader element if successful, false if invalid arguments were passed to the
* function. You should always check to see if this function has returned false.
* *string: The name of the technique that will be used.
* |20688}}
* @see https://wiki.multitheftauto.com/wiki/DxCreateShader
* @noSelf
*/
Expand Down Expand Up @@ -491,11 +491,9 @@ export declare function dxDrawLine3D(
* @param width The width/thickness of the line in GTA world units. (This is 1/75th of the width used in
* dxDrawLine3D)
* @param flipUV : A bool representing whether a UV orientation should be flipped.
* |20862}}
* @param color An int|integer of the hex color, produced using tocolor or 0xAARRGGBB (AA = alpha, RR =
* red, GG = green, BB = blue).
* @param postGUI : A bool representing whether the line should be drawn on top of or behind any ingame GUI.
* |11998}}
* @param faceTowardX/Y/Z The position the front of the line should face towards. If this is not set, the camera
* position is used, so the front of the line faces toward the camera.
* Returns a ''true'' if the operation was successful, ''false'' otherwise.
Expand Down Expand Up @@ -612,7 +610,6 @@ export declare function dxDrawMaterialPrimitive3D(
* @param width The width/thickness of the line in GTA world units. (This is 1/75th of the width used in
* dxDrawLine3D)
* @param flipUV : A bool representing whether a UV orientation should be flipped.
* |20862}}
* @param color An integer of the hex color, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red,
* GG = green, BB = blue).
* @param postGUI : A bool representing whether the line should be drawn on top of or behind any ingame GUI.
Expand Down Expand Up @@ -783,6 +780,8 @@ export declare function dxDrawRectangle(
* @param fRotation Rotation
* @param fRotationCenterX Rotation Origin X
* @param fRotationCenterY Rotation Origin Y
* @param fLineSpacing Distance in pixels between the lines of text, this can be a negative number, works only
* when colorCoded is set to true
* @return returns true if successful, false otherwise.
* @noSelf
*/
Expand All @@ -806,6 +805,7 @@ export declare function dxDrawText(
fRotation?: number,
fRotationCenterX?: number,
fRotationCenterY?: number,
fLineSpacing?: number,
): boolean;

/**
Expand Down Expand Up @@ -910,15 +910,15 @@ export declare function dxGetPixelsSize(
): LuaMultiReturn<[number, number]>;

/**
* This function gets information about various internal datum
* This function gets information about various internal datum.
* @see https://wiki.multitheftauto.com/wiki/DxGetStatus
* @return returns a table with the following entries:
* *testmode: the current dx test mode. see dxsettestmode.
* *videocardname: the name of the graphics card.
* *videocardram: the installed memory in mb of the graphics card.
* *videocardpsversion: the maximum pixel shader version of the graphics card.
* *videocardmaxanisotropy: the maximum anisotropic filtering available. (0-4 which
* respectively mean: off,2x,4x,8x,16x)
* respectively mean: off, 2x, 4x, 8x, 16x)
* *videocardnumrendertargets: the maximum number of simultaneous render targets a shader
* can use.
* *videomemoryfreeformta: the amount of memory in mb available for mta to use. when this
Expand All @@ -935,9 +935,9 @@ export declare function dxGetPixelsSize(
* *settingvolumetricshadows: the volumetric shadows setting. (true/false)
* *settingstreamingvideomemoryforgta: the usable graphics memory setting. (64-256)
* *settinganisotropicfiltering: the anisotropic filtering setting. (0-4 which respectively
* mean: off,2x,4x,8x,16x)
* *settingantialiasing: the anti-aliasing setting. (0-3 which respectively mean:
* off,1x,2x,3x)
* mean: off, 2x, 4x, 8x, 16x)
* *settingantialiasing: the anti-aliasing setting. (0-3 which respectively mean: off, 1x,
* 2x, 3x)
* *settingheathaze: the heat haze setting. (true/false)
* *settinggrasseffect: the grass effect setting. (true/false)
* *setting32bitcolor: the color depth of the screen. (false is 16bit, true is 32bit)
Expand Down
1 change: 1 addition & 0 deletions client/function/effects.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
GuiWindow,
Projectile,
Material,
Svg,
Userdata,
TextItem,
Pickup,
Expand Down
Loading

0 comments on commit 5a34ec4

Please sign in to comment.