GetCursorAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{client function}}
{{client function}}
{{New feature/item|3.0140|1.4|5248|
{{New feature/item|3.0140|1.3.2|5340|
This function is used to get alpha (transparency) from the client's cursor.
This function is used to get alpha (transparency) from the client's cursor.
}}
}}
Line 6: Line 6:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float getCursorAlpha( )
int getCursorAlpha( )
</syntaxhighlight>
</syntaxhighlight>


===Returns===
===Returns===
Returns a float (0-1) indicating the cursor's alpha
Returns a int, 0-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==

Revision as of 00:00, 2 May 2013

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

Syntax

int getCursorAlpha( )

Returns

Returns a int, 0-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