GuiCreateProgressBar: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This function creates a progress bar.
This function creates a [[Element/GUI/Progress bar|progress bar]].


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element guiCreateProgressBar ( float x, float y, float width, float height, bool relative, parent element )
element guiCreateProgressBar ( float x, float y, float width, float height, [ bool relative = false, gui-element parent = nil] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
[[Image:Gui-progressbar.png|frame|Example GUI 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.
*'''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.
*'''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.
*'''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.
===Optional Arguments===
{{OptionalArg}}
*'''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, representing measures relative to the parent.
*'''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, representing measures relative to the parent.
*'''parent:''' This is the parent that the image is attached to. The ''relative'' argument must be true to use this. Sizes and positioning will be made relative to this parent. If ''nil'' parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''parent:''' This is the parent that the 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.


===Returns===
===Returns===
Line 24: Line 28:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function clientResourceStart( )
function clientResourceStart( )
     progressBar = guiCreateProgressBar( 0.8, 0.8, 0.1, 0.1, true, nil )
     progressBar = guiCreateProgressBar( 0.8, 0.8, 0.1, 0.1, true, nil ) --create the gui-progressbar
end
addEventHandler( "onClientResourceStart", getRootElement(), clientResourceStart )
 
function clientResourceStop( )
    destroyElement( progressBar )
end
end
addEventHandler( "onClientResourceStop", getRootElement(), clientResourceStop )
addEventHandler( "onClientResourceStart", resourceRoot, clientResourceStart ) --attach the onClientResourceStart event to a handler with the resource's rootelement(resourceRoot)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
Line 37: Line 36:
==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]
{{GUI_events}}

Latest revision as of 08:09, 30 October 2023

This function creates a progress bar.

Syntax

element guiCreateProgressBar ( float x, float y, float width, float height, [ bool relative = false, gui-element parent = nil] )

Required Arguments

Example GUI 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.

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.

  • 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, representing measures relative to the parent.
  • parent: This is the parent that the 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.

Returns

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

Example

This example creates a progress bar to player's screen on client resource start and destroys it when client resource stops.

Click to collapse [-]
Client-side script
function clientResourceStart( )
    progressBar = guiCreateProgressBar( 0.8, 0.8, 0.1, 0.1, true, nil ) --create the gui-progressbar
end
addEventHandler( "onClientResourceStart", resourceRoot, clientResourceStart ) --attach the onClientResourceStart event to a handler with the resource's rootelement(resourceRoot)

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateProgressBar?oldid=78482"