Dgs-dx3dimage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:
===canBeBlocked===
===canBeBlocked===
This property determines what can block the 3d image, see [[isLineOfSightClear]].
This property determines what can block the 3d image, see [[isLineOfSightClear]].
<syntaxhighlight lang="lua">dgsSetProperty(image,"canBeBlocked",canBeBlocked)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"canBeBlocked",canBeBlocked)</syntaxhighlight>
*'''canBeBlocked:'''  A table or bool that determines what can block the 3d image, available options are as follows:
*'''canBeBlocked:'''  A table or bool that determines what can block the 3d image, available options are as follows:
**'''true:''' Everything can block the 3d image.
**'''true:''' Everything can block the 3d image.
Line 25: Line 25:
===color===
===color===
The color which can be translated by [[tocolor]] of the 3d image.
The color which can be translated by [[tocolor]] of the 3d image.
<syntaxhighlight lang="lua">dgsSetProperty(image,"color",color)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"color",color)</syntaxhighlight>
*'''color:'''  An integer of the color of the 3d image.
*'''color:'''  An integer of the color of the 3d image.


===dimension===
===dimension===
The dimension of 3d image. Players can't see the 3d image in different dimensions.
The dimension of 3d image. Players can't see the 3d image in different dimensions.
<syntaxhighlight lang="lua">dgsSetProperty(image,"dimension",dimension)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"dimension",dimension)</syntaxhighlight>
*'''dimension:'''  An integer of the dimension of 3d image.
*'''dimension:'''  An integer of the dimension of 3d image.


===fadeDistance===
===fadeDistance===
The distance of which 3D image starts to fading.
The distance of which 3D image starts to fading.
<syntaxhighlight lang="lua">dgsSetProperty(image,"fadeDistance",fadeDistance)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"fadeDistance",fadeDistance)</syntaxhighlight>
*'''fadeDistance:''' A float of the fade distance.
*'''fadeDistance:''' A float of the fade distance.


===fixImageSize===
===fixImageSize===
This property keeps the image size on screen rather than let the image size change with distance.
This property keeps the image size on screen rather than let the image size change with distance.
<syntaxhighlight lang="lua">dgsSetProperty(image,"fixImageSize",fixImageSize)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"fixImageSize",fixImageSize)</syntaxhighlight>
*'''fixImageSize:''' A bool of whether fix the image size.
*'''fixImageSize:''' A bool of whether fix the image size.


===image===
===image===
This property stores the image of 3d image.
This property stores the image of 3d image.
<syntaxhighlight lang="lua">dgsSetProperty(image,"image",image)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"image",image)</syntaxhighlight>
*'''image:''' An texture element such as texture, render target, screen source, shader and so on. Or texture path. Or nil (color only).
*'''image:''' An texture element such as texture, render target, screen source, shader and so on. Or texture path. Or nil (color only).


===interior===
===interior===
The interior of 3d image. Players can't see the 3d image in different interiors.
The interior of 3d image. Players can't see the 3d image in different interiors.
<syntaxhighlight lang="lua">dgsSetProperty(image,"interior",interior)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"interior",interior)</syntaxhighlight>
*'''interior:'''  An integer of the interior of 3d image.
*'''interior:'''  An integer of the interior of 3d image.


===maxDistance===
===maxDistance===
The maximum visible distance in the world.
The maximum visible distance in the world.
<syntaxhighlight lang="lua">dgsSetProperty(image,"maxDistance",maxDistance)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"maxDistance",maxDistance)</syntaxhighlight>
*'''maxDistance:''' A float of the distance.
*'''maxDistance:''' A float of the distance.


