@quenty/draw 7.8.0 → 7.8.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.8.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/draw@7.8.0...@quenty/draw@7.8.1) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/draw
+
+
+
+
+
 # [7.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/draw@7.7.1...@quenty/draw@7.8.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/draw

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/draw",
-  "version": "7.8.0",
+  "version": "7.8.1",
   "description": "A utility library to debug things in 3D space for Roblox.",
   "keywords": [
     "Roblox",
@@ -32,5 +32,5 @@
     "@quenty/loader": "^10.8.0",
     "@quenty/maid": "^3.4.0"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Shared/Draw.lua

@@ -37,7 +37,7 @@ Draw._defaultColor = ORIGINAL_DEFAULT_COLOR
 	Sets the Draw's drawing color.
 	@param color Color3 -- The color to set
 ]=]
-function Draw.setColor(color)
+function Draw.setColor(color: Color3)
 	Draw._defaultColor = color
 end
 
@@ -52,44 +52,57 @@ end
 	Sets the Draw library to use a random color.
 ]=]
 function Draw.setRandomColor()
-	Draw.setColor(Color3.fromHSV(math.random(), 0.5+0.5*math.random(), 1))
+	Draw.setColor(Color3.fromHSV(math.random(), 0.5 + 0.5 * math.random(), 1))
 end
 
 --[=[
 	Draws a line between two points
 
+	```lua
+	Draw.line(Vector3.new(0, 0, 0), Vector3.new(0, 10, 0))
+	```
+
 	@param start Vector3
 	@param finish Vector3
-	@param color Color3 -- Optional
+	@param color Color3? -- Optional
 	@param parent Instance? -- Optional
-	@param diameter number -- Optional
+	@param diameter numbe? -- Optional
 	@return Instance
 ]=]
-function Draw.line(start, finish, color, parent, diameter)
+function Draw.line(start: Vector3, finish: Vector3, color: Color3Like?, parent: Instance?, diameter: number?): BasePart
 	start = assert(Draw._toVector3(start), "Bad start")
 	finish = assert(Draw._toVector3(finish), "Bad finish")
-	color = Draw._toColor3(color)
+	color = Draw._toColor3(color) or Draw._defaultColor
 
 	return Draw.ray(Ray.new(start, finish - start), color, parent, diameter)
 end
 
 --[=[
-	Draws a line between directions
+	Draws a line in a direction
+
+	```lua
+	Draw.direction(Vector3.new(0, 0, 0), Vector3.new(0, 10, 0))
+	```
 
 	@param origin Vector3
 	@param direction Vector3
 	@param color Color3 -- Optional
 	@param parent Instance? -- Optional
-	@param meshDiameter number -- Optional
-	@param diameter number -- Optional
+	@param diameter number? -- Optional
 	@return Instance
 ]=]
-function Draw.direction(origin, direction, color, parent, meshDiameter, diameter)
+function Draw.direction(
+	origin: Vector3,
+	direction: Vector3,
+	color: Color3?,
+	parent: Instance?,
+	diameter: number?
+): BasePart
 	origin = assert(Draw._toVector3(origin), "Bad origin")
 	direction = assert(Draw._toVector3(direction), "Bad direction")
 	color = Draw._toColor3(color)
 
-	return Draw.ray(Ray.new(origin, direction), color, parent, meshDiameter, diameter)
+	return Draw.ray(Ray.new(origin, direction), color, parent, diameter)
 end
 
 --[=[
@@ -100,25 +113,35 @@ end
 	that initially intersect the shape. So this draw doesn't render that initial sphere.
 	:::
 
+	```lua
+	Draw.spherecast(Vector3.new(0, 0, 0), 10, Vector3.new(0, 10, 0))
+	```
+
 	@param origin Vector3
 	@param radius number
 	@param direction Vector3
-	@param color Color3
-	@param parent Parent
+	@param color Color3?:
+	@param parent Instance?
 ]=]
-function Draw.spherecast(origin, radius, direction, color, parent)
-	origin = assert(Draw._toVector3(origin), "Bad cframe")
+function Draw.spherecast(
+	origin: Vector3Like,
+	radius: number,
+	direction: Vector3Like,
+	color: Color3Like?,
+	parent: Instance?
+): Folder
 	assert(type(radius) == "number", "Bad radius")
-	direction = assert(Draw._toVector3(direction), "Bad direction")
-	color = Draw._toColor3(color)
+	local castOrigin = assert(Draw._toVector3(origin), "Bad cframe")
+	local castDirection = assert(Draw._toVector3(direction), "Bad direction")
+	local castColor = Draw._toColor3(color) or Draw._defaultColor
 	parent = parent or Draw.getDefaultParent()
 
 	local folder = Instance.new("Folder")
 	folder.Name = "SphereCast"
 	folder.Archivable = false
 
