GetCursorAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{client function}}
{{Client function}}
This function is used to get alpha (transparency) from the client's cursor.
This function is used to get the client's cursor alpha (transparency).


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getCursorAlpha( )
int getCursorAlpha ( )
</syntaxhighlight>
</syntaxhighlight>
 
[[File:SetCursorAlpha.jpg|thumb|example of cursor alpha]]
===Returns===
===Returns===
Returns a int, 0-255, where 255 is fully opaque and 0 is fully transparent.
Returns a [[int]] between 0 and 255, where 255 is fully opaque and 0 is fully transparent.
 
==Requirements==
{{Requirements|n/a|1.3.2}}


==Example==
==Example==
Line 28: Line 25:


==See Also==
==See Also==
{{GUI_functions}}
{{Cursor_functions|client}}
 
[[hu:getCursorAlpha]]

Latest revision as of 17:11, 7 November 2024

This function is used to get the client's cursor alpha (transparency).

Syntax

int getCursorAlpha ( )
example of cursor alpha

Returns

Returns a int between 0 and 255, where 255 is fully opaque and 0 is fully transparent.

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
)

See Also