===imageSize===
===imageSize===
The scale of the image of the 3d image.
The scale of the image of the 3d image.
<syntaxhighlight lang="lua">dgsSetProperty(image,"imageSize",{scaleX,scaleY})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"imageSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : A float of the 2D X size of the image of the 3d image ( Width in pixels on screen at the distance of 50 unit in game ).
*'''scaleX''' : A float of the 2D X size of the image of the 3d image ( Width in pixels on screen at the distance of 50 unit in game ).
*'''scaleY''' : A float of the 2D Y size of the image of the 3d image ( Height in pixels on screen at the distance of 50 unit in game ).
*'''scaleY''' : A float of the 2D Y size of the image of the 3d image ( Height in pixels on screen at the distance of 50 unit in game ).
Line 66: Line 66:
===position===
===position===
A table stores x,y,z coordinate of the 3d image in the world.
A table stores x,y,z coordinate of the 3d image in the world.
<syntaxhighlight lang="lua">dgsSetProperty(image,"position",{x,y,z})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(image3D,"position",{x,y,z})</syntaxhighlight>
*'''x:''' The x coordinate of the destination.
*'''x:''' The x coordinate of the destination.
*'''y:''' The y coordinate of the destination.
*'''y:''' The y coordinate of the destination.

Revision as of 11:44, 27 January 2021

DGS Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dx3dimage that you could use.

Main Functions

Properties

canBeBlocked

This property determines what can block the 3d image, see isLineOfSightClear.

dgsSetProperty(image3D,"canBeBlocked",canBeBlocked)
  • canBeBlocked: A table or bool that determines what can block the 3d image, available options are as follows:
    • true: Everything can block the 3d image.
    • false: Nothing can block the 3d image.
    • table has following keys:
      • checkBuildings: Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
      • checkVehicles: Allow the line of sight to be blocked by vehicles.
      • checkPeds: Allow the line of sight to be blocked by peds, i.e. players.
      • checkObjects: Allow the line of sight to be blocked by objects.
      • checkDummies: Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to false.
      • seeThroughStuff: Allow the line of sight to pass through collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences). This flag originally allows some objects to be walked on but you can shoot throug them.
      • ignoreSomeObjectsForCamera: Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)

color

The color which can be translated by tocolor of the 3d image.

dgsSetProperty(image3D,"color",color)
  • color: An integer of the color of the 3d image.

dimension

The dimension of 3d image. Players can't see the 3d image in different dimensions.

dgsSetProperty(image3D,"dimension",dimension)
  • dimension: An integer of the dimension of 3d image.

fadeDistance

The distance of which 3D image starts to fading.

dgsSetProperty(image3D,"fadeDistance",fadeDistance)
  • fadeDistance: A float of the fade distance.

fixImageSize

This property keeps the image size on screen rather than let the image size change with distance.

dgsSetProperty(image3D,"fixImageSize",fixImageSize)
  • fixImageSize: A bool of whether fix the image size.

image

This property stores the image of 3d image.

dgsSetProperty(image3D,"image",image)
  • image: An texture element such as texture, render target, screen source, shader and so on. Or texture path. Or nil (color only).

interior

The interior of 3d image. Players can't see the 3d image in different interiors.

dgsSetProperty(image3D,"interior",interior)
  • interior: An integer of the interior of 3d image.

maxDistance

The maximum visible distance in the world.

dgsSetProperty(image3D,"maxDistance",maxDistance)
  • maxDistance: A float of the distance.

imageSize

The scale of the image of the 3d image.

dgsSetProperty(image3D,"imageSize",{scaleX,scaleY})
  • scaleX : A float of the 2D X size of the image of the 3d image ( Width in pixels on screen at the distance of 50 unit in game ).
  • scaleY : A float of the 2D Y size of the image of the 3d image ( Height in pixels on screen at the distance of 50 unit in game ).

position

A table stores x,y,z coordinate of the 3d image in the world.

dgsSetProperty(image3D,"position",{x,y,z})
  • x: The x coordinate of the destination.
  • y: The y coordinate of the destination.
  • z: The z coordinate of the destination.

See Also

General Properties

Unique Properties For DGS Core Elements

Extra Properties For DGS Plugins