-	Draw.ray(Ray.new(origin, direction), color, folder, 2*radius)
-	Draw.sphere(origin + direction, radius, color, folder)
+	Draw.ray(Ray.new(castOrigin, castDirection), color, folder, 2 * radius)
+	Draw.sphere(castOrigin + direction, radius, castColor, folder)
 
 	folder.Parent = parent
 
@@ -134,11 +157,17 @@ end
 	@param color Color3
 	@param parent Parent
 ]=]
-function Draw.blockcast(cframe, size, direction, color, parent)
-	cframe = assert(Draw._toCFrame(cframe), "Bad cframe")
-	size = assert(Draw._toVector3(size), "Bad size")
-	direction = assert(Draw._toVector3(direction), "Bad direction")
-	color = Draw._toColor3(color)
+function Draw.blockcast(
+	cframe: CFrameLike,
+	size: Vector3Like,
+	direction: Vector3Like,
+	color: Color3Like?,
+	parent: Instance?
+): Folder
+	local blockCFrame = assert(Draw._toCFrame(cframe), "Bad cframe")
+	local blockSize = assert(Draw._toVector3(size), "Bad size")
+	local blockDirection = assert(Draw._toVector3(direction), "Bad direction")
+	local blockColor = Draw._toColor3(color)
 	parent = parent or Draw.getDefaultParent()
 
 	local folder = Instance.new("Folder")
@@ -147,26 +176,42 @@ function Draw.blockcast(cframe, size, direction, color, parent)
 
 	-- Draw beginning and end for now...
 	-- TODO: Convex hull
-	Draw.box(cframe, size, color).Parent = folder
-	Draw.box(cframe + direction, size, color).Parent = folder
+	Draw.box(blockCFrame, blockSize, blockColor).Parent = folder
+	Draw.box(blockCFrame + blockDirection, blockSize, blockColor).Parent = folder
 
 	folder.Parent = parent
 
 	return folder
 end
 
-function Draw.triangle(a, b, c, color, parent)
-	a = assert(Draw._toVector3(a), "Bad a")
-	b = assert(Draw._toVector3(b), "Bad b")
-	c = assert(Draw._toVector3(c), "Bad c")
+--[=[
+	Draws a triangle between 3 points
+
+	@param pointA Vector3
+	@param pointB Vector3
+	@param pointC Vector3
+	@param color Color3? -- Optional color3
+	@param parent Instance? -- Optional parent
+	@return Folder
+]=]
+function Draw.triangle(
+	pointA: Vector3Like,
+	pointB: Vector3Like,
+	pointC: Vector3Like,
+	color: Color3Like?,
+	parent: Instance?
+): Folder
+	local a = assert(Draw._toVector3(pointA), "Bad a")
+	local b = assert(Draw._toVector3(pointB), "Bad b")
+	local c = assert(Draw._toVector3(pointC), "Bad c")
 	color = Draw._toColor3(color) or Draw._defaultColor
 	parent = parent or Draw.getDefaultParent()
 
 	local edges = {
-		{longest = (c - a), other = (b - a), origin = a},
-		{longest = (a - b), other = (c - b), origin = b},
-		{longest = (b - c), other = (a - c), origin = c}
-	};
+		{ longest = (c - a), other = (b - a), origin = a },
+		{ longest = (a - b), other = (c - b), origin = b },
+		{ longest = (b - c), other = (a - c), origin = c },
+	}
 
 	local edge = edges[1]
 	for i = 2, #edges do
@@ -180,26 +225,16 @@ function Draw.triangle(a, b, c, color, parent)
 	local w2 = edge.longest.magnitude - w1
 	local h = math.sin(theta) * edge.other.magnitude
 
-	local p1 = edge.origin + edge.other * 0.5;
+	local p1 = edge.origin + edge.other * 0.5
 	local p2 = edge.origin + edge.longest + (edge.other - edge.longest) * 0.5
 
 	local right = edge.longest:Cross(edge.other).unit
 	local up = right:Cross(edge.longest).unit
 	local back = edge.longest.unit
 
-	local cf1 = CFrame.new(
-		p1.x, p1.y, p1.z,
-		-right.x, up.x, back.x,
-		-right.y, up.y, back.y,
-		-right.z, up.z, back.z
-	);
+	local cf1 = CFrame.new(p1.x, p1.y, p1.z, -right.x, up.x, back.x, -right.y, up.y, back.y, -right.z, up.z, back.z)
 
-	local cf2 = CFrame.new(
-		p2.x, p2.y, p2.z,
-		right.x, up.x, -back.x,
-		right.y, up.y, -back.y,
-		right.z, up.z, -back.z
-	);
+	local cf2 = CFrame.new(p2.x, p2.y, p2.z, right.x, up.x, -back.x, right.y, up.y, -back.y, right.z, up.z, -back.z)
 
 	-- put it all together by creating the wedges
 	local triangle = Instance.new("Folder")
