Cursor functions

FileEX · FileEX · commit 27c22fff57e1 · 2025-12-06T22:12:38.000+01:00
diff --git a/functions/Cursor/examples/getCursorAlpha-1.lua b/functions/Cursor/examples/getCursorAlpha-1.lua
@@ -1,10 +1,8 @@
 -- 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
+addCommandHandler("cursorAlpha", function()
+    if (isCursorShowing()) then
+        outputChatBox("The cursor alpha: " .. getCursorAlpha())
+    else
+        outputChatBox("The cursor is not showing!")
     end
-)
+end)
diff --git a/functions/Cursor/examples/getCursorAlpha.lua b/functions/Cursor/examples/getCursorAlpha.lua
diff --git a/functions/Cursor/examples/getCursorPosition-1.lua b/functions/Cursor/examples/getCursorPosition-1.lua
@@ -5,10 +5,10 @@ function cursorInfo()
         local screenx, screeny, worldx, worldy, worldz = getCursorPosition()
 
         -- make the accuracy of floats 4 decimals and print to chatbox
-        outputChatBox( string.format( "Cursor screen position (relative): X=%.4f Y=%.4f", screenx, screeny ) )
-        outputChatBox( string.format( "Cursor world position: X=%.4f Y=%.4f Z=%.4f", worldx, worldy, worldz ) )
+        outputChatBox(string.format("Cursor screen position (relative): X=%.4f Y=%.4f",screenx, screeny))
+        outputChatBox(string.format("Cursor world position: X=%.4f Y=%.4f Z=%.4f", worldx,worldy, worldz))
     else
-        outputChatBox( "Your cursor is not showing." )
+        outputChatBox("Your cursor is not showing.")
     end
 end
-addCommandHandler( "cursorpos", cursorInfo )
+addCommandHandler("cursorpos", cursorInfo)
diff --git a/functions/Cursor/examples/getCursorPosition-2.lua b/functions/Cursor/examples/getCursorPosition-2.lua
diff --git a/functions/Cursor/examples/isCursorShowing-6.lua b/functions/Cursor/examples/isCursorShowing-6.lua
@@ -1,5 +1,3 @@
-bindKey("m", "down",
-    function()
-        showCursor(not isCursorShowing())
-    end
-)
+bindKey("m", "down", function()
+    showCursor(not isCursorShowing())
+end)
diff --git a/functions/Cursor/examples/setCursorAlpha-1.lua b/functions/Cursor/examples/setCursorAlpha-1.lua
@@ -1,9 +1,7 @@
 -- 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
-)
+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)
diff --git a/functions/Cursor/examples/setCursorAlpha.lua b/functions/Cursor/examples/setCursorAlpha.lua
@@ -1,9 +1,7 @@
-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
-)
+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)
diff --git a/functions/Cursor/examples/setCursorPosition-1.lua b/functions/Cursor/examples/setCursorPosition-1.lua
@@ -1,10 +1,10 @@
 function centerCursorFunction()
-    local showing = isCursorShowing ()
+    local showing = isCursorShowing()
     if showing then -- if the cursor is showing
-        local screenX, screenY = guiGetScreenSize () --get the screen size in pixels
-        setCursorPosition (screenX/2, screenY/2) --set the cursor position to the center of the screen
+        local screenX, screenY = guiGetScreenSize() -- get the screen size in pixels
+        setCursorPosition(screenX / 2, screenY / 2) -- set the cursor position to the center of the screen
     else
-        outputChatBox( "Your cursor is not showing." )
+        outputChatBox("Your cursor is not showing.")
     end
 end
-addCommandHandler( "cursorpos", centerCursorFunction )
+addCommandHandler("cursorpos", centerCursorFunction)
diff --git a/functions/Cursor/examples/setCursorPosition.lua b/functions/Cursor/examples/setCursorPosition.lua
@@ -1,13 +1,13 @@
 function centerCursorFunction()
     -- is cursor showing?
     if isCursorShowing() then
-        --get the screen size in pixels
-        local screenX, screenY = guiGetScreenSize ()
+        -- get the screen size in pixels
+        local screenX, screenY = guiGetScreenSize()
 
-        --set the cursor position to the center of the screen
-        setCursorPosition (screenX/2, screenY/2)
+        -- set the cursor position to the center of the screen
+        setCursorPosition(screenX / 2, screenY / 2)
     else
-        outputChatBox( "Your cursor is not showing." )
+        outputChatBox("Your cursor is not showing.")
     end
 end
-addCommandHandler( "cursorpos", centerCursorFunction )
+addCommandHandler("cursorpos", centerCursorFunction)
diff --git a/functions/Cursor/examples/showCursor-1.lua b/functions/Cursor/examples/showCursor-1.lua
@@ -1,7 +1,7 @@
-local thePlayer = getPlayerFromName ( "Dave" )              -- get the player named Dave
-if thePlayer then                                           -- if we got him
-    showCursor ( thePlayer, true )                          -- make his cursor show
-    if isCursorShowing ( thePlayer ) then                   -- did it show?
-        outputChatBox ( "Cursor is now showing for Dave." ) -- print a message to the chat box
+local thePlayer = getPlayerFromName("Dave") -- get the player named Dave
+if thePlayer then -- if we got him
+    showCursor(thePlayer, true) -- make his cursor show
+    if isCursorShowing(thePlayer) then -- did it show?
+        outputChatBox("Cursor is now showing for Dave.") -- print a message to the chat box
     end
 end
