@quenty/hide 1.5.1-canary.238.2c4d310.0 → 1.5.2

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [1.5.1-canary.238.2c4d310.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/hide@1.5.0...@quenty/hide@1.5.1-canary.238.2c4d310.0) (2021-12-29)
+## [1.5.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/hide@1.5.1...@quenty/hide@1.5.2) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/hide
+
+
+
+
+
+## [1.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/hide@1.5.0...@quenty/hide@1.5.1) (2021-12-30)
 
 **Note:** Version bump only for package @quenty/hide
 

package/README.md

@@ -1,7 +1,7 @@
 ## Hide
 <div align="center">
   <a href="http://quenty.github.io/NevermoreEngine/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
     <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
@@ -13,6 +13,8 @@
 
 Utility system that leverages the binder system to hide authored objects. Centralized here for cross-system communication.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/Hide">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/hide --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/hide",
-  "version": "1.5.1-canary.238.2c4d310.0",
+  "version": "1.5.2",
   "description": "Utility system that leverages the binder system to hide authored objects. Centralized here for cross-system communication.",
   "keywords": [
     "Roblox",
@@ -26,12 +26,12 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/binder": "4.5.1-canary.238.2c4d310.0",
-    "@quenty/loader": "3.1.2-canary.238.2c4d310.0",
-    "@quenty/servicebag": "3.2.2-canary.238.2c4d310.0"
+    "@quenty/binder": "^4.5.2",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/servicebag": "^3.2.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2c4d310b84afd0570d89667dc5d4aa69a0ef304a"
+  "gitHead": "4afdd64f4ff6bc3b4b4c0ca7a31e839196f2411e"
 }

package/src/Client/HideBindersClient.lua

@@ -1,6 +1,19 @@
 --[=[
-	Holds binders
-	@class HideBinders
+	Initializes the hiding system on the client. See [HideBindersServer].
+
+	```lua
+	local HideBindersClient = require("HideBindersClient")
+	local ServiceBag = require("ServiceBag")
+
+	local serviceBag = ServiceBag.new()
+	serviceBag:GetService(HideBindersClient)
+
+	serviceBag:Init()
+	serviceBag:Start()
+	```
+
+	@client
+	@class HideBindersClient
 ]=]
 
 local require = require(script.Parent.loader).load(script)
@@ -9,5 +22,9 @@ local BinderProvider = require("BinderProvider")
 local Binder = require("Binder")
 
 return BinderProvider.new(function(self, serviceBag)
+--[=[
+	@prop Hide Binder<HideClient>
+	@within HideBindersClient
+]=]
 	self:Add(Binder.new("Hide", require("HideClient"), serviceBag))
 end)

package/src/Client/HideClient.lua

@@ -1,4 +1,6 @@
 --[=[
+	See [HideBindersClient] for usage.
+	@client
 	@class HideClient
 ]=]
 
@@ -6,12 +8,20 @@ local HideClient = {}
 HideClient.ClassName = "HideClient"
 HideClient.__index = HideClient
 
+--[=[
+	Cleans up the instance
+	@param _adornee Instance
+	@return HideClient
+]=]
 function HideClient.new(_adornee)
 	return setmetatable({}, HideClient)
 end
 
+--[=[
+	Cleans up the instance
+]=]
 function HideClient:Destroy()
-
+	setmetatable(self, nil)
 end
 
 return HideClient

package/src/Server/Hide.lua

@@ -1,4 +1,10 @@
 --[=[
+	Primarily used for authoring, this hides the tagged instance from render. Great for
+	making bounding boxes in studio that are then hidden upon runtime.
+
+	See [HideBindersServer] for usage.
+
+	@server
 	@class Hide
 ]=]
 
@@ -6,6 +12,11 @@ local Hide = {}
 Hide.ClassName = "Hide"
 Hide.__index = Hide
 
+--[=[
+	Hides the given instances
+	@param adornee Instance
+	@return Hide
+]=]
 function Hide.new(adornee)
 	local self = setmetatable({}, Hide)
 
@@ -31,7 +42,11 @@ function Hide:_setupPart(part)
 	part.Transparency = 1
 end
 
+--[=[
+	Cleans up the instance
+]=]
 function Hide:Destroy()
+	setmetatable(self, nil)
 end
 
 return Hide

package/src/Server/HideBindersServer.lua

@@ -1,5 +1,19 @@
 --[=[
-	Holds binders
+	Initializes the hiding system on the server. You can do this on the client
+	if you need to query for raycasting. See [HideBindersClient].
+
+	```lua
+	local HideBindersServer = require("HideBindersServer")
+	local ServiceBag = require("ServiceBag")
+
+	local serviceBag = ServiceBag.new()
+	serviceBag:GetService(HideBindersServer)
+
+	serviceBag:Init()
+	serviceBag:Start()
+	```
+
+	@server
 	@class HideBindersServer
 ]=]
 
@@ -9,5 +23,9 @@ local BinderProvider = require("BinderProvider")
 local Binder = require("Binder")
 
 return BinderProvider.new(function(self, serviceBag)
+--[=[
+	@prop Hide Binder<Hide>
+	@within HideBindersServer
+]=]
 	self:Add(Binder.new("Hide", require("Hide"), serviceBag))
 end)