@@ -259,12 +294,17 @@ end
 	@param direction Vector3
 	@param color Color3 -- Optional
 	@param parent Instance? -- Optional
-	@param meshDiameter number -- Optional
-	@param diameter number -- Optional
+	@param diameter number? -- Optional
 	@return Instance
 ]=]
-function Draw.raycast(origin, direction, color, parent, meshDiameter, diameter)
-	return Draw.direction(origin, direction, color, parent, meshDiameter, diameter)
+function Draw.raycast(
+	origin: Vector3,
+	direction: Vector3,
+	color: Color3?,
+	parent: Instance?,
+	diameter: number?
+): BasePart
+	return Draw.direction(origin, direction, color, parent, diameter)
 end
 
 --[=[
@@ -281,14 +321,14 @@ end
 	@param diameter number? -- Optional diameter
 	@return BasePart
 ]=]
-function Draw.ray(ray, color, parent, diameter)
+function Draw.ray(ray: Ray, color: Color3Like?, parent: Instance?, diameter: number?): BasePart
 	assert(typeof(ray) == "Ray", "Bad typeof(ray) for Ray")
 
-	color = Draw._toColor3(color) or Draw._defaultColor
-	parent = parent or Draw.getDefaultParent()
-	diameter = diameter or 0.2
+	local rayColor = Draw._toColor3(color) or Draw._defaultColor
+	local rayParent = parent or Draw.getDefaultParent()
+	local rayDiameter = diameter or 0.2
 
-	local rayCenter = ray.Origin + ray.Direction/2
+	local rayCenter = ray.Origin + ray.Direction / 2
 	local distance = ray.Direction.Magnitude
 
 	local part = Instance.new("Part")
@@ -299,11 +339,11 @@ function Draw.ray(ray, color, parent, diameter)
 	part.CanQuery = false
 	part.CanTouch = false
 	part.CastShadow = false
-	part.CFrame = CFrame.new(rayCenter, ray.Origin + ray.Direction) * CFrame.Angles(0, math.pi/2, 0)
-	part.Color = color
+	part.CFrame = CFrame.new(rayCenter, ray.Origin + ray.Direction) * CFrame.Angles(0, math.pi / 2, 0)
+	part.Color = rayColor
 	part.Name = "DebugRay"
 	part.Shape = Enum.PartType.Cylinder
-	part.Size = Vector3.new(distance, diameter, diameter)
+	part.Size = Vector3.new(distance, rayDiameter, rayDiameter)
 	part.TopSurface = Enum.SurfaceType.Smooth
 	part.Transparency = 0.5
 
@@ -311,12 +351,12 @@ function Draw.ray(ray, color, parent, diameter)
 	cylinderHandleAdornment.Name = "CylinderHandleAdornment"
 	cylinderHandleAdornment.Height = ray.Direction.Magnitude
 	cylinderHandleAdornment.InnerRadius = 0
-	cylinderHandleAdornment.Radius = diameter/4
+	cylinderHandleAdornment.Radius = rayDiameter / 4
 	cylinderHandleAdornment.ZIndex = 3
-	cylinderHandleAdornment.Color3 = color
+	cylinderHandleAdornment.Color3 = rayColor
 	cylinderHandleAdornment.AlwaysOnTop = true
 	cylinderHandleAdornment.Transparency = 0.25
-	cylinderHandleAdornment.CFrame = CFrame.Angles(0, math.pi/2, 0)
+	cylinderHandleAdornment.CFrame = CFrame.Angles(0, math.pi / 2, 0)
 	cylinderHandleAdornment.Adornee = part
 	cylinderHandleAdornment.Parent = part
 
@@ -325,10 +365,10 @@ function Draw.ray(ray, color, parent, diameter)
 	local mesh = Instance.new("SpecialMesh")
 	mesh.MeshType = Enum.MeshType.Cylinder
 	mesh.Name = "DrawRayMesh"
-	mesh.Scale = Vector3.new(distance/partSize.x, diameter/partSize.y, diameter/partSize.z)
+	mesh.Scale = Vector3.new(distance / partSize.x, rayDiameter / partSize.y, rayDiameter / partSize.z)
 	mesh.Parent = part
 
-	part.Parent = parent
+	part.Parent = rayParent
 
 	return part
 end
@@ -350,33 +390,33 @@ end
 
 	@param rayPart Instance -- Ray part
 	@param ray Ray -- New ray
-	@param color Color3 -- New color
-	@param diameter number -- Number
+	@param color Color3? -- New color
+	@param diameter number? -- Number
 ]=]
-function Draw.updateRay(rayPart, ray, color, diameter)
+function Draw.updateRay(rayPart: BasePart, ray: Ray, color: Color3?, diameter: number?)
 	assert(typeof(rayPart) == "Instance", "Bad rayPart")
 	assert(typeof(ray) == "Ray", "Bad typeof(ray) for Ray")
