GuiCreateProgressBar: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
This function creates a progress bar.
This function creates a progress bar.


Line 8: Line 9:


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''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.
===Optional Arguments===
*'''width:''' A float of the width of the progress bar. This is affected by the ''relative'' argument.
{{OptionalArg}}
*'''height:''' A float of the height of the progress bar. This is affected by the ''relative'' argument.
*'''argumentName2:''' description
*'''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.


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


==Example==
==Example==
This example
This example creates a progress bar to player's screen on client resource start and destroys it when client resource stops.
<section name="Client-side script" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function clientResourceStart( )
    progressBar = guiCreateProgressBar( 0.8, 0.8, 0.1, 0.1, true, nil )
end
addEventHandler( "onClientResourceStart", getRootElement(), clientResourceStart )
function clientResourceStop( )
    destroyElement( progressBar )
end
addEventHandler( "onClientResourceStop", getRootElement(), clientResourceStop )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]
[[Category:Incomplete]]

Revision as of 08:52, 3 February 2008

This function creates a progress bar.

Syntax

element guiCreateProgressBar ( float x, float y, float width, float height, bool relative, parent element )

Required Arguments

  • 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, 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.

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 )
end
addEventHandler( "onClientResourceStart", getRootElement(), clientResourceStart )

function clientResourceStop( )
    destroyElement( progressBar )
end
addEventHandler( "onClientResourceStop", getRootElement(), clientResourceStop )

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

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