diff --git a/functions/Cursor/examples/showCursor-2.lua b/functions/Cursor/examples/showCursor-2.lua
@@ -1,2 +1,2 @@
-showCursor ( true ) -- shows cursor
-showCursor ( false ) -- hides cursor
+showCursor(true) -- shows cursor
+showCursor(false) -- hides cursor
diff --git a/functions/Cursor/getCursorAlpha.yaml b/functions/Cursor/getCursorAlpha.yaml
@@ -1,11 +1,9 @@
 client:
   name: 'getCursorAlpha'
   pair: 'setCursorAlpha'
-  description: |
-    This function is used to get the client's cursor alpha (transparency).
+  description: This function is used to get the client's cursor alpha (transparency).
   preview_images:
   - path: 'cursor-alpha.jpg'
-    width: 160
     description: 'Visual representation of the cursor alpha:'
   returns:
     description: |
@@ -14,8 +12,6 @@ client:
       - type: 'int'
         name: 'alpha'
   examples:
-    - path: 'examples/getCursorAlpha.lua'
+    - path: 'examples/getCursorAlpha-1.lua'
       description: |
-        This example prints the cursor alpha to chatbox using */cursoralpha* command:
-  meta:
-  - needs_checking: Hello, world
+        This example prints the cursor alpha to chatbox using <code>/cursoralpha</code> command:
diff --git a/functions/Cursor/getCursorPosition.yaml b/functions/Cursor/getCursorPosition.yaml
@@ -3,15 +3,17 @@ client:
   pair: 'setCursorPosition'
   description: |
     This function gets the current position of the mouse cursor.
-    Note that for performance reasons, the world position returned is always 300 units away.
-    If you want the exact world point (similar to [onClientClick](/onClientClick)), use [processLineOfSight](/processLineOfSight) between the camera position and the world x/y/z result of this function.
-    (See example below) 
+  notes:
+    - type: info
+      content: |
+        - If you want the exact world point (similar to [[onClientClick]]), use [[processLineOfSight]] between the camera position and the world x/y/z result of this function.
+        - For performance reasons, the world position returned is always 300 units away.
   returns:
     description: |
       Returns 5 values: *cursorX*, *cursorY*, *worldX*, *worldY*, *worldZ*.
       The first two values are the 2D **relative** screen coordinates of the cursor.
       The last 3 values are the 3D world map coordinates that the cursor points at.
-      If the cursor isn't showing, returns *false* as the first value.
+      If the cursor isn't showing, returns **false** as the first value.
     values:
       - type: 'float|false'
         name: 'cursorX'
@@ -23,13 +25,6 @@ client:
         name: 'worldY'
       - type: 'float'
         name: 'worldZ'
-  issues:
-    - id: 1166
-      description: 'getCursorPosition() returns false even when cursor is showing due to opened console'
   examples:
     - path: 'examples/getCursorPosition-1.lua'
-      description: |
-        This example prints your cursors current world coordinates and relative screen coordinates to chatbox after using */cursorpos* command.
-    - path: 'examples/getCursorPosition-2.lua'
-      description: |
-        This (untested) example uses [processLineOfSight](/processLineOfSight) to calculate the exact world location: Warning, this script causes high CPU usage!
+      description: This example prints your cursors current world coordinates and relative screen coordinates to chatbox after using <code>/cursorpos</code> command.
diff --git a/functions/Cursor/isCursorShowing.yaml b/functions/Cursor/isCursorShowing.yaml
@@ -1,15 +1,14 @@
 shared: &shared
   name: 'isCursorShowing'
-  description: |
-    This function determines the state of a [player](/player)'s cursor.
+  description: This function determines the state of a [[player]]'s cursor.
   notes:
-    - type: 'warning'
-      content: 'This function only handles the cursor state set by the [showCursor](/showCursor) function, ignoring it if the console, chatbox, or menu is opened.'
-    - type: 'warning'
-      content: 'If you use this function on the server-side, keep in mind that it only detects the [showCursor](/showCursor) function executed on the server-side and not changes done by client-side.'
+    - type: 'info'
+      content: |
+        - This function only handles the cursor state set by the [[showCursor]] function, ignoring it if the console, chatbox, or menu is opened.
+        - 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.
   returns:
     description: |
-      Returns *true* if the [player](/player)'s cursor is visible, and *false* if it is not.
+      Returns **true** if the [[player]]'s cursor is visible, and **false** if it is not.
     values:
       - type: 'bool'
         name: 'result'
@@ -19,21 +18,21 @@ server:
   parameters:
     - name: 'playerElement'
       type: 'player'
-      description: 'The [player](/player) from whom we want to retrieve the cursor state.'
+      description: 'The [[player]] from we want to retrieve the cursor state.'
   examples:
     - path: 'examples/isCursorShowing-1.lua'
       description: |