-	color = Draw._toColor3(color) or rayPart.Color
-	diameter = diameter or rayPart.Size.z
+	local rayColor = Draw._toColor3(color) or rayPart.Color
+	local rayDiameter = diameter or rayPart.Size.Z
 
-	local rayCenter = ray.Origin + ray.Direction/2
+	local rayCenter = ray.Origin + ray.Direction / 2
 	local distance = ray.Direction.Magnitude
 
-	rayPart.Color = color
+	rayPart.Color = rayColor
 	rayPart.Size = Vector3.new(distance, diameter, diameter)
-	rayPart.CFrame = CFrame.new(rayCenter, ray.Origin + ray.Direction) * CFrame.Angles(0, math.pi/2, 0)
+	rayPart.CFrame = CFrame.new(rayCenter, ray.Origin + ray.Direction) * CFrame.Angles(0, math.pi / 2, 0)
 
 	local cylinderHandleAdornment = rayPart:FindFirstChildWhichIsA("CylinderHandleAdornment")
 	if cylinderHandleAdornment then
 		cylinderHandleAdornment.Height = ray.Direction.Magnitude
-		cylinderHandleAdornment.Radius = diameter/4
-		cylinderHandleAdornment.Color3 = color
+		cylinderHandleAdornment.Radius = rayDiameter / 4
+		cylinderHandleAdornment.Color3 = rayColor
 	end
 
 	local partSize = rayPart.Size
 	local mesh = rayPart:FindFirstChildWhichIsA("SpecialMesh")
 	if mesh then
-		mesh.Scale = Vector3.new(distance/partSize.x, diameter/partSize.y, diameter/partSize.z)
+		mesh.Scale = Vector3.new(distance / partSize.x, rayDiameter / partSize.y, rayDiameter / partSize.z)
 	end
 end
 
@@ -393,8 +433,8 @@ end
 	@param color Color3? -- Optional color to render
 	@return Instance
 ]=]
-function Draw.text(adornee, text, color)
-	color = Draw._toColor3(color)
+function Draw.text(adornee: Instance | Vector3, text: string, color: Color3Like?): Instance
+	local textColor = Draw._toColor3(color) or Draw._defaultColor
 
 	if typeof(adornee) == "Vector3" then
 		local attachment = Instance.new("Attachment")
@@ -402,23 +442,23 @@ function Draw.text(adornee, text, color)
 		attachment.Parent = Terrain
 		attachment.Name = "DebugTextAttachment"
 
-		Draw._textOnAdornee(attachment, text, color)
+		Draw._textOnAdornee(attachment, text, textColor)
 
 		return attachment
 	elseif typeof(adornee) == "Instance" then
-		return Draw._textOnAdornee(adornee, text, color)
+		return Draw._textOnAdornee(adornee, text, textColor)
 	else
 		error("Bad adornee")
 	end
 end
 
-function Draw._textOnAdornee(adornee, text, color)
+function Draw._textOnAdornee(adornee: Instance, text: string, color: Color3): BillboardGui
 	local TEXT_HEIGHT_STUDS = 2
 	local PADDING_PERCENT_OF_LINE_HEIGHT = 0.5
 
 	local billboardGui = Instance.new("BillboardGui")
 	billboardGui.Name = "DebugBillboardGui"
-	billboardGui.SizeOffset =  Vector2.new(0, 0.5)
+	billboardGui.SizeOffset = Vector2.new(0, 0.5)
 	billboardGui.ExtentsOffset = Vector3.new(0, 1, 0)
 	billboardGui.AlwaysOnTop = true
 	billboardGui.Adornee = adornee
@@ -431,7 +471,7 @@ function Draw._textOnAdornee(adornee, text, color)
 	background.AnchorPoint = Vector2.new(0.5, 1)
 	background.BackgroundTransparency = 0.3
 	background.BorderSizePixel = 0
-	background.BackgroundColor3 = color or Draw._defaultColor
+	background.BackgroundColor3 = color
 	background.Parent = billboardGui
 
 	local textLabel = Instance.new("TextLabel")
@@ -450,37 +490,33 @@ function Draw._textOnAdornee(adornee, text, color)
 		textLabel.Font = Enum.Font.GothamMedium
 	end
 
-	local textSize = TextService:GetTextSize(
-		textLabel.Text,
-		textLabel.TextSize,
-		textLabel.Font,
-		Vector2.new(1024, 1e6))
+	local textSize = TextService:GetTextSize(textLabel.Text, textLabel.TextSize, textLabel.Font, Vector2.new(1024, 1e6))
 
-	local lines = textSize.y/textLabel.TextSize
+	local lines = textSize.y / textLabel.TextSize
 
