IsCursorShowing: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(added examples)
Line 36: Line 36:
showCursor ( thePlayer, oppositeState )            -- set it as the new cursor state
showCursor ( thePlayer, oppositeState )            -- set it as the new cursor state
end
end
</syntaxhighlight>
</section>
<section name="Clientside Example" class="client" show="true">
With little of tweaking this can also be used clientside
<syntaxhighlight lang="lua">
function toggleCursor ()
        local currentState = isCursorShowing ()  -- get the current cursor state as a boolean
        local oppositeState = not currentState              -- get the new state as its logical opposite
        showCursor ( oppositeState )            -- set it as the new cursor state
end
</syntaxhighlight>
And a more compact version
<syntaxhighlight lang="lua">
[lua]
bindKey ("b", "down",                            -- binds B key to toggle cursor state
        function()
                showCursor( not isCursorShowing() )
        end
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Revision as of 12:18, 14 July 2008

This function is used to determine whether or not a player's cursor is showing.

Note that this retrieves the cursor state that has been set using showCursor, and thus doesn't take into account the cursor shown while the chatbox, menu or console are open. Also, keep in mind that while the client is aware of cursor states set from the server, the server doesn't know about cursor states set from the client.

Syntax

Click to collapse [-]
Server
bool isCursorShowing ( player thePlayer )

Required Arguments

  • thePlayer: The player you want to get cursor state of.

Returns

Returns true if the player's cursor is showing, false if it isn't or if invalid parameters were passed.

Click to collapse [-]
Client
bool isCursorShowing ( )

Returns

Returns true if the player's cursor is showing, false if it isn't or if invalid parameters were passed.

Example

Click to collapse [-]
Example

This serverside function toggles a player's cursor state.

function toggleCursor ( thePlayer )
	local currentState = isCursorShowing ( thePlayer )  -- get the current cursor state as a boolean
	local oppositeState = not currentState              -- get the new state as its logical opposite
	showCursor ( thePlayer, oppositeState )             -- set it as the new cursor state
end
Click to collapse [-]
Clientside Example

With little of tweaking this can also be used clientside

function toggleCursor ()
        local currentState = isCursorShowing ()  -- get the current cursor state as a boolean
        local oppositeState = not currentState              -- get the new state as its logical opposite
        showCursor ( oppositeState )             -- set it as the new cursor state
end

And a more compact version

[lua]
bindKey ("b", "down",                            -- binds B key to toggle cursor state
        function()
                showCursor( not isCursorShowing() )
        end

See Also