GuiSetAlpha: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 6: | Line 6: | ||
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | <!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool guiSetAlpha ( element guielement, | bool guiSetAlpha ( element guielement, float alpha ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''guiElement:''' the GUI element whose visibility is to be changed | *'''guiElement:''' the GUI element whose visibility is to be changed | ||
*'''alpha:''' The visibility/transparency of the GUI element. Ranges from 1 | *'''alpha:''' The visibility/transparency of the GUI element. Ranges from 0 (fully transparent) to 1 (fully opaque). | ||
===Returns=== | ===Returns=== | ||
| Line 22: | Line 22: | ||
--Add a command handler to change the alpha of the GUI window. | --Add a command handler to change the alpha of the GUI window. | ||
--Usage example: 'alpha | --Usage example: '/alpha 0.8', where 0.8 is stored as alphaAmount | ||
function changeAlpha ( commandName, alphaAmount ) | function changeAlpha ( commandName, alphaAmount ) | ||
alphaAmount = tonumber(alphaAmount) | alphaAmount = tonumber(alphaAmount) | ||
guiSetAlpha ( | guiSetAlpha ( myWindow, alphaAmount ) | ||
end | end | ||
addCommandHandler ( "alpha", changeAlpha ) | addCommandHandler ( "alpha", changeAlpha ) | ||
Revision as of 10:25, 18 December 2007
This changes the alpha level (the visibleness/transparency) of a GUI element
Syntax
bool guiSetAlpha ( element guielement, float alpha )
Required Arguments
- guiElement: the GUI element whose visibility is to be changed
- alpha: The visibility/transparency of the GUI element. Ranges from 0 (fully transparent) to 1 (fully opaque).
Returns
Returns true if the gui element's alpha was successfully changed, false otherwise.
Example
This creates a GUI window and allows a player to change it's alpha (the visibleness/transparency) value with a command.
--Create a gridlist myWindow = guiCreateWindow ( 0.30, 0.10, 0.5, 0.60, "GUI window title", true ) --Add a command handler to change the alpha of the GUI window. --Usage example: '/alpha 0.8', where 0.8 is stored as alphaAmount function changeAlpha ( commandName, alphaAmount ) alphaAmount = tonumber(alphaAmount) guiSetAlpha ( myWindow, alphaAmount ) end addCommandHandler ( "alpha", changeAlpha )
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