-	local paddingOffset = textLabel.TextSize*PADDING_PERCENT_OF_LINE_HEIGHT
-	local paddedHeight = textSize.y + 2*paddingOffset
-	local paddedWidth = textSize.x + 2*paddingOffset
-	local aspectRatio = paddedWidth/paddedHeight
+	local paddingOffset = textLabel.TextSize * PADDING_PERCENT_OF_LINE_HEIGHT
+	local paddedHeight = textSize.y + 2 * paddingOffset
+	local paddedWidth = textSize.x + 2 * paddingOffset
+	local aspectRatio = paddedWidth / paddedHeight
 
 	local uiAspectRatio = Instance.new("UIAspectRatioConstraint")
 	uiAspectRatio.AspectRatio = aspectRatio
 	uiAspectRatio.Parent = background
 
 	local uiPadding = Instance.new("UIPadding")
-	uiPadding.PaddingBottom = UDim.new(paddingOffset/paddedHeight, 0)
-	uiPadding.PaddingTop = UDim.new(paddingOffset/paddedHeight, 0)
-	uiPadding.PaddingLeft = UDim.new(paddingOffset/paddedWidth, 0)
-	uiPadding.PaddingRight = UDim.new(paddingOffset/paddedWidth, 0)
+	uiPadding.PaddingBottom = UDim.new(paddingOffset / paddedHeight, 0)
+	uiPadding.PaddingTop = UDim.new(paddingOffset / paddedHeight, 0)
+	uiPadding.PaddingLeft = UDim.new(paddingOffset / paddedWidth, 0)
+	uiPadding.PaddingRight = UDim.new(paddingOffset / paddedWidth, 0)
 	uiPadding.Parent = background
 
 	local uiCorner = Instance.new("UICorner")
-	uiCorner.CornerRadius = UDim.new(paddingOffset/paddedHeight/2, 0)
+	uiCorner.CornerRadius = UDim.new(paddingOffset / paddedHeight / 2, 0)
 	uiCorner.Parent = background
 
-	local height = lines*TEXT_HEIGHT_STUDS * TEXT_HEIGHT_STUDS*PADDING_PERCENT_OF_LINE_HEIGHT
+	local height = lines * TEXT_HEIGHT_STUDS * TEXT_HEIGHT_STUDS * PADDING_PERCENT_OF_LINE_HEIGHT
 
-	billboardGui.Size = UDim2.new(height*aspectRatio, 0, height, 0)
+	billboardGui.Size = UDim2.new(height * aspectRatio, 0, height, 0)
 	billboardGui.Parent = adornee
 
 	return billboardGui
@@ -501,8 +537,8 @@ end
 	@param parent Instance? -- Optional parent
 	@return BasePart
 ]=]
-function Draw.sphere(position, radius, color, parent)
-	return Draw.point(position, color, parent, radius*2)
+function Draw.sphere(position: Vector3Like, radius: number, color: Color3?, parent: Instance)
+	return Draw.point(position, color, parent, radius * 2)
 end
 
 --[=[
@@ -518,12 +554,11 @@ end
 	@param diameter number? -- Optional diameter
 	@return BasePart
 ]=]
-function Draw.point(position, color, parent, diameter)
-	position = assert(Draw._toVector3(position), "Bad position")
-	color = Draw._toColor3(color) or Draw._defaultColor
-
-	parent = parent or Draw.getDefaultParent()
-	diameter = diameter or 1
+function Draw.point(position: Vector3Like, color: Color3Like?, parent: Instance?, diameter: number?): BasePart
+	local pointPosition = assert(Draw._toVector3(position), "Bad position")
+	local pointColor = Draw._toColor3(color) or Draw._defaultColor
+	local pointParent = parent or Draw.getDefaultParent()
+	local pointDiameter = diameter or 1
 
 	local part = Instance.new("Part")
 	part.Material = Enum.Material.ForceField
@@ -534,25 +569,25 @@ function Draw.point(position, color, parent, diameter)
 	part.CanQuery = false
 	part.CanTouch = false
 	part.CastShadow = false
-	part.CFrame = CFrame.new(position)
-	part.Color = color
+	part.CFrame = CFrame.new(pointPosition)
+	part.Color = pointColor
 	part.Name = "DebugPoint"
 	part.Shape = Enum.PartType.Ball
-	part.Size = Vector3.new(diameter, diameter, diameter)
+	part.Size = Vector3.new(pointDiameter, pointDiameter, pointDiameter)
 	part.TopSurface = Enum.SurfaceType.Smooth
 	part.Transparency = 0.5
 
 	local sphereHandle = Instance.new("SphereHandleAdornment")
 	sphereHandle.Archivable = false
 	sphereHandle.Transparency = 0.25
-	sphereHandle.Radius = diameter/4
-	sphereHandle.Color3 = color
+	sphereHandle.Radius = pointDiameter / 4
+	sphereHandle.Color3 = pointColor
 	sphereHandle.AlwaysOnTop = true
 	sphereHandle.Adornee = part
 	sphereHandle.ZIndex = 2
 	sphereHandle.Parent = part
 
-	part.Parent = parent
+	part.Parent = pointParent
 
 	return part
 end
