Modern-Library: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<pageclass class="resource" subcaption="Resource"></pageclass>
{{Resource page}}
__NOTOC__


== Modern DX Library ==
== Modern DX Library ==


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.
{{note|This wiki is always for the latest Modern DX Library version!}}


<span style="color:#332170; text-shadow:blue 0em 0em 0.3em;">This wiki is always for the latest Modern DX Library version!</span>
<div style="padding:10px; border-radius:2px;font-size:14px;">
'''Full Name''': Modern DX Library for User Interface
'''Full Name''': Modern DX Library for User Interface


Line 22: Line 21:
'''How does it work?'''
'''How does it work?'''
*Modern DX Library is based on [[element]] system, which just likes the cegui system. To make Modern DX Library easier to use and understand, I choose to follow the usage of cegui's.
*Modern DX Library is based on [[element]] system, which just likes the cegui system. To make Modern DX Library easier to use and understand, I choose to follow the usage of cegui's.
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every Modern DX Library elements will be looped and calculated.
*Modern DX Library elements are rendered in the event "onClientRender". When "onClientRender" is called, every Modern DX Library elements will be looped and calculated.


'''What's different from cegui?'''
'''What's different from cegui?'''
Line 31: Line 30:


=Examples=
=Examples=
; Player Rename : https://youtube.com
'''Demonstration''': https://www.youtube.com/watch?v=qakLp6Znws0


'''Notice'''
'''Notice'''
*It is recommended to change the resource name to 'dxLib'.
*It is recommended to change the resource name to 'dxLibrary'.
*This is a resource, if you want to use the functions exported by this resource,  you should use an exported function prefix (''' exports[ "dxLib" ]: ''') call in your code, such as
*This is a resource, if you want to use the functions exported by this resource,  you should use an exported function prefix (''' exports[ "dxLibrary" ]: ''') call in your code, such as


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
button = exports[ "dxLib" ]:dxButton( 50, 50, 40, 20, "Button Test" )
button = exports[ "dxLibrary" ]:dxButton( 50, 50, 40, 20, "Button Test" )
</syntaxhighlight>
</syntaxhighlight>


*Here is a feasible way to shorten the name of an exported function:
*Here is a feasible way to shorten the name of an exported function:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
dxLib = exports[ "dxLib" ] -- shorten the export function prefix
dxLib = exports[ "dxLibrary" ] -- shorten the export function prefix


button = dxLib:dxButton( 50, 50, 40, 20, "Button Test" ) -- create a button
button = dxLib:dxButton( 50, 50, 40, 20, "Button Test" ) -- create a button
</syntaxhighlight>
</syntaxhighlight>


*From the latest version, it no longer needs '''exports[ "dxLib" ]:''', instead we can do
='''Client Functions'''=
<syntaxhighlight lang="lua">
{{DXLIB_FUNCTIONS}}
loadstring( exports.dxlib:dxGetLibrary( ) )( ) -- load functions


button = dxButton( 50, 50, 40, 20, "Button Test" ) -- create a button
='''Client Events'''=
</syntaxhighlight>
{{DXLIB_EVENTS}}


='''Modern DX Library Element Properties'''=
=Last=
{{DGSPROPERTIES}}
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''
[[Category:Resource]]

Latest revision as of 01:00, 21 November 2023


Modern DX Library

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

[[{{{image}}}|link=|]] Note: This wiki is always for the latest Modern DX Library version!

Full Name: Modern DX Library for User Interface

Developer Team: ClawSuit, PandFort

GitHub Repo: https://github.com/clawsuit/dxLibrary

Current Version: 1.0 Estable

Features

Demo Window

How does it work?

  • Modern DX Library is based on element system, which just likes the cegui system. To make Modern DX Library easier to use and understand, I choose to follow the usage of cegui's.
  • Modern DX Library elements are rendered in the event "onClientRender". When "onClientRender" is called, every Modern DX Library 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.

You Should Know

  • Some of Modern DX Library elements use Render Target, which means if you don't have enough video memory, Render Target won't be created, and therefore those Modern DX Library elements won't be shown.

Examples

Demonstration: https://www.youtube.com/watch?v=qakLp6Znws0

Notice

  • It is recommended to change the resource name to 'dxLibrary'.
  • This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ( exports[ "dxLibrary" ]: ) call in your code, such as
button = exports[ "dxLibrary" ]:dxButton( 50, 50, 40, 20, "Button Test" )
  • Here is a feasible way to shorten the name of an exported function:
dxLib = exports[ "dxLibrary" ] -- shorten the export function prefix

button = dxLib:dxButton( 50, 50, 40, 20, "Button Test" ) -- create a button

Client Functions

General Functions

Window

Button

CheckBox

Edit

GridList

Image

Label

List

ProgressBar

ScrollBar

Client Events

General Events

Last

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

Retrieved from "https://wiki.multitheftauto.com/wiki/Modern-Library?oldid=78611"