GuiCreateProgressBar: Difference between revisions
Jump to navigation
Jump to search
m (→Syntax) |
mNo edit summary |
||
| 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, element parent ) | element guiCreateProgressBar ( float x, float y, float width, float height, bool relative, [element parent = nil] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 14: | Line 14: | ||
*'''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 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 | |||
===Optional Arguments=== | |||
{{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. | |||
===Returns=== | ===Returns=== | ||
| Line 37: | Line 40: | ||
==See Also== | ==See Also== | ||
{{GUI_functions}} | {{GUI_functions}} | ||
Revision as of 15:33, 18 March 2008
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. 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 scriptfunction 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
- guiBringToFront
- getChatboxLayout
- getChatboxCharacterLimit
- guiCreateFont
- guiBlur
- guiFocus
- guiGetAlpha
- guiGetCursorType
- guiGetEnabled
- guiGetFont
- guiGetInputEnabled
- guiGetInputMode
- guiGetPosition
- guiGetProperties
- guiGetProperty
- guiGetScreenSize
- guiGetSize
- guiGetText
- guiGetVisible
- guiMoveToBack
- guiSetAlpha
- guiSetEnabled
- guiSetFont
- guiSetInputEnabled
- guiSetInputMode
- guiSetPosition
- guiSetProperty
- guiSetSize
- guiSetText
- guiSetVisible
- isChatBoxInputActive
- isConsoleActive
- isDebugViewActive
- isMainMenuActive
- isMTAWindowActive
- isTransferBoxActive
- setChatboxCharacterLimit
- setDebugViewActive
Browsers
Buttons
Checkboxes
Comboboxes
- guiCreateComboBox
- guiComboBoxAddItem
- guiComboBoxClear
- guiComboBoxGetItemCount
- guiComboBoxGetItemText
- guiComboBoxGetSelected
- guiComboBoxIsOpen
- guiComboBoxRemoveItem
- guiComboBoxSetItemText
- guiComboBoxSetOpen
- guiComboBoxSetSelected
Edit Boxes
- guiCreateEdit
- guiEditGetCaretIndex
- guiEditGetMaxLength
- guiEditIsMasked
- guiEditIsReadOnly
- guiEditSetCaretIndex
- guiEditSetMasked
- guiEditSetMaxLength
- guiEditSetReadOnly
Gridlists
- guiCreateGridList
- guiGridListAddColumn
- guiGridListAddRow
- guiGridListAutoSizeColumn
- guiGridListClear
- guiGridListGetColumnCount
- guiGridListGetColumnTitle
- guiGridListGetColumnWidth
- guiGridListGetHorizontalScrollPosition
- guiGridListGetItemColor
- guiGridListGetItemData
- guiGridListGetItemText
- guiGridListGetRowCount
- guiGridListGetSelectedCount
- guiGridListGetSelectedItem
- guiGridListGetSelectedItems
- guiGridListGetSelectionMode
- guiGridListIsSortingEnabled
- guiGridListGetVerticalScrollPosition
- guiGridListInsertRowAfter
- guiGridListRemoveColumn
- guiGridListRemoveRow
- guiGridListSetColumnTitle
- guiGridListSetColumnWidth
- guiGridListSetHorizontalScrollPosition
- guiGridListSetItemColor
- guiGridListSetItemData
- guiGridListSetItemText
- guiGridListSetScrollBars
- guiGridListSetSelectedItem
- guiGridListSetSelectionMode
- guiGridListSetSortingEnabled
- guiGridListSetVerticalScrollPosition
Memos
- guiCreateMemo
- guiMemoGetCaretIndex
- guiMemoGetVerticalScrollPosition
- guiMemoSetVerticalScrollPosition
- guiMemoIsReadOnly
- guiMemoSetCaretIndex
- guiMemoSetReadOnly
Progressbars
Radio Buttons
Scrollbars
Scrollpanes
- guiCreateScrollPane
- guiScrollPaneGetHorizontalScrollPosition
- guiScrollPaneGetVerticalScrollPosition
- guiScrollPaneSetHorizontalScrollPosition
- guiScrollPaneSetScrollBars
- guiScrollPaneSetVerticalScrollPosition
Static Images
Tab Panels
Tabs
Text Labels
- guiCreateLabel
- guiLabelGetColor
- guiLabelGetFontHeight
- guiLabelGetTextExtent
- guiLabelSetColor
- guiLabelSetHorizontalAlign
- guiLabelSetVerticalAlign