@@ -570,7 +605,7 @@ end
 	@param parent Instance? -- Optional parent
 	@return BasePart
 ]=]
-function Draw.labelledPoint(position, label, color, parent)
+function Draw.labelledPoint(position: Vector3Like, label: string, color: Color3Like?, parent: Instance?): BasePart
 	position = assert(Draw._toVector3(position), "Bad position")
 	color = Draw._toColor3(color)
 
@@ -591,31 +626,22 @@ end
 	@param cframe CFrame
 	@return Model
 ]=]
-function Draw.cframe(cframe)
-	cframe = assert(Draw._toCFrame(cframe), "Bad cframe")
+function Draw.cframe(cframe: CFrameLike): Model
+	local drawCFrame = assert(Draw._toCFrame(cframe), "Bad cframe")
 
 	local model = Instance.new("Model")
 	model.Name = "DebugCFrame"
 
-	local position = cframe.Position
+	local position = drawCFrame.Position
 	Draw.point(position, nil, model, 0.1)
 
-	local xRay = Draw.ray(Ray.new(
-		position,
-		cframe.XVector
-	), Color3.new(0.75, 0.25, 0.25), model, 0.1)
+	local xRay = Draw.ray(Ray.new(position, drawCFrame.XVector), Color3.new(0.75, 0.25, 0.25), model, 0.1)
 	xRay.Name = "XVector"
 
-	local yRay = Draw.ray(Ray.new(
-		position,
-		cframe.YVector
-	), Color3.new(0.25, 0.75, 0.25), model, 0.1)
+	local yRay = Draw.ray(Ray.new(position, drawCFrame.YVector), Color3.new(0.25, 0.75, 0.25), model, 0.1)
 	yRay.Name = "YVector"
 
-	local zRay = Draw.ray(Ray.new(
-		position,
-		cframe.ZVector
-	), Color3.new(0.25, 0.25, 0.75), model, 0.1)
+	local zRay = Draw.ray(Ray.new(position, drawCFrame.ZVector), Color3.new(0.25, 0.25, 0.75), model, 0.1)
 	zRay.Name = "ZVector"
 
 	model.Parent = Draw.getDefaultParent()
@@ -633,13 +659,14 @@ end
 	@param template BasePart
 	@param cframe CFrame
 	@param color Color3?
-	@param transparency number
+	@param transparency number?
 	@return BasePart
 ]=]
-function Draw.part(template, cframe, color, transparency)
+function Draw.part(template: BasePart, cframe: CFrameLike?, color: Color3Like?, transparency: number?): BasePart
 	assert(typeof(template) == "Instance" and template:IsA("BasePart"), "Bad template")
-	cframe = Draw._toCFrame(cframe)
-	color = Draw._toColor3(color)
+
+	local partCFrame = Draw._toCFrame(cframe)
+	local partColor = Draw._toColor3(color) or Draw._defaultColor
 
 	local part = template:Clone()
 	for _, child in pairs(part:GetChildren()) do
@@ -651,7 +678,7 @@ function Draw.part(template, cframe, color, transparency)
 		end
 	end
 
-	part.Color = color or Draw._defaultColor
+	part.Color = partColor
 	part.Material = Enum.Material.ForceField
 	part.Transparency = transparency or 0.75
 	part.Name = "Debug" .. template.Name
@@ -662,8 +689,8 @@ function Draw.part(template, cframe, color, transparency)
 	part.CastShadow = false
 	part.Archivable = false
 
-	if cframe then
-		part.CFrame = cframe
+	if partCFrame then
+		part.CFrame = partCFrame
 	end
 
 	Draw._sanitize(part)
@@ -673,12 +700,12 @@ function Draw.part(template, cframe, color, transparency)
 	return part
 end
 
-function Draw._sanitize(inst)
-	for key, _ in pairs(inst:GetAttributes()) do
+function Draw._sanitize(inst: Instance)
+	for key, _ in inst:GetAttributes() do
 		inst:SetAttribute(key, nil)
 	end
 
-	for _, tag in pairs(CollectionService:GetTags(inst)) do
+	for _, tag in CollectionService:GetTags(inst) do
 		CollectionService:RemoveTag(inst, tag)
 	end
 end
@@ -692,21 +719,16 @@ end
 
 	@param cframe CFrame | Vector3 -- CFrame of the box
 	@param size Vector3 -- Size of the box
-	@param color Color3 -- Optional Color3
+	@param color Color3? -- Optional Color3
 	@return BasePart
 ]=]
-function Draw.box(cframe, size, color)
+function Draw.box(cframe: CFrameLike, size: Vector3Like, color: Color3Like?): BasePart
 	cframe = assert(Draw._toCFrame(cframe), "Bad cframe")
 	size = assert(Draw._toVector3(size), "Bad size")
