GetCursorAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Example added)
No edit summary
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{client function}}
{{Client function}}
{{New feature/item|3.0132|1.4|5248|
This function is used to get the client's cursor alpha (transparency).
This function is used to get alpha (transparency) from the client's cursor.
}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float getCursorAlpha( )
int getCursorAlpha ( )
</syntaxhighlight>
</syntaxhighlight>


===Returns===
===Returns===
Returns a float (0-255) indicating the cursor's alpha
Returns a [[int]] between 0 and 255, where 255 is fully opaque and 0 is fully transparent.


==Requirements==
==Requirements==
{{Requirements|n/a|1.4}}
{{Requirements|n/a|1.3.2}}


==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Simple command to test setCursorAlpha function
-- Simple command to test the getCursorAlpha function
addCommandHandler( "cursorAlpha",  
addCommandHandler( "cursorAlpha",  
     function ()
     function ()
Line 31: Line 29:
==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[hu:getCursorAlpha]]

Latest revision as of 16:50, 27 November 2021

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

Minimum server version n/a
Minimum client version 1.3.2

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
)

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows