@quenty/cframeserializer 2.0.0 → 2.0.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.
 
+## [2.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cframeserializer@2.0.0...@quenty/cframeserializer@2.0.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/cframeserializer
+
+
+
+
+
 # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cframeserializer@1.2.0...@quenty/cframeserializer@2.0.0) (2021-09-05)
 
 

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 @@
 ## CFrameSerializer
 <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,17 +13,9 @@
 
 Optimized these functions for speed as well as preserving fidality. In the future, use Roblox's orthogonal angle format.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/CFrameSerializer">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/cframeserializer --save
 ```
-
-## Usage
-Usage is designed to be simple.
-
-### `CFrameSerializer.outputRotationAzure(cf)`
-
-### `CFrameSerializer.readPosition(data)`
-
-### `CFrameSerializer.readRotationAzure(data)`
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/cframeserializer",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Optimized these functions for speed as well as preserving fidality. In the future, use Roblox's orthogonal angle format.",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c06170ec47b0d4520c587ce2e6404d14b5dbb851"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/CFrameSerializer.lua

@@ -1,6 +1,9 @@
---- Optimized these functions for speed as well as preserving fidality.
---  In the future, use Roblox's orthogonal angle format.
--- @module CFrameSerializer
+--[=[
+	Optimized these functions for speed as well as preserving fidality.
+	In the future, use Roblox's orthogonal angle format.
+
+	@class CFrameSerializer
+]=]
 
 local CFrameSerializer = {}
 
@@ -15,6 +18,11 @@ end
 
 local PRECISION = 10000
 
+--[=[
+	Outputs the rotation
+	@param cf CFrame
+	@return { number, number, number, number, number, number }
+]=]
 function CFrameSerializer.outputRotationAzure(cf)
 	local lookVector = cf.LookVector
 	local azumith = atan2(-lookVector.X, -lookVector.Z)
@@ -40,10 +48,20 @@ function CFrameSerializer.outputRotationAzure(cf)
 	return {px, py, pz, azumith, roll, elevation}
 end
 
+--[=[
+	Returns the position
+	@param data { number, number, number, number, number, number }
+	@return Vector3
+]=]
 function CFrameSerializer.readPosition(data)
 	return Vector3.new(data[1], data[2], data[3])
 end
 
+--[=[
+	Returns the CFrame
+	@param data { number, number, number, number, number, number }
+	@return Vector3
+]=]
 function CFrameSerializer.readRotationAzure(data)
 	local azumith = data[4]
 	local roll = data[5] --Buffer:ReadSigned(21)