-	color = Draw._toColor3(color)
-
-	assert(typeof(cframe) == "CFrame", "Bad cframe")
-	assert(typeof(size) == "Vector3", "Bad size")
-
-	color = color or Draw._defaultColor
+	local boxColor = Draw._toColor3(color) or Draw._defaultColor
 
 	local part = Instance.new("Part")
-	part.Color = color
+	part.Color = boxColor
 	part.Material = Enum.Material.ForceField
 	part.Name = "DebugPart"
 	part.Anchored = true
@@ -724,7 +746,7 @@ function Draw.box(cframe, size, color)
 	local boxHandleAdornment = Instance.new("BoxHandleAdornment")
 	boxHandleAdornment.Adornee = part
 	boxHandleAdornment.Size = size
-	boxHandleAdornment.Color3 = color
+	boxHandleAdornment.Color3 = boxColor
 	boxHandleAdornment.AlwaysOnTop = true
 	boxHandleAdornment.Transparency = 0.75
 	boxHandleAdornment.ZIndex = 1
@@ -746,7 +768,7 @@ end
 	@param color Color3? -- Optional color3
 	@return BasePart
 ]=]
-function Draw.region3(region3, color)
+function Draw.region3(region3: Region3, color: Color3Like?): BasePart
 	color = Draw._toColor3(color)
 
 	return Draw.box(region3.CFrame, region3.Size, color)
@@ -764,7 +786,7 @@ end
 	@param color Color3? -- Optional color to render
 	@return BasePart
 ]=]
-function Draw.terrainCell(position, color)
+function Draw.terrainCell(position: Vector3Like, color: Color3Like?): BasePart
 	position = assert(Draw._toVector3(position), "Bad position")
 	color = Draw._toColor3(color)
 
@@ -779,12 +801,14 @@ function Draw.terrainCell(position, color)
 	return part
 end
 
-function Draw.screenPointLine(a, b, parent, color)
-	color = Draw._toColor3(color)
+--[=[
+	Draws a screen point line
+]=]
+function Draw.screenPointLine(a: Vector2, b: Vector2, parent: Instance?, color: Color3Like): Frame
+	color = Draw._toColor3(color) or Draw._defaultColor
 
 	local offset = (b - a)
-	local pos = a + offset/2
-
+	local pos = a + offset / 2
 
 	local frame = Instance.new("Frame")
 	frame.Name = "DebugScreenLine"
@@ -805,21 +829,24 @@ function Draw.screenPointLine(a, b, parent, color)
 	local diameter = 3
 	local count = 25
 
-	local slope = offset.y/offset.x
+	local slope = offset.y / offset.x
 	if slope > 0 then
-		for i=0, count do
-			Draw.screenPoint(Vector2.new(i/count, i/count), frame, color, diameter)
+		for i = 0, count do
+			Draw.screenPoint(Vector2.new(i / count, i / count), frame, color, diameter)
 		end
 	else
-		for i=0, count do
-			Draw.screenPoint(Vector2.new(i/count, 1 - i/count), frame, color, diameter)
+		for i = 0, count do
+			Draw.screenPoint(Vector2.new(i / count, 1 - i / count), frame, color, diameter)
 		end
 	end
 
 	return frame
 end
 
-function Draw.screenPoint(position, parent, color, diameter)
+--[=[
+	Draws a screen point
+]=]
+function Draw.screenPoint(position: Vector2, parent: Instance, color: Color3Like?, diameter: number?): Frame
 	color = Draw._toColor3(color)
 
 	local frame = Instance.new("Frame")
@@ -827,7 +854,7 @@ function Draw.screenPoint(position, parent, color, diameter)
 	frame.Size = UDim2.new(0, diameter, 0, diameter)
 	frame.BackgroundColor3 = color or Color3.new(1, 0.1, 0.1)
 	frame.BackgroundTransparency = 0.5
-	frame.Position = UDim2.fromScale(position.x, position.y)
+	frame.Position = UDim2.fromScale(position.X, position.Y)
 	frame.AnchorPoint = Vector2.new(0.5, 0.5)
 	frame.BorderSizePixel = 0
 	frame.ZIndex = 20000
@@ -854,12 +881,18 @@ end
 	@param meshDiameter number? -- Optional diameter
 	@return BasePart
 ]=]
