DgsCreateProgressBar: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Client function}}
This function creates a progress bar.
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsDxCreateProgressBar ( float x, float y, float width, float height, bool relative)
element dgsCreateProgressBar ( float x, float y, float width, float height, bool relative [, element parent = nil, texture bgImage = nil, int bgColor = nil, texture indicatorImage = nil, int indicatorColor = nil, bool indicatorMode = false ] )
</syntaxhighlight>  
</syntaxhighlight>  


Line 10: Line 14:
*'''width:''' A float of the width of the progress bar. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the progress bar. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the progress bar. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the progress bar. 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,height floats must be between 0 and  
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1.
 
===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the DGS progress bar 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.
*'''bgImage:''' An image element of the background of the progress bar.
*'''bgColor:''' An int of the color of the background of the progress bar.
*'''indicatorImage:''' An image element of the background of the indicator of the progress bar.
*'''indicatorColor:''' An int of the color of the background of the indicator of the progress bar.
*'''indicatorMode:''' A bool of the mode of the indicator of progress bar. (true:the image of bar of progress bar will be relative ;false:the image of bar of progress bar will be absolute )


===Returns===
===Returns===
Returns [[element]] of the progress bar if it was created succesfully, ''false'' otherwise.
Returns [[element]] of the progress bar if it was created successfully, ''false'' otherwise.


<section name="Client" class="client" show="false">
<section name="Client" class="client" show="true">
'''Example 1:'''  
'''Example 1:'''  


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
progressbar = DGS:dgsDxCreateProgressBar(286, 307, 317, 43, false)     
progressbar = DGS:dgsCreateProgressBar(286, 307, 317, 43, false)     
number = 0  
number = 0  
setTimer(function ()
setTimer(function ()
number = number + 1  
number = number + 1  
DGS:dgsDxProgressBarSetProgress(progressbar,number)
DGS:dgsProgressBarSetProgress(progressbar,number)
if number == 100 then
if number == 100 then
number = 0
number = 0

Latest revision as of 09:22, 30 March 2020

This function creates a progress bar.

Syntax

element dgsCreateProgressBar ( float x, float y, float width, float height, bool relative [, element parent = nil, texture bgImage = nil, int bgColor = nil, texture indicatorImage = nil, int indicatorColor = nil, bool indicatorMode = false ] )

Required Arguments

Example dx progress bar.
  • x: A float of the 2D x position of the progress bar on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the progress bar on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the progress bar. This is affected by the relative argument.
  • height: A float of the height of the progress bar. 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,height floats must be between 0 and 1.

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 progress bar 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.
  • bgImage: An image element of the background of the progress bar.
  • bgColor: An int of the color of the background of the progress bar.
  • indicatorImage: An image element of the background of the indicator of the progress bar.
  • indicatorColor: An int of the color of the background of the indicator of the progress bar.
  • indicatorMode: A bool of the mode of the indicator of progress bar. (true:the image of bar of progress bar will be relative ;false:the image of bar of progress bar will be absolute )

Returns

Returns element of the progress bar if it was created successfully, false otherwise.

Click to collapse [-]
Client

Example 1: 

DGS = exports.dgs
progressbar = DGS:dgsCreateProgressBar(286, 307, 317, 43, false)    
number = 0 
setTimer(function ()
	number = number + 1 
	DGS:dgsProgressBarSetProgress(progressbar,number)
	if number == 100 then
		number = 0
	end 
end,3000,0)

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/DgsCreateProgressBar?oldid=65590"