Resource:DGS: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added Syntax Highlighting links)
No edit summary
 
(58 intermediate revisions by 7 users not shown)
Line 2: Line 2:
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.
<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span>


<div style="padding:10px; border-radius:2px;font-size:14px;">
<div style="padding:10px; border-radius:2px;font-size:14px;">
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)


'''Developer''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]]
'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span>


'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span>
'''Github Repo''': https://github.com/thisdp/dgs


'''GitHub Source''': https://github.com/thisdp/dgs/tree/master
'''Resource Download''': [https://github.com/thisdp/dgs/releases/latest/download/dgs.zip dgs.zip]


'''Server Discord''': https://discord.gg/QEs8q6W
'''Server Discord''': https://discord.gg/QEs8q6W


'''Current Version''': 3.506
'''Current Version''': 3.522


'''Update Log''': [[DGS Updates Log|Changes and Updates Log]]
'''Update Log''': [https://github.com/thisdp/dgs/releases/tag/3.522 Changes and Updates Log]


'''Syntax Highlighting''':


*Visual Studio Code, made by [BW]~ERAGON > https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua
'''Auto Completion & Syntax  Highlight'''
*Notepad, made by xLive > https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing
 
Official:
 
'''Latest VSCode Snippets:''' [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets (Last Update: Auto every month) By '''motar2k''']
 
 
Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).
*'''g2d -crawl npp/sublime/vscode'''
Or you can use the following link to download completed files instead of crawling by yourself.
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode (Old)]
 
3rd Party Auto Completion:
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]
</div>
</div>


Line 32: Line 48:


'''How does it work?'''
'''How does it work?'''
*DGS is based on [[element]] system, which just likes the cegui system. To make DGS easier to use and understand, I choose to follow the usage of cegui's.
*DGS is based on [[element]] system, which just likes the cegui system. To make everything easy to use and understand, DGS has almost the same usage as CEGUI.
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.
Line 60: Line 76:
*2. Also File test.lua its have more Examples You can See it .
*2. Also File test.lua its have more Examples You can See it .
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI
'''Auto Completion'''
DGS Official Auto Completion:
*Use the following command in server console to crawl and generate the latest auto completion (Only support notepad++/sumlime).
*'''g2d -crawl npp/sublime'''
3rd Party Auto Completion:
*1. Link: http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip  By [[User:Ahmed Ly|Ahmed Ly]]
*2. '''Note''': You must put it in file Notepad++\plugins\APIs.
*3. Not all of DGS Functions are added, but the rest will be added soon.




'''Debug'''
'''Debug'''
* You can enter the debug mode by executing the command "'''debugdgs'''".
* You can enter the debug mode by executing the command "'''debugdgs'''".
* "'''debugdgs 2 '''": To see dgs elements' scale with a rainbow border
* "'''debugdgs'''": Simple debug mode. For basic information.
* "'''debugdgs 3 '''": To trace where the dgs elements' were created.
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.


'''DGS Type'''
[[Image:Dx Dgs.jpg|400px|thumb|right|Hurt World GUI Example]]
Basic Types:
* 3D Image (dgs-dx3dimage)
* 3D Interface (dgs-dx3dinterface)
* 3D Line (dgs-dx3dline)
* 3D Text(dgs-dx3dtext)
* Browser (dgs-browser)
* Button (dgs-dxbutton)
* Check Box (dgs-dxcheckbox)
* Combo Box (dgs-dxcombobox + dgs-dxcombobox-Box)
* Custom Renderer (dgs-dxcustomrenderer)
* Detect Area (dgs-dxdetectarea)
* Edit (dgs-dxedit)
* Gridlist (dgs-dxgridlist)
* Image (dgs-dximage)
* Label (dgs-dxlabel)
* Media Browser (dgs-dxmedia)
* Memo (dgs-dxmemo)
* Progress Bar (dgs-dxprogressbar)
* Radio Button (dgs-dxradiobutton)
* Scale Pane (dgs-dxscalepane)
* Scroll Bar (dgs-dxscrollbar)
* Scroll Pane (dgs-dxscrollpane)
* Selector (dgs-dxselector)
* Switch Button(dgs-dxswitchbutton)
* Tab Panel (dgs-dxtabpanel + dgs-dxtab)
* Window (dgs-dxwindow)
Plugins:
* Blur Box (dgs-dxblurbox)
* Canvas (dgs-dxcanvas)
* Circle (dgs-dxcircle)
* Color Picker (dgs-dxcolorpicker + dgs-dxcomponentselector)
* Effect 3D (dgs-dxeffect3d)
* Mask (dgs-dxmask)
* Media Browser (dgs-dxmediabrowser)
* Nine Slice (dgs-dxnineslice)
* Object Preview Supports (dgs-dxobjectpreviewhandle)
* Paste Handler (dgs-dxpastehandler)
* QRCode (dgs-dxqrcode)
* Remote Image (dgs-dxremoteimage)
* Rounded Rectangle (dgs-dxroundrect)


'''Notice'''
'''Notice'''
Line 147: Line 108:
label.text = "DGS OOP Test" --set text
label.text = "DGS OOP Test" --set text
</syntaxhighlight>
</syntaxhighlight>
'''Want to talk to us?'''
*Join Discord Server: https://discord.gg/QEs8q6W


'''Special thanks to the following for their help (Respect the contributors)''':
'''Special thanks to the following for their help (Respect the contributors)''':
Line 157: Line 114:
* Scorpyo, Kingleonide, Bullet(.el3tar)
* Scorpyo, Kingleonide, Bullet(.el3tar)
* Allerek, Deihim007, OmarSwaitti(HankVoight)
* Allerek, Deihim007, OmarSwaitti(HankVoight)
* FlyingFork, xLive
* FlyingFork, Lettify, Ahmed Ly
Special thanks to:
* ᴛᴇᴍᴏɪꜱ, Shady1
* Ahmed Ly
* ᴛᴇᴍᴏɪꜱ


='''DGS Tips'''=
='''DGS Tips'''=
Line 184: Line 139:
[[Category:Resource]]
[[Category:Resource]]


[[ar:Dgs]]
[[ar:Resource:Dgs]]
[[ZH-CN:Dgs]]
[[ZH-CN:Resource:Dgs]]
[[PL:Dgs]]
[[PL:Resource:Dgs]]
[[TR:Resource:Dgs]]

Latest revision as of 18:29, 3 January 2024

DGS Logo By Allerek

This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.

This wiki is always for the latest DGS version!

Full Name: Thisdp's DirectX Graphical User Interface System (DxGUI Lib)

State: OpenSource & Work in progress

Github Repo: https://github.com/thisdp/dgs

Resource Download: dgs.zip

Server Discord: https://discord.gg/QEs8q6W

Current Version: 3.522

Update Log: Changes and Updates Log


Auto Completion & Syntax Highlight

Official:

Latest VSCode Snippets: VSCode Snippets (Last Update: Auto every month) By motar2k


Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).

  • g2d -crawl npp/sublime/vscode

Or you can use the following link to download completed files instead of crawling by yourself.

3rd Party Auto Completion:

Features

DGS Network Monitor
DGSS.png


How does it work?

  • DGS is based on element system, which just likes the cegui system. To make everything easy to use and understand, DGS has almost the same usage as CEGUI.
  • DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.
  • DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.


What's different from cegui?

  • This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.
  • The latest Style System enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of dgsSetProperty/dgsSetProperties.


Update System

  • It have an update system that can inform you of keeping your DGS latest.
  • When a newer version has been released, it will detecte the version changing periodically and then notice you.
  • Execute command "updatedgs" to check the least version and update your DGS.
  • Also, you can check the version of DGS by inputting the command "dgsver"


You Should Know

  • This project was started from 2014.
  • Some of DGS elements use Render Target, which means if you don't have enough video memory, Render Target won't be created, and therefore those dgs elements won't be shown.


Example DGS Cmd

Examples scripts


Debug

  • You can enter the debug mode by executing the command "debugdgs".
  • "debugdgs": Simple debug mode. For basic information.
  • "debugdgs 2 ": Render debug mode. To see dgs elements' scale with a rainbow border
  • "debugdgs 3 ": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.


Notice

  • It is recommended to change the resource name to 'dgs'.
  • This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix (exports.dgs:) call in your code, such as
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)
  • Here is a feasible way to shorten the name of an exported function:
DGS = exports.dgs --shorten the export function prefix
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label
  • From the latest version, it no longer needs exports.dgs:, instead we can do
loadstring(exports.dgs:dgsImportFunction())()-- load functions
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label

Object Oriented Programming 

loadstring(exports.dgs:dgsImportOOPClass(true))()-- load OOP class
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window
label.text = "DGS OOP Test" --set text

Special thanks to the following for their help (Respect the contributors):

  • Axel, Senpai, ZoNe
  • DiGiTal, #Dv^, maksam07
  • Scorpyo, Kingleonide, Bullet(.el3tar)
  • Allerek, Deihim007, OmarSwaitti(HankVoight)
  • FlyingFork, Lettify, Ahmed Ly
  • ᴛᴇᴍᴏɪꜱ, Shady1

DGS Tips

DGS Element Properties

General Properties

Unique Properties For DGS Core Elements

Extra Properties For DGS Plugins

Client Functions

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Client Events

General

Check Box

Combo Box

Drag'N Drop

Edit

Grid List

Menu

Selector

Mouse

Radio Button

Switch Button

Tab

Animation

Plugin

Media

Color Picker

QRCode

Remote Image

Last

Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.

Retrieved from "https://wiki.multitheftauto.com/wiki/Resource:DGS?oldid=78751"