-function Draw.vector(position, direction, color, parent, meshDiameter)
-	position = assert(Draw._toVector3(position), "Bad position")
-	direction = assert(Draw._toVector3(direction), "Bad direction")
-	color = Draw._toColor3(color)
-
-	return Draw.ray(Ray.new(position, direction), color, parent, meshDiameter)
+function Draw.vector(
+	position: Vector3Like,
+	direction: Vector3Like,
+	color: Color3?,
+	parent: Instance?,
+	meshDiameter: number?
+)
+	local vectorPosition = assert(Draw._toVector3(position), "Bad position")
+	local vectorDirection = assert(Draw._toVector3(direction), "Bad direction")
+	local vectorColor = Draw._toColor3(color)
+
+	return Draw.ray(Ray.new(vectorPosition, vectorDirection), vectorColor, parent, meshDiameter)
 end
 
 --[=[
@@ -869,23 +902,25 @@ end
 	Draw.ring(Vector3.new(0, 0, 0), Vector3.new(0, 1, 0), 10)
 	```
 
-	@param ringPos Vector3 -- Position of the center of the ring
-	@param ringNorm Vector3 -- Direction of the ring.
-	@param ringRadius number? -- Optional radius for the ring
+	@param position Vector3 -- Position of the center of the ring
+	@param normal Vector3 -- Direction of the ring.
+	@param radius number? -- Optional radius for the ring
 	@param color Color3? -- Optional color
 	@param parent Instance? -- Optional instance
 	@return BasePart
 ]=]
-function Draw.ring(ringPos, ringNorm, ringRadius, color, parent)
-	ringPos = assert(Draw._toVector3(ringPos), "Bad ringPos")
-	ringNorm = assert(Draw._toVector3(ringNorm), "Bad ringNorm")
+function Draw.ring(position: Vector3Like, normal: Vector3Like, radius: number?, color: Color3Like, parent: Instance?)
+	local ringPosition = assert(Draw._toVector3(position), "Bad ringPos")
+	local ringNormal = assert(Draw._toVector3(normal), "Bad ringNorm")
+	local ringRadius = radius or 1
+	local ringColor = Draw._toColor3(color) or Draw._defaultColor
 
-	local ringCFrame = CFrame.new(ringPos, ringPos + ringNorm)
+	local ringCFrame = CFrame.new(ringPosition, ringPosition + ringNormal)
 
 	local points = {}
-	for angle = 0, 2*math.pi, math.pi/8 do
-		local x = math.cos(angle)*ringRadius
-		local y = math.sin(angle)*ringRadius
+	for angle = 0, 2 * math.pi, math.pi / 8 do
+		local x = math.cos(angle) * ringRadius
+		local y = math.sin(angle) * ringRadius
 		local vector = ringCFrame:pointToWorldSpace(Vector3.new(x, y, 0))
 		table.insert(points, vector)
 	end
@@ -893,11 +928,11 @@ function Draw.ring(ringPos, ringNorm, ringRadius, color, parent)
 	local folder = Instance.new("Folder")
 	folder.Name = "DebugRing"
 
-	for i=1, #points do
+	for i = 1, #points do
 		local pos = points[i]
-		local nextPos = points[(i%#points)+1]
-        local ray = Ray.new(pos, nextPos - pos)
-        Draw.ray(ray, color, folder)
+		local nextPos = points[(i % #points) + 1]
+		local ray = Ray.new(pos, nextPos - pos)
+		Draw.ray(ray, ringColor, folder)
 	end
 
 	folder.Parent = parent or Draw.getDefaultParent()
@@ -905,7 +940,9 @@ function Draw.ring(ringPos, ringNorm, ringRadius, color, parent)
 	return folder
 end
 
-function Draw._toVector3(position)
+export type Vector3Like = Vector3 | CFrame | Attachment | BasePart | Model | RaycastResult | PathWaypoint
+
+function Draw._toVector3(position: Vector3Like): Vector3?
 	if typeof(position) == "Vector3" then
 		return position
 	elseif typeof(position) == "CFrame" then
@@ -916,7 +953,7 @@ function Draw._toVector3(position)
 		elseif position:IsA("BasePart") then
 			return position.Position
 		elseif position:IsA("Model") then
-			return position:GetBoundingBox().p
+			return position:GetBoundingBox().Position
 		else
 			return nil
 		end
@@ -929,7 +966,9 @@ function Draw._toVector3(position)
 	end
 end
 
-function Draw._toColor3(color)
+export type Color3Like = Color3 | BrickColor | BasePart
+
+function Draw._toColor3(color: Color3Like?): Color3?
 	if typeof(color) == "Color3" then
 		return color
 	elseif typeof(color) == "BrickColor" then
@@ -945,7 +984,9 @@ function Draw._toColor3(color)
 	end
 end
 
-function Draw._toCFrame(cframe)
+export type CFrameLike = CFrame | Vector3 | Attachment | BasePart | Model | RaycastResult | PathWaypoint
+
+function Draw._toCFrame(cframe: CFrameLike?): CFrame?
 	if typeof(cframe) == "CFrame" then
 		return cframe
 	elseif typeof(cframe) == "Vector3" then
@@ -973,7 +1014,7 @@ end
 	Retrieves the default parent for the current execution context.
 	@return Instance
 ]=]
-function Draw.getDefaultParent()
+function Draw.getDefaultParent(): Instance?
 	if not RunService:IsRunning() then
 		return Workspace.CurrentCamera
 	end
@@ -985,4 +1026,4 @@ function Draw.getDefaultParent()
 	end
 end
 
-return Draw
+return Draw