GuiCreateProgressBar: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 17: Line 17:
===Optional Arguments===
===Optional Arguments===
{{OptionalArg}}
{{OptionalArg}}
*'''parent:''' This is the parent that the progress bar 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===

Revision as of 20:33, 2 January 2009

This function creates a progress bar.

Syntax

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

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.

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 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 )
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=18095"