SetCursorAlpha: 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|5242|
{{New feature/item|3.0140|1.3.2|5340|
This function is used to change alpha (transparency) from the client's cursor.
This function is used to change alpha (transparency) from the client's cursor.
}}
}}
Line 10: Line 10:


===Required Arguments===
===Required Arguments===
*'''alpha ''': The alpha value to set. Value can be 0-1, where 1 is fully opaque and 0 is fully transparent.
*'''alpha ''': The alpha value to set. Value can be 0-255, where 255 is fully opaque and 0 is fully transparent.


===Returns===
===Returns===
Line 25: Line 25:
         -- Show the cursor if it is not showing or hide the cursor if it is
         -- Show the cursor if it is not showing or hide the cursor if it is
         showCursor( not isCursorShowing ( ) )
         showCursor( not isCursorShowing ( ) )
         -- Set the alpha to 0.5
         -- Set the alpha to 100
         setCursorAlpha( 0.5 )
         setCursorAlpha( 100 )
     end
     end
)
)

Revision as of 23:58, 1 May 2013

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

Syntax

bool setCursorAlpha( float 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.4

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.4" />

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

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows