@quenty/camera 4.3.1 → 4.4.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camera@4.3.1...@quenty/camera@4.4.0) (2021-12-18)
+
+
+### Features
+
+* Better camera explainability ([4fd9016](https://github.com/Quenty/NevermoreEngine/commit/4fd9016f6914bf181e421753cbaca555394537d8))
+
+
+
+
+
 ## [4.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camera@4.3.0...@quenty/camera@4.3.1) (2021-12-04)
 
 **Note:** Version bump only for package @quenty/camera

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

@@ -69,3 +69,46 @@ This class takes two arguments and returns the summation of the two
 This classes allows the effects of a camera to be faded / varied based upon a spring
 
 * Starts at 0 percent effect
+
+## Usage
+Here is sample usage of using just a subcomponent. Recommendation is to use full camera stack service.
+
+```lua
+local RunService = game:GetService("RunService")
+local Workspace = game:GetService("Workspace")
+
+local FadeBetweenCamera3 = require(modules.FadeBetweenCamera3)
+local CustomCameraEffect = require(modules.CustomCameraEffect)
+local CameraState = require(modules.CameraState)
+
+local defaultCamera = require(modules.DefaultCamera).new()
+defaultCamera:BindToRenderStep() -- capture roblox camera automatically
+
+local targetCamera = CustomCameraEffect.new(function()
+  local target = CameraState.new()
+  target.CFrame = CFrame.new(0, 100, 0)
+  target.FieldOfView = 70
+
+  return target
+end)
+
+local faded = FadeBetweenCamera3.new(defaultCamera, targetCamera)
+faded.Speed = 5
+
+RunService:BindToRenderStep("CameraStackUpdateInternal", Enum.RenderPriority.Camera.Value + 75, function()
+  faded.CameraState:Set(Workspace.CurrentCamera)
+end)
+
+-- Input
+local mouse = game.Players.LocalPlayer:GetMouse()
+local visible = false
+mouse.Button1Down:Connect(function()
+  visible = not visible
+  if visible then
+    faded.Target = 1
+  else
+    faded.Target = 0
+  end
+end)
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/camera",
-  "version": "4.3.1",
+  "version": "4.4.0",
   "description": "Quenty's camera system for Roblox",
   "keywords": [
     "Roblox",
@@ -33,15 +33,15 @@
     "@quenty/loader": "^3.1.1",
     "@quenty/maid": "^2.0.1",
     "@quenty/math": "^2.0.0",
-    "@quenty/qframe": "^3.2.0",
+    "@quenty/qframe": "^3.3.0",
     "@quenty/servicebag": "^3.2.1",
-    "@quenty/spring": "^2.1.0"
+    "@quenty/spring": "^2.2.0"
   },
   "devDependencies": {
-    "@quenty/camerastoryutils": "^3.2.0"
+    "@quenty/camerastoryutils": "^3.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a0583027b100d718bce1603ec6c525ad99adeeac"
+  "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
 }

package/src/Client/Utility/CameraFrame.story.lua

@@ -17,10 +17,10 @@ return function(target)
 
 	local cameraCFrame = workspace.CurrentCamera.CFrame
 	local a = CameraFrame.new(QFrame.fromCFrameClosestTo(
-		CFrame.new(cameraCFrame.Position + cameraCFrame.lookVector*25),
+		CFrame.new(cameraCFrame.Position + cameraCFrame.lookVector*25 - 20*cameraCFrame.RightVector),
 		QFrame.new()), 70)
 	local b = CameraFrame.new(QFrame.fromCFrameClosestTo(
-		CFrame.new(cameraCFrame.Position + cameraCFrame.lookVector*30 + 10*cameraCFrame.RightVector)
+		CFrame.new(cameraCFrame.Position + cameraCFrame.lookVector*30 + 20*cameraCFrame.RightVector)
 			 * CFrame.Angles(math.pi/3, 2*math.pi/3, 0),
 		QFrame.new()), 70)
 
@@ -38,12 +38,12 @@ return function(target)
 
 	setup(function(t)
 		return CameraFrame.new((1 - t)*a.QFrame + t*b.QFrame, a.FieldOfView + (b.FieldOfView - a.FieldOfView)*t)
-	end, Color3.new(0.25, 0.25, 0.25))
+	end, Color3.new(0.25, 0.25, 0.25), "Linear", Vector2.new(80, 0))
 
 	setup(function(t)
 		local result = ((b.QFrame*(a.QFrame^-1))^t)*a.QFrame
 		return CameraFrame.new(result, a.FieldOfView + (b.FieldOfView - a.FieldOfView)*t)
-	end, Color3.new(0.5, 0.5, 1))
+	end, Color3.new(0.5, 0.5, 1), "Quaternion", Vector2.new(0, -80))
 
 	setup(function(t)
 		local node0 = CubicSplineUtils.newSplineNode(0, a, CameraFrame.new())
@@ -57,7 +57,7 @@ return function(target)
 
 		local newNode = CubicSplineUtils.tweenSplineNodes(node0, node1, t)
 		return newNode.p
-	end, Color3.new(0.5, 1, 1))
+	end, Color3.new(0.5, 1, 1), "Cubic spline", Vector2.new(0, 40))
 	return function()
 		maid:DoCleaning()
 	end

package/test/default.project.json

@@ -2,17 +2,9 @@
   "name": "cameratest",
   "tree": {
     "$className": "DataModel",
-    "ReplicatedStorage": {
-      "Nevermore": {
-        "$path": "../node_modules/@quenty/loader"
-      }
-    },
     "ServerScriptService": {
-      "Nevermore": {
-        "$className": "folder",
-        "Camera": {
-          "$path": ".."
-        }
+      "camera": {
+        "$path": ".."
       }
     }
   }