fix: _G -> Globals; feat: (re-)implement index page always visible

Author: DecibillyJoel

_G.lua Globals.lua_G.lua renamed to Globals.lua

@@ -11,9 +11,9 @@ layerNum = 1
 --- The alpha of the art layer, represented by a number in the range of 0 - 1. An alpha of 0 means the layer is completely transparent; 1 means fully visible. By default 1.
 alpha = 1
 
---- The blend mode of the art layer. Use @{_G.BlendMode|BlendMode} enum values. By default `BlendMode.NORMAL`.
+--- The blend mode of the art layer. Use @{Globals.BlendMode|BlendMode} enum values. By default `BlendMode.NORMAL`.
 --- Not all blend modes are guaranteed to have any effect when used by art layers
---- @see _G.BlendMode
+--- @see Globals.BlendMode
 blendMode = "normal"
 
 --- Whether or not the art layer was destroyed. Calling `destroy` sets this to true. Read-only.

artlayer.lua

@@ -21,7 +21,7 @@ ypos = 0
 --- Provides the broken block, the side from which it was broken, and the reason;
 --- the reason may be either a Projectile, a Player (which may also be a LocalPlayer), or nil
 --- @see eventlistener
---- @see _G.instanceof
+--- @see Globals.instanceof
 --- @usage game.level.getBlockAt(5, 7).onBreak.addListener(function(event)
 ----     event.cancelled = true --Prevents the block from breaking
 ----     
@@ -78,7 +78,7 @@ end
 --- @usage block.bulkteleportto(false, true, 0, -7, 0, -8, 1, -8, 0, -8)
 --- @usage block.bulkteleportto(false, true, tovararg({{x = 0, y = -7}, {x = 0, y = -8}, {x = 1, y = -8}, {x = 1, y = -7}}))
 --- @see teleportto
---- @see _G.tovararg
+--- @see Globals.tovararg
 function bulkteleportto(removecurrentblock, removetargetspot, ...)
 end
 

block.lua

@@ -1,7 +1,7 @@
 file = "./"
 project = "PR3R Lua"
 title = "PR3R Lua Documentation"
-description = "Platform Racing 3 is two-dimensional online racing game. Create your own levels and blocks, or play levels created by other players! Feature rich tools to make your vision come true! Draw amazing art or create unique consepts using different combinations of block types!"
+full_description = "Platform Racing 3 is two-dimensional online racing game. Create your own levels and blocks, or play levels created by other players! Feature rich tools to make your vision come true! Draw amazing art or create unique consepts using different combinations of block types!"
 format = "markdown"
 output = "index"
 dir = "../PR3-Doc/" -- This is relative to working directory from which LDoc is called, NOT the source directory LDoc is reading from
@@ -15,10 +15,17 @@ wrap = true
 sort_modules = false -- Custom sorting is implemented in postprocess_html
 
 --- Modifies the display name for a reference link.
---- @param item string
---- @param default_handler function
+--- @param item string The item whose display name is being modified
+--- @param default_handler function The default display_name function
+--- @return string newName The new display name
 custom_display_name_handler = function(item, default_handler)
-    return default_handler(item):gsub("^_G%.", ""):gsub("^_G$", "Globals")
+    -- The display name of the item
+    local name = default_handler(item)
+    
+    -- Replace "Globals.xyz" with "xyz"
+    name = name:gsub("^Globals%.", "")
+
+    return name
 end
 
 --- Postprocesses the HTML generated by LDoc.

config.ld

@@ -115,7 +115,7 @@ end
 ---- for i, v in pairs(players) do
 ----     v.setmetadata("index", i)
 ---- end
---- @see _G.tovararg
+--- @see Globals.tovararg
 --- @see remoteplayer
 function getAllPlayers()
 end

game.lua

@@ -71,11 +71,12 @@
 #   end
 # end
 
-# if not ldoc.single and module then -- reference back to project index
+# -- 'if' and 'end' are commented out to always show the index
+# -- if not ldoc.single and module then -- reference back to project index
 <ul>
-  <li><a href="../$(ldoc.output).html">Index</a></li>
+  <li><a href="../$(ldoc.output).html">Documentation</a></li>
 </ul>
-# end
+# -- end
 
 # --------- contents of module -------------
 # if module and not ldoc.no_summary and #module.items > 0 then

ldoc.ltp

@@ -22,7 +22,7 @@ end
 
 --- Gets a list of all blocks existing in the level.
 --- @return An AS3 array of all blocks in the level.
---- @see _G.totable
+--- @see Globals.totable
 --- @usage local blocks = totable(game.level.getAllBlocks()) 
 ---- for i, v in pairs(blocks) do
 ----     v.setmetatable("index", i)

level.lua

@@ -620,7 +620,7 @@ end
 ---     + !typename: (***string***) the full item name. (e.g. "lasergun", "bow", etc.)
 --- 
 --- @see giveitem
---- @see _G.totable
+--- @see Globals.totable
 function getitem()
 end
 
@@ -752,7 +752,7 @@ end
 --- @tparam int keycode The specified key that is being checked.
 --- @return Returns true if pressed, otherwise false.
 --- @usage local Zpressed = tolua(player.keypressed(keys.Z))
---- @see _G.keys
+--- @see Globals.keys
 function keypressed(keycode)
 end
 

player.lua

@@ -2,6 +2,6 @@
 ...
 
 --- The shooter.
---- May be either a @{_G.Player|Player} (which may also be a @{_G.LocalPlayer|LocalPlayer}) or nil.
---- @see _G.Player
+--- May be either a @{Globals.Player|Player} (which may also be a @{Globals.LocalPlayer|LocalPlayer}) or nil.
+--- @see Globals.Player
 shooter = nil

projectile.lua

@@ -46,8 +46,8 @@ greenOffset = 0
 --- A number value from -255 to 255 that is added to the alpha channel after it is multiplied by blueMultiplier. By default 0.
 blueOffset = 0
 
---- The blend mode of the sprite. Use @{_G.BlendMode|BlendMode} enum values. By default `BlendMode.NORMAL`.
---- @see _G.BlendMode
+--- The blend mode of the sprite. Use @{Globals.BlendMode|BlendMode} enum values. By default `BlendMode.NORMAL`.
+--- @see Globals.BlendMode
 blendMode = "normal"
 
 --- Whether or not the sprite was destroyed. Calling `destroy` sets this to true. Read-only.
@@ -110,9 +110,9 @@ end
 ---- * !interpolationMethod: (***string***) Which color space interpolation method to use. Use ColorInterpolationMethod.RGB or ColorInterpolationMethod.LINEAR_RGB. By default ColorInterpolationMethod.RGB.
 ---- 
 --- @see endFill
---- @see _G.GradientType
---- @see _G.GradientSpreadMethod
---- @see _G.ColorInterpolationMethod
+--- @see Globals.GradientType
+--- @see Globals.GradientSpreadMethod
+--- @see Globals.ColorInterpolationMethod
 --- @usage local colors = toarray{0xFF0000FF, 0xFFFFFFFF} -- The gradient will be blue on the left and white on the right
 ---- local ratios = toarray{0.3 * 255, 1 * 255} -- The gradient will be fully blue up to 30% of the way through the fill, then transition from blue to white across the remaining 70%
 ---- someSprite.beginGradientFill(colors, ratios, toobject{type = GradientType.LINEAR, width = 100, height = 200}) -- The width and height of the gradient box will now match that of our next draw call.
@@ -183,13 +183,13 @@ end
 ----     
 ----     + !horizontal: Do not scale the line thickness if the sprite is scaled only horizontally and not vertically.
 ---- 
----- * !caps: (***string***) The type of caps at the end of lines drawn with this line style. Use @{_G.CapsStyle|CapsStyle} enum values. By default `CapsStyle.ROUND`.
+---- * !caps: (***string***) The type of caps at the end of lines drawn with this line style. Use @{Globals.CapsStyle|CapsStyle} enum values. By default `CapsStyle.ROUND`.
 ---- 
----- * !joints: (***string***) The type of joint appearance at the angles formed by lines drawn with this line style. Use @{_G.JointStyle|JointStyle} enum values. By default `JointStyle.ROUND`. When using JointStyle.MITER, the length of miters is limited by the `miterLimit` parameter.
+---- * !joints: (***string***) The type of joint appearance at the angles formed by lines drawn with this line style. Use @{Globals.JointStyle|JointStyle} enum values. By default `JointStyle.ROUND`. When using JointStyle.MITER, the length of miters is limited by the `miterLimit` parameter.
 ---- 
 ---- * !miterLimit: (***int***) The maximum length, in pixels, of mitered joints used for the angles formed by lines drawn with this line style. By default 3. This value is clamped between 1 and 255.
---- @see _G.CapsStyle
---- @see _G.JointStyle
+--- @see Globals.CapsStyle
+--- @see Globals.JointStyle
 --- @usage someSprite.lineStyle(0xFFFF0000, 5) -- Draw a solid red line with a thickness of 5 pixels
 ---- someSprite.lineTo(000, 100) -- Draw the line from (0, 0) to (0, 100)
 ---- someSprite.lineStyle(0xFF000000, 1) -- Draw a solid black line with a thickness of 1 pixel
@@ -228,9 +228,9 @@ end
 ---- * !interpolationMethod: (***string***) Which color space interpolation method to use. Use ColorInterpolationMethod.RGB or ColorInterpolationMethod.LINEAR_RGB. By default ColorInterpolationMethod.RGB.
 ---- 
 --- @see endFill
---- @see _G.GradientType
---- @see _G.GradientSpreadMethod
---- @see _G.ColorInterpolationMethod
+--- @see Globals.GradientType
+--- @see Globals.GradientSpreadMethod
+--- @see Globals.ColorInterpolationMethod
 --- @usage local colors = toarray{0xFF0000FF, 0xFFFFFFFF} -- The gradient will be blue on the left and white on the right
 ---- local ratios = toarray{0.3 * 255, 1 * 255} -- The gradient will be fully blue up to 30% of the way through the fill, then transition from blue to white across the remaining 70%
 ---- someSprite.lineStyle(0,24)
@@ -333,7 +333,7 @@ end
 --- @tparam string commands A string containing all of the commands for the path, e.g "M 100 100 L 250.5 -130.221 L 300 300 L 100 100". A command string can be built with the GraphicsPathCommand helper.
 --- @tparam string winding A string defining the winding for the path. Use GraphicsPathWinding.EVEN_ODD or GraphicsPathWinding.NON_ZERO. By default GraphicsPathWinding.EVEN_ODD.
 --- @see GraphicsPathCommand
---- @see _G.GraphicsPathWinding
+--- @see Globals.GraphicsPathWinding
 --- @usage local path = GraphicsPathCommand.new().moveTo(100,100).lineTo(250.5,-130.221).lineTo(300,300).lineTo(100,100).toString()
 ---- someSprite.drawPath(path, GraphicsPathWinding.NON_ZERO)
 function drawPath(commands, winding)
@@ -414,7 +414,7 @@ end
 ---- 
 ---- * !wordWrap: (***bool***) Whether or not the text should be word wrapped within the text field's size. By default false.
 ---- 
---- @see _G.TextFormatAlign
+--- @see Globals.TextFormatAlign
 --- @usage someSprite.addText(string.rep("Hello, world! ", 30), 0, 0, 0xFFFFAA00, 14, toobject{bold = true, wordWrap = true, width = 150, align = TextFormatAlign.CENTER}) -- Creates orange text at (0, 0), word-wrapping with a width of 150 pixels.
 function addText(text, x, y, color, size, vars)
 end