This function determines the state of a player's cursor.

Caution

This function only handles the cursor state set by the showCursor function, ignoring it if the console, chatbox, or menu is opened.

Caution

If you use this function on the server-side, keep in mind that it only detects the showCursor function executed on the server-side and not changes done by client-side.

Client Syntax

bool isCursorShowing ( )

Returns

• bool: result

Returns true if the player's cursor is visible, and false if it is not.

Server Syntax

bool isCursorShowing ( player playerElement )

Required Arguments

• playerElement: The player from whom we want to retrieve the cursor state.

Returns

• bool: result

Returns true if the player's cursor is visible, and false if it is not.

Code Examples

Example 1 Example 2 Example 3 Example 4 Example 5 Example 6

client - Toggle Cursor

This example creates a function to set the state of the player's cursor using the showCursor function.

function toggleCursor()
    local cursorState = isCursorShowing() -- Retrieve the state of the player's cursor
    local cursorStateOpposite = not cursorState -- The logical opposite of the cursor state

    showCursor(cursorStateOpposite) -- Setting the new cursor state
end

client - Toggle Cursor (Advanced)

If you are already advanced in scripting, using this code is recommended, as it is much more compact:

function toggleCursor()
    showCursor(not isCursorShowing())
end

client - Toggle Cursor by bound key

This example creates a function that allows the player to change the state of the cursor using the showCursor and bindKey functions.

function toggleCursor()
    local cursorState = isCursorShowing() -- Retrieve the state of the player's cursor
    local cursorStateOpposite = not cursorState -- The logical opposite of the cursor state

    showCursor(cursorStateOpposite) -- Setting the new cursor state
end

bindKey("m", "down", toggleCursor) -- Assigning our toggleCursor function to the 'm' key press.

client - Toggle Cursor by bound key (Advanced)

If you are already advanced in scripting, using this code is recommended, as it is much more compact:

bindKey("m", "down",
    function()
        showCursor(not isCursorShowing())
    end
)

server

This example creates a function to set the state of the player's cursor using the showCursor function.

function toggleCursor(playerElement)
    if playerElement and isElement(playerElement) then -- Check whether the given element exists
        local cursorState = isCursorShowing(playerElement) -- Retrieve the state of the player's cursor
        local cursorStateOpposite = not cursorState -- The logical opposite of the cursor state

        showCursor(playerElement, cursorStateOpposite) -- Setting the new cursor state
    end
end

server

This example creates a function that gets the state of the player's cursor and outputs it to the chatbox using the outputChatBox function.

function outputCursor(playerElement)
    if playerElement and isElement(playerElement) then -- Check whether the given element exists
        local cursorState = isCursorShowing(playerElement) -- Retrieve the state of the player's cursor
        local cursorStateText = cursorState and "visible" or "hidden" -- Calculate the context from the boolean variable.

        outputChatBox("Your cursor is " .. cursorStateText .. ".", playerElement) -- Output the text in the chatbox according to the cursor state.
    end
end

See Also

Cursor Functions

• isCursorShowing
• showCursor
• getCursorAlpha
• setCursorAlpha
• getCursorPosition
• setCursorPosition

Reference

• Scripting Functions