DgsCreateGridList: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "==Syntax== Not completed <syntaxhighlight lang="lua"> element dgsDxCreateGridList( float x, float y, float width, float height, bool relative,[ element parent = nil] ) </synt...")
 
(update arguments names)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Client function}}
This function creates a grid list DGS element.
==Syntax==  
==Syntax==  
Not completed
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsDxCreateGridList( float x, float y, float width, float height, bool relative,[ element parent = nil] )
element dgsCreateGridList( float x, float y, float width, float height, bool relative [, element parent = nil, float columnHeight = 20, int bgColor = 0xFFD2D2D2, int columnTextColor = 0xFF000000, int columnColor = 0xFFDCDCDC, int normalRowColor = 0xFFC8C8C8, int hoveringRowColor = 0xFF969696, int selectedRowColor = 0xFF00ACF2, element bgImage = nil, element columnImage = nil, element normalRowImage = nil, element hoveringRowImage = nil, element selectedRowImage = nil] )
</syntaxhighlight>
</syntaxhighlight>
===Required Arguments===
===Required Arguments===
[[Image:gui-gridlist.png|frame|Example Gridlist.]]
[[Image:dx_3.PNG|frame|Example Dx Gridlist.]]
*'''x:''' A float of the 2D x position of the window on a player's screen. This is affected by the ''relative'' argument.
*'''x:''' A float of the 2D x position of the window on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the window on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the window on a player's screen. This is affected by the ''relative'' argument.
Line 11: Line 14:
*'''height:''' A float of the height of the window. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the window. This is affected by the ''relative'' argument.
*'''relative:''' This is whether sizes and positioning are relative. If this is true, then all x, y, width and height floats must be between 0 and 1, representing sizes relative to the parent.
*'''relative:''' This is whether sizes and positioning are relative. If this is true, then all x, y, width and height floats must be between 0 and 1, representing sizes relative to the parent.
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}
{{OptionalArg}}
Not completed
*'''parent:''' This is the parent that the DGS button is attached to.  If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''parent:''' This is the parent that the DGS button is attached to.  If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''columnHeight:''' A float of the height of the column.
*'''bgColor:''' An integer of the background color of the grid list.
*'''columnTextColor:''' An integer of the color of the text of the column.
*'''columnColor:''' An integer of the color of the column.
*'''normalRowColor:''' An integer of the color of the row ( no mouse enter and no mouse click ).
*'''hoveringRowColor:''' An integer of the color of the row of the button which your mouse is hovering .
*'''selectedRowColor:''' An integer of the color of the row of the button which is selected.
*'''bgImage:''' A texture element of the background texture of the grid list.
*'''columnImage:''' A texture element of the background texture of the column.
*'''normalRowImage:''' A texture element of the background texture of the row ( no mouse enter and no mouse click ).
*'''hoveringRowImage:''' A texture element of the background texture of the row of the button which your mouse is hovering .
*'''selectedRowImage:''' A texture element of the background texture of the row of the button which is selected.


===Returns===
===Returns===
Returns an element of the created gridlist if it was successfully created, false otherwise.
Returns an element of the created gridlist if it was successfully created, false otherwise.
==Example==  
==Example==  
'''Example 1:''' This example creates a player list on the right of the screen and fills it
'''Example:''' This example creates a player list on the right of the screen and fills it
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
function createPlayerList ()
 
--Create the grid list element
local playerList = DGS:dgsCreateGridList (346, 163, 433, 403, false ) --Create the grid list element
local playerList = DGS:dgsDxCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.5 ) --Create a players column in the list
--Create a players column in the list
for id, player in ipairs(getElementsByType("player")) do
local column = DGS:dgsDxGridListAddColumn( playerList, "Player", 0.85 )
local row = DGS:dgsGridListAddRow ( playerList )
if ( column ) then --If the column has been created, fill it with players
DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
for id, player in ipairs(getElementsByType("player")) do
end  
local row = DGS:dgsDxGridListAddRow ( playerList )
DGS:dgsDxGridListSetItemText ( playerList, row, column, getPlayerName ( player ), false, false )
end
end
end
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{DGSFUNCTIONS}}

Latest revision as of 13:48, 16 February 2021

This function creates a grid list DGS element.

Syntax

element dgsCreateGridList( float x, float y, float width, float height, bool relative [, element parent = nil, float columnHeight = 20, int bgColor = 0xFFD2D2D2, int columnTextColor = 0xFF000000, int columnColor = 0xFFDCDCDC, int normalRowColor = 0xFFC8C8C8, int hoveringRowColor = 0xFF969696, int selectedRowColor = 0xFF00ACF2, element bgImage = nil, element columnImage = nil, element normalRowImage = nil, element hoveringRowImage = nil, element selectedRowImage = nil] )

Required Arguments

Example Dx Gridlist.
  • x: A float of the 2D x position of the window on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the window on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the window. This is affected by the relative argument.
  • height: A float of the height of the window. This is affected by the relative argument.
  • relative: This is whether sizes and positioning are relative. If this is true, then all x, y, width and height floats must be between 0 and 1, representing sizes relative to the parent.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • parent: This is the parent that the DGS button is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
  • columnHeight: A float of the height of the column.
  • bgColor: An integer of the background color of the grid list.
  • columnTextColor: An integer of the color of the text of the column.
  • columnColor: An integer of the color of the column.
  • normalRowColor: An integer of the color of the row ( no mouse enter and no mouse click ).
  • hoveringRowColor: An integer of the color of the row of the button which your mouse is hovering .
  • selectedRowColor: An integer of the color of the row of the button which is selected.
  • bgImage: A texture element of the background texture of the grid list.
  • columnImage: A texture element of the background texture of the column.
  • normalRowImage: A texture element of the background texture of the row ( no mouse enter and no mouse click ).
  • hoveringRowImage: A texture element of the background texture of the row of the button which your mouse is hovering .
  • selectedRowImage: A texture element of the background texture of the row of the button which is selected.

Returns

Returns an element of the created gridlist if it was successfully created, false otherwise.

Example

Example: This example creates a player list on the right of the screen and fills it 

DGS = exports.dgs

local playerList = DGS:dgsCreateGridList (346, 163, 433, 403, false )  --Create the grid list element
local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.5 )  --Create a players column in the list
for id, player in ipairs(getElementsByType("player")) do
	local row = DGS:dgsGridListAddRow ( playerList )
	DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
end

See Also

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

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsCreateGridList?oldid=69017"