GetCursorAlpha: Difference between revisions
Jump to navigation
Jump to search
UniOnDennis (talk | contribs) No edit summary |
Fernando187 (talk | contribs) No edit summary |
||
| (13 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{Client function}} | ||
This function is used to get the client's cursor alpha (transparency). | |||
This function is used to get | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getCursorAlpha ( ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
[[File:SetCursorAlpha.jpg|thumb|example of cursor alpha]] | |||
===Returns=== | ===Returns=== | ||
Returns a | Returns a [[int]] between 0 and 255, where 255 is fully opaque and 0 is fully transparent. | ||
==Requirements== | ==Requirements== | ||
{{Requirements|n/a|1. | {{Requirements|n/a|1.3.2}} | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | -- Simple command to test the getCursorAlpha function | ||
addCommandHandler( "cursorAlpha", | |||
function () | |||
if ( isCursorShowing ( ) ) then | |||
outputChatBox( "The cursor alpha: "..getCursorAlpha( ) ) | |||
else | |||
outputChatBox( "The cursor is not showing!" ) | |||
end | |||
end | |||
) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{Cursor_functions|client}} | ||
[[hu:getCursorAlpha]] | |||
Latest revision as of 15:14, 6 November 2024
This function is used to get the client's cursor alpha (transparency).
Syntax
int getCursorAlpha ( )
Returns
Returns a int between 0 and 255, where 255 is fully opaque and 0 is fully transparent.
Requirements
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.2" />
Example
-- Simple command to test the getCursorAlpha function
addCommandHandler( "cursorAlpha",
function ()
if ( isCursorShowing ( ) ) then
outputChatBox( "The cursor alpha: "..getCursorAlpha( ) )
else
outputChatBox( "The cursor is not showing!" )
end
end
)