-        This example creates a function to set the state of the [player](/player)'s cursor using the [showCursor](/showCursor) function.
+        This example creates a function to set the state of the [[player]]'s cursor using the [[showCursor]] function.
     - path: 'examples/isCursorShowing-2.lua'
       description: |
-        This example creates a function that gets the state of the [player](/player)'s cursor and outputs it to the chatbox using the [outputChatBox](/outputChatBox) function.
+        This example creates a function that gets the state of the [[player]]'s cursor and outputs it to the chatbox using the [[outputChatBox]] function.
 
 client:
   <<: *shared
   examples:
     - path: 'examples/isCursorShowing-3.lua'
       description: |
-        This example creates a function to set the state of the [player](/player)'s cursor using the [showCursor](/showCursor) function. 
+        This example creates a function to set the state of the [[player]]'s cursor using the [[showCursor]] function. 
       title: 'Toggle Cursor'
     - path: 'examples/isCursorShowing-4.lua'
       description: |
@@ -42,7 +41,7 @@ client:
       title: 'Toggle Cursor (Advanced)'
     - path: 'examples/isCursorShowing-5.lua'
       description: |
-        This example creates a function that allows the [player](/player) to change the state of the cursor using the [showCursor](/showCursor) and [bindKey](/bindKey) functions. 
+        This example creates a function that allows the [[player]] to change the state of the cursor using the [[showCursor]] and [[bindKey]] functions. 
       title: 'Toggle Cursor by bound key'
     - path: 'examples/isCursorShowing-6.lua'
       description: |
diff --git a/functions/Cursor/setCursorAlpha.yaml b/functions/Cursor/setCursorAlpha.yaml
@@ -12,11 +12,11 @@ client:
       description: 'The alpha value to set. Value can be in between 0 and 255, where 255 is fully opaque and 0 is fully transparent.'
   returns:
     description: |
-      Returns *true* if the new alpha value was set, or *false* otherwise.
+      Returns **true** if the new alpha value was set, or **false** otherwise.
     values:
       - type: 'bool'
         name: 'result'
   examples:
     - path: 'examples/setCursorAlpha.lua'
       description: |
-        This example sets the cursor alpha to 100 using */cursoralpha* command:
+        This example sets the cursor alpha to 100 using <code>/cursoralpha</code> command:
diff --git a/functions/Cursor/setCursorPosition.yaml b/functions/Cursor/setCursorPosition.yaml
@@ -5,16 +5,16 @@ client:
   parameters:
     - name: 'cursorX'
       type: 'int'
-      description: 'Position for the X axis'
+      description: 'Position for the X axis.'
     - name: 'cursorY'
       type: 'int'
-      description: 'Position for the Y axis'
+      description: 'Position for the Y axis.'
   returns:
-    description: 'Returns *true* if the position has been successfully set, *false* otherwise.'
+    description: 'Returns **true** if the position has been successfully set, **false** otherwise.'
     values:
       - type: 'bool'
         name: 'result'
   examples:
     - path: 'examples/setCursorPosition.lua'
       description: |
-        This example sets your cursor position to the center of your screen after using the */cursorpos* command.
+        This example sets your cursor position to the center of your screen after using the <code>/cursorpos</code> command.
diff --git a/functions/Cursor/showCursor.yaml b/functions/Cursor/showCursor.yaml
@@ -1,16 +1,16 @@
 shared: &shared
   name: 'showCursor'
   description: |
-    This function is used to show or hide a [player](/player)'s cursor. 
+    This function is used to show or hide a [[player]]'s cursor. 
   notes:
-    - type: 'warning'
-      content: 'Regardless of the cursor state you set using this function, the cursor will always be visible while the menu, the chatbox input line or the console are active, or if another resource has called this function.'
-    - type: 'warning'
-      content: "Be aware of that if showCursor is enabled by a resource, you can't disabled it from a different ressource! `showCursor(false)` will not work, in order to make it work, disable it from the original resource that enabled it or use an export."
+    - type: 'info'
+      content: |
+        - Regardless of the cursor state you set using this function, the cursor will **always** be visible while the menu, the chatbox input line or the console are active, or if another resource has called this function.
+        - Be aware of that if [[showCursor]] is enabled by a resource, you can't disabled it from a different ressource! `showCursor(false)` will not work, in order to make it work, disable it from the original resource that enabled it or use an export.
   parameters:
     - name: 'thePlayer'
       type: 'player'
-      description: 'The [player](/player) you want to show or hide the cursor of.'
+      description: 'The [[player]] you want to show or hide the cursor of.'
     - name: 'show'
       type: 'bool'
       description: 'A boolean value determining whether to show (*true*) or hide (*false*) the cursor.'
@@ -21,7 +21,7 @@ shared: &shared
       default: 'true'
   returns:
     description: |
-      Returns *true* if the player's cursor was shown or hidden successfully, *false* otherwise. 
+      Returns **true** if the player's cursor was shown or hidden successfully, **false** otherwise. 
     values:
       - type: 'bool'
         name: 'result'
