SetCursorAlpha

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

Syntax

bool setCursorAlpha( int alpha )

example of cursor 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.

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 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
)

See Also

• getCursorAlpha
• getCursorPosition
• setCursorAlpha
• setCursorPosition


• Shared
• isCursorShowing
• showCursor