doc update

docs/lua_api/gfx.lua

@@ -472,7 +472,7 @@ UpdateImagePattern = function(pattern, sx, sy, ix, iy, angle, alpha) end
 ---@param size? integer
 UpdateLabel = function(label, text, size) end
 
----@type table
+---@class gfx
 gfx = {
   BLEND_ZERO = 1,
   BLEND_ONE = 2,
@@ -595,4 +595,4 @@ gfx = {
   Translate = Translate,
   UpdateImagePattern = UpdateImagePattern,
   UpdateLabel = UpdateLabel,
-};
+};

docs/lua_api/shadedmesh.lua

@@ -1,117 +1,4 @@
--- Adds a texture that was loaded with `gfx.LoadSharedTexture` to the material that can be used in the shader code
+---@diagnostic disable:missing-return
----@param uniformName string
----@param textureName string
-AddSharedTexture = function(uniformName, textureName) end
-
--- Adds a texture to the material that can be used in the shader code
----@param uniformName string
----@param path string # prepended with `skins/<skin>/textures/`
-AddSkinTexture = function(uniformName, path) end
-
--- Adds a texture to the material that can be used in the shader code
----@param uniformName string
----@param path string
-AddTexture = function(uniformName, path) end
-
--- Gets the translation of the mesh
----@return number x, number y, number z
-GetPosition = function() end
-
--- Gets the rotation (in degrees) of the mesh
----@return number roll, number yaw, number pitch
-GetRotation = function() end
-
--- Gets the scale of the mesh
----@return number x, number y, number z
-GetScale = function() end
-
--- Sets the blending mode
----@param mode integer # options also available as fields of the object prefixed with `BLEND`  
--- `Normal` = 0 (default)  
--- `Additive` = 1  
--- `Multiply` = 2  
-SetBlendMode = function(mode) end
-
--- Sets the geometry data
----@param data table # array of vertices in clockwise order starting from the top left e.g.
--- ```
--- {
---   { { 0, 0 }, { 0, 0 } },
---   { { 50, 0 }, { 1, 0 } },
---   { { 50, 50 }, { 1, 1 } },
---   { { 0, 50 }, { 0, 1 } },
--- }
--- ```
-SetData = function(data) end
-
--- Sets the material is opaque or non-opaque (default)
----@param opaque boolean
-SetOpaque = function(opaque) end
-
--- Sets the value of the specified uniform
----@param uniformName string
----@param value number # `float`
-SetParam = function(uniformName, value) end
-
--- Sets the value of the specified 2d vector uniform
----@param uniformName string
----@param x number # `float`
----@param y number # `float`
-SetParamVec2 = function(uniformName, x, y) end
-
--- Sets the value of the specified 3d vector uniform
----@param uniformName string
----@param x number # `float`
----@param y number # `float`
----@param z number # `float`
-SetParamVec3 = function(uniformName, x, y, z) end
-
--- Sets the value of the specified 4d vector uniform
----@param uniformName string
----@param x number # `float`
----@param y number # `float`
----@param z number # `float`
----@param w number # `float`
-SetParamVec4 = function(uniformName, x, y, z, w) end
-
--- Sets the translation for the mesh  
--- Relative to the screen for `ShadedMesh`  
--- Relative to the center of the crit line for `ShadedMeshOnTrack`
----@param x number
----@param y number
----@param z? number # Default `0`
-SetPosition = function(x, y, z) end
-
--- Sets the format for geometry data provided by `SetData`
----@param type integer # options also available as fields of the object prefixed with `PRIM`  
--- `TriangleList` = 0 (default)  
--- `TriangleStrip` = 1  
--- `TriangleFan` = 2  
--- `LineList` = 3  
--- `LineStrip` = 4  
--- `PointList` = 5  
-SetPrimitiveType = function(type) end
-
--- Sets the rotation (in degrees) of the mesh
--- **WARNING:** For `ShadedMesh`, pitch and yaw may clip, rendering portions or the entire mesh invisible
----@param roll number
----@param yaw? number # Default `0`
----@param pitch? number # Default `0`
-SetRotation = function(roll, yaw, pitch) end
-
--- Sets the scale of the mesh
----@param x number
----@param y number
----@param z? number # Default `0`
-SetScale = function(x, y, z) end
-
--- Sets the wireframe mode of the object (does not render texture)  
--- Useful for debugging models or geometry shaders
----@param useWireframe boolean
-SetWireframe = function(useWireframe) end
-
--- Renders the `ShadedMesh` object
-Draw = function() end
 
 ---@class ShadedMesh
 ShadedMesh = {
@@ -125,57 +12,148 @@ ShadedMesh = {
   PRIM_LINELIST = 3,
   PRIM_LINESTRIP = 4,
   PRIM_POINTLIST = 5,
-
-  AddSharedTexture = AddSharedTexture,
-  AddSkinTexture = AddSkinTexture,
-  AddTexture = AddTexture,
-  Draw = Draw,
-  GetPosition = GetPosition,
-  GetRotation = GetRotation,
-  GetScale = GetScale,
-  SetBlendMode = SetBlendMode,
-  SetData = SetData,
-  SetOpaque = SetOpaque,
-  SetParam = SetParam,
-  SetParamVec2 = SetParamVec2,
-  SetParamVec3 = SetParamVec3,
-  SetParamVec4 = SetParamVec4,
-  SetPosition = SetPosition,
-  SetPrimitiveType = SetPrimitiveType,
-  SetRotation = SetRotation,
-  SetScale = SetScale,
-  SetWireframe = SetWireframe,
 };
 
--- Gets the length of the mesh
+-- Adds a texture that was loaded with `gfx.LoadSharedTexture` to the material that can be used in the shader code
----@return number length
+---@param uniformName string
-GetLength = function() end
+---@param textureName string
+function ShadedMesh:AddSharedTexture(uniformName, textureName) end
 
--- Sets the y-scale of the mesh based on its length  
+-- Adds a texture to the material that can be used in the shader code
--- Useful for creating fake buttons which may have variable length based on duration
+---@param uniformName string
----@param length number
+---@param path string # prepended with `skins/<skin>/textures/`
-ScaleToLength = function(length) end
+function ShadedMesh:AddSkinTexture(uniformName, path) end
 
--- Stops meshes beyond the track from being rendered if `doClip`
+-- Adds a texture to the material that can be used in the shader code
----@param doClip boolean
+---@param uniformName string
-SetClipWithTrack = function(doClip) end
+---@param path string
+function ShadedMesh:AddTexture(uniformName, path) end
 
--- Sets the length (in the y-direction relative to the track) of the mesh
+-- Gets the translation of the mesh
----@param length number # Optional constants: `BUTTON_TEXTURE_LENGTH`, `FXBUTTON_TEXTURE_LENGTH`, and `TRACK_LENGTH`
+---@return number x, number y, number z
-SetLength = function(length) end
+function ShadedMesh:GetPosition() end
+
+-- Gets the rotation (in degrees) of the mesh
+---@return number roll, number yaw, number pitch
+function ShadedMesh:GetRotation() end
+
+-- Gets the scale of the mesh
+---@return number x, number y, number z
+function ShadedMesh:GetScale() end
+
+-- Sets the blending mode
+---@param mode integer # options also available as fields of the object prefixed with `BLEND`  
+-- `Normal` = 0 (default)  
+-- `Additive` = 1  
+-- `Multiply` = 2  
+function ShadedMesh:SetBlendMode(mode) end
+
+-- Sets the geometry data
+---@param data table # array of vertices in clockwise order starting from the top left e.g.
+-- ```
+-- {
+--   { { 0, 0 }, { 0, 0 } },
+--   { { 50, 0 }, { 1, 0 } },
+--   { { 50, 50 }, { 1, 1 } },
+--   { { 0, 50 }, { 0, 1 } },
+-- }
+-- ```
+function ShadedMesh:SetData(data) end
+
+-- Sets the material is opaque or non-opaque (default)
+---@param opaque boolean
+function ShadedMesh:SetOpaque(opaque) end
+
+-- Sets the value of the specified uniform
+---@param uniformName string
+---@param value number # `float`
+function ShadedMesh:SetParam(uniformName, value) end
+
+-- Sets the value of the specified 2d vector uniform
+---@param uniformName string
+---@param x number # `float`
+---@param y number # `float`
+function ShadedMesh:SetParamVec2(uniformName, x, y) end
+
+-- Sets the value of the specified 3d vector uniform
+---@param uniformName string
+---@param x number # `float`
+---@param y number # `float`
+---@param z number # `float`
+function ShadedMesh:SetParamVec3(uniformName, x, y, z) end
+
+-- Sets the value of the specified 4d vector uniform
+---@param uniformName string
+---@param x number # `float`
+---@param y number # `float`
+---@param z number # `float`
+---@param w number # `float`
+function ShadedMesh:SetParamVec4(uniformName, x, y, z, w) end
+
+-- Sets the translation for the mesh  
+-- Relative to the screen for `ShadedMesh`  
+-- Relative to the center of the crit line for `ShadedMeshOnTrack`
+---@param x number
+---@param y number
+---@param z? number # Default `0`
+function ShadedMesh:SetPosition(x, y, z) end
+
+-- Sets the format for geometry data provided by `SetData`
+---@param type integer # options also available as fields of the object prefixed with `PRIM`  
+-- `TriangleList` = 0 (default)  
+-- `TriangleStrip` = 1  
+-- `TriangleFan` = 2  
+-- `LineList` = 3  
+-- `LineStrip` = 4  
+-- `PointList` = 5  
+function ShadedMesh:SetPrimitiveType(type) end
+
+-- Sets the rotation (in degrees) of the mesh
+-- **WARNING:** For `ShadedMesh`, pitch and yaw may clip, rendering portions or the entire mesh invisible
+---@param roll number
+---@param yaw? number # Default `0`
+---@param pitch? number # Default `0`
+function ShadedMesh:SetRotation(roll, yaw, pitch) end
+
+-- Sets the scale of the mesh
+---@param x number
+---@param y number
+---@param z? number # Default `0`
+function ShadedMesh:SetScale(x, y, z) end
+
+-- Sets the wireframe mode of the object (does not render texture)  
+-- Useful for debugging models or geometry shaders
+---@param useWireframe boolean
+function ShadedMesh:SetWireframe(useWireframe) end
+
+-- Renders the `ShadedMesh` object
+function ShadedMesh:Draw() end
 
--- Uses an existing game mesh
----@param meshName string # Options: `'button'`, `'fxbutton'`, and `'track'`
-UseGameMesh = function(meshName) end
 
 ---@class ShadedMeshOnTrack : ShadedMesh
 ---@field BUTTON_TEXTURE_LENGTH number
 ---@field FXBUTTON_TEXTURE_LENGTH number
 ---@field TRACK_LENGTH number
 ShadedMeshOnTrack = {
-  GetLength = GetLength,
+};
-  UseGameMesh = UseGameMesh,
+
-  ScaleToLength = ScaleToLength,
+-- Gets the length of the mesh
-  SetClipWithTrack = SetClipWithTrack,
+---@return number length
-  SetLength = SetLength,
+function ShadedMeshOnTrack:GetLength() end
-};
+
+-- Sets the y-scale of the mesh based on its length  
+-- Useful for creating fake buttons which may have variable length based on duration
+---@param length number
+function ShadedMeshOnTrack:ScaleToLength(length) end
+
+-- Stops meshes beyond the track from being rendered if `doClip`
+---@param doClip boolean
+function ShadedMeshOnTrack:SetClipWithTrack(doClip) end
+
+-- Sets the length (in the y-direction relative to the track) of the mesh
+---@param length number # Optional constants: `BUTTON_TEXTURE_LENGTH`, `FXBUTTON_TEXTURE_LENGTH`, and `TRACK_LENGTH`
+function ShadedMeshOnTrack:SetLength(length) end
+
+-- Uses an existing game mesh
+---@param meshName string # Options: `'button'`, `'fxbutton'`, and `'track'`
+function ShadedMeshOnTrack:UseGameMesh(meshName) end