SetCursorAlpha: Difference between revisions
Jump to navigation
Jump to search
m (Fully Opaque is 1 not 255) |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (10 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{client function}} | {{client function}} | ||
This function is used to change alpha (transparency) from the client's cursor. | This function is used to change alpha (transparency) from the client's cursor. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setCursorAlpha( | bool setCursorAlpha( int alpha ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[File:SetCursorAlpha.jpg|thumb|example of cursor alpha]] | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''alpha ''': The alpha value to set. Value can be 0 | *'''alpha ''': The alpha value to set. Value can be 0-255, where 255 is fully opaque and 0 is fully transparent. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the new alpha value was set, or ''false'' otherwise. | Returns ''true'' if the new alpha value was set, or ''false'' otherwise. | ||
==Example== | ==Example== | ||
| Line 26: | Line 21: | ||
showCursor( not isCursorShowing ( ) ) | showCursor( not isCursorShowing ( ) ) | ||
-- Set the alpha to 100 | -- Set the alpha to 100 | ||
setCursorAlpha( 100 ) | setCursorAlpha(100) | ||
end | end | ||
) | ) | ||
| Line 32: | Line 27: | ||
==See Also== | ==See Also== | ||
{{ | {{Cursor_functions|client}} | ||
[[hu:setCursorAlpha]] | |||
Latest revision as of 17:11, 7 November 2024
This function is used to change alpha (transparency) from the client's cursor.
Syntax
bool setCursorAlpha( int alpha )
Required Arguments
- alpha : The alpha value to set. Value can be 0-255, where 255 is fully opaque and 0 is fully transparent.
Returns
Returns true if the new alpha value was set, or false otherwise.
Example
-- Simple command to test the setCursorAlpha function
addCommandHandler( "cursorAlpha",
function ()
-- Show the cursor if it is not showing or hide the cursor if it is
showCursor( not isCursorShowing ( ) )
-- Set the alpha to 100
setCursorAlpha(100)
end
)