@quenty/fakeskybox 3.1.3-canary.c50dead.0 → 3.2.1

package/CHANGELOG.md

@@ -3,12 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.1.3-canary.c50dead.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/fakeskybox@3.1.2...@quenty/fakeskybox@3.1.3-canary.c50dead.0) (2021-11-20)
+## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/fakeskybox@3.2.0...@quenty/fakeskybox@3.2.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/fakeskybox
+
+
+
+
+
+# [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/fakeskybox@3.1.2...@quenty/fakeskybox@3.2.0) (2021-11-20)
 
 
 ### Bug Fixes
 
-* Support MacOS syncing ([c50dead](https://github.com/Quenty/NevermoreEngine/commit/c50deadbe5ebe479aded04e1619441a08ff0e9a8))
+* Support MacOS syncing ([#225](https://github.com/Quenty/NevermoreEngine/issues/225)) ([03f9183](https://github.com/Quenty/NevermoreEngine/commit/03f918392c6a5bdd33f8a17c38de371d1e06c67a))
 
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 ## FakeSkybox
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <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/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,27 +13,9 @@
 
 Allow transitions between skyboxes
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/FakeSkybox">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/fakeskybox --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `FakeSkybox.new(skybox)`
-
-### `FakeSkybox:SetPartSize(partSize)`
-
-### `FakeSkybox:Show(doNotAnimate)`
-
-### `FakeSkybox:Hide(doNotAnimate)`
-
-### `FakeSkybox:SetSkybox(skybox)`
-
-### `FakeSkybox:IsVisible()`
-
-### `FakeSkybox:UpdateRender(baseCFrame)`
-
-### `FakeSkybox:Destroy()`
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/fakeskybox",
-  "version": "3.1.3-canary.c50dead.0",
+  "version": "3.2.1",
   "description": "Allow transitions between skyboxes",
   "keywords": [
     "Roblox",
@@ -25,13 +25,13 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "2.0.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/signal": "2.0.0"
+    "@quenty/acceltween": "^2.0.1",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/maid": "^2.0.2",
+    "@quenty/signal": "^2.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Client/FakeSkybox.lua

@@ -1,5 +1,7 @@
---- Allow transitions between skyboxes
--- @classmod FakeSkybox
+--[=[
+	Allow transitions between skyboxes
+	@class FakeSkybox
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -32,6 +34,11 @@ FakeSkybox.__index = FakeSkybox
 FakeSkybox.ClassName = "FakeSkybox"
 FakeSkybox._partSize = 1024
 
+--[=[
+	Creates a new FakeSkybox
+	@param skybox Skybox
+	@return FakeSkybox
+]=]
 function FakeSkybox.new(skybox)
 	local self = setmetatable({}, FakeSkybox)
 
@@ -63,7 +70,10 @@ function FakeSkybox.new(skybox)
 	return self
 end
 
-
+--[=[
+	@param partSize number
+	@return FakeSkybox -- self
+]=]
 function FakeSkybox:SetPartSize(partSize)
 	self._partSize = partSize or error("No partSize")
 
@@ -74,6 +84,9 @@ function FakeSkybox:SetPartSize(partSize)
 	return self
 end
 
+--[=[
+	@param doNotAnimate boolean
+]=]
 function FakeSkybox:Show(doNotAnimate)
 	if self._visible then
 		return
@@ -88,6 +101,9 @@ function FakeSkybox:Show(doNotAnimate)
 	self.VisibleChanged:Fire(self._visible, doNotAnimate)
 end
 
+--[=[
+	@param doNotAnimate boolean
+]=]
 function FakeSkybox:Hide(doNotAnimate)
 	if not self._visible then
 		return
@@ -102,6 +118,10 @@ function FakeSkybox:Hide(doNotAnimate)
 	self.VisibleChanged:Fire(self._visible, doNotAnimate)
 end
 
+--[=[
+	@param skybox Skybox
+	@return FakeSkybox -- self
+]=]
 function FakeSkybox:SetSkybox(skybox)
 	self._skybox = skybox or error("No skybox")
 
@@ -113,10 +133,18 @@ function FakeSkybox:SetSkybox(skybox)
 	return self
 end
 
+--[=[
+	Returns whether the skybox is visible.
+	@return boolean
+]=]
 function FakeSkybox:IsVisible()
 	return self._visible
 end
 
+--[=[
+	Updates the rendering
+	@param baseCFrame CFrame
+]=]
 function FakeSkybox:UpdateRender(baseCFrame)
 	local transparency = 1-self._percentVisible.p
 
@@ -126,6 +154,9 @@ function FakeSkybox:UpdateRender(baseCFrame)
 	end
 end
 
+--[=[
+	Cleans up the fake skybox
+]=]
 function FakeSkybox:Destroy()
 	self._maid:DoCleaning()
 	self._maid = nil

package/src/Client/FakeSkyboxSide.lua

@@ -1,5 +1,6 @@
----
--- @module FakeSkyboxSide
+--[=[
+	@class FakeSkyboxSide
+]=]
 
 local FakeSkyboxSide = {}
 FakeSkyboxSide.__index = FakeSkyboxSide