SetChatAlpha: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
 (Created page with "__NOTOC__  {{Client function}} This function sets the global alpha value of the in-game chat. The alpha value applies to text output, input line and background colors.  ==Syntax=...")  | 
				Zangomangu (talk | contribs)   (Removed issues from disabled function)  | 
				||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Disabled|This function doesn't exists. See issue 7698 on bugtracker.}}  | |||
{{Client function}}  | {{Client function}}  | ||
This function sets the global alpha value of the in-game chat. The alpha value applies to text output, input line and background colors.  | This function sets the global alpha value of the in-game chat. The alpha value applies to text output, input line and background colors.  | ||
__NOTOC__   | |||
==Syntax==    | ==Syntax==    | ||
<syntaxhighlight lang="lua">  | <syntaxhighlight lang="lua">  | ||
bool setChatAlpha ( float alpha )  | bool setChatAlpha ( float alpha )  | ||
</syntaxhighlight>    | </syntaxhighlight>    | ||
===Required Arguments===   | |||
*'''alpha:''' the new global alpha value for the in-game chat (0-255)  | |||
===Returns===  | ===Returns===  | ||
Latest revision as of 10:43, 30 January 2022
| Function has been disabled. | |
Reason/Note: This function doesn't exists. See issue 7698 on bugtracker.  | 
This function sets the global alpha value of the in-game chat. The alpha value applies to text output, input line and background colors.
Syntax
bool setChatAlpha ( float alpha )
Required Arguments
- alpha: the new global alpha value for the in-game chat (0-255)
 
Returns
Returns true if alpha is a number and resides in a valid range (0-255), false if alpha is not a number or resides in an invalid range (like 9001).
Example
This example makes everybodies chatbox flash in 1 second intervals.
local startTime = getTickCount()
local interval = 1000 -- time in milliseconds
local baseAlpha = 200 -- the alpha value the chat will at least have
                      -- valid: 0 - 255
addEventHandler( "onClientRender", root,
    function()
        local elapsedTime = getTickCount() - startTime
        local modAlpha = ( 255 - baseAlpha ) / 2
        local alpha = math.sin( elapsedTime / interval * math.pi * 2 ) * modAlpha
                      + baseAlpha + modAlpha
                      
        setChatAlpha( alpha )
    end
)
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