@quenty/camerastoryutils 4.0.0-canary.236.5597d0a.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +57 -1
- package/README.md +11 -4
- package/package.json +6 -6
- package/src/Client/CameraStoryUtils.lua +33 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,7 +3,63 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
-
# [4.
|
|
6
|
+
# [4.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@4.0.0...@quenty/camerastoryutils@4.1.0) (2022-03-10)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @quenty/camerastoryutils
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.6.0...@quenty/camerastoryutils@4.0.0) (2022-03-06)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @quenty/camerastoryutils
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
# [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.5.1...@quenty/camerastoryutils@3.6.0) (2022-01-17)
|
|
23
|
+
|
|
24
|
+
**Note:** Version bump only for package @quenty/camerastoryutils
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.5.0...@quenty/camerastoryutils@3.5.1) (2022-01-16)
|
|
31
|
+
|
|
32
|
+
**Note:** Version bump only for package @quenty/camerastoryutils
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.4.0...@quenty/camerastoryutils@3.5.0) (2022-01-07)
|
|
39
|
+
|
|
40
|
+
**Note:** Version bump only for package @quenty/camerastoryutils
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
# [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.3.1...@quenty/camerastoryutils@3.4.0) (2022-01-03)
|
|
47
|
+
|
|
48
|
+
**Note:** Version bump only for package @quenty/camerastoryutils
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.3.0...@quenty/camerastoryutils@3.3.1) (2021-12-30)
|
|
55
|
+
|
|
56
|
+
**Note:** Version bump only for package @quenty/camerastoryutils
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
# [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.2.0...@quenty/camerastoryutils@3.3.0) (2021-12-18)
|
|
7
63
|
|
|
8
64
|
|
|
9
65
|
### Features
|
package/README.md
CHANGED
|
@@ -1,14 +1,21 @@
|
|
|
1
1
|
## CameraStoryUtils
|
|
2
2
|
<div align="center">
|
|
3
|
-
<a href="http://quenty.github.io/
|
|
4
|
-
<img src="https://
|
|
3
|
+
<a href="http://quenty.github.io/NevermoreEngine/">
|
|
4
|
+
<img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
|
|
5
5
|
</a>
|
|
6
6
|
<a href="https://discord.gg/mhtGUS8">
|
|
7
|
-
<img src="https://img.shields.io/
|
|
7
|
+
<img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
|
|
8
8
|
</a>
|
|
9
9
|
<a href="https://github.com/Quenty/NevermoreEngine/actions">
|
|
10
10
|
<img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
|
|
11
11
|
</a>
|
|
12
12
|
</div>
|
|
13
13
|
|
|
14
|
-
Utility functions to help with 3D stories using viewport frames
|
|
14
|
+
Utility functions to help with 3D stories using viewport frames
|
|
15
|
+
|
|
16
|
+
<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/CameraStoryUtils">View docs →</a></div>
|
|
17
|
+
|
|
18
|
+
## Installation
|
|
19
|
+
```
|
|
20
|
+
npm install @quenty/camerastoryutils --save
|
|
21
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quenty/camerastoryutils",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.1.0",
|
|
4
4
|
"description": "CameraStoryUtils - utility functions for 3D viewport hoarcekat stories.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Roblox",
|
|
@@ -26,13 +26,13 @@
|
|
|
26
26
|
"Quenty"
|
|
27
27
|
],
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@quenty/insertserviceutils": "4.
|
|
30
|
-
"@quenty/loader": "
|
|
31
|
-
"@quenty/math": "2.0.
|
|
32
|
-
"@quenty/promise": "4.
|
|
29
|
+
"@quenty/insertserviceutils": "^4.1.0",
|
|
30
|
+
"@quenty/loader": "^4.0.0",
|
|
31
|
+
"@quenty/math": "^2.0.1",
|
|
32
|
+
"@quenty/promise": "^4.1.0"
|
|
33
33
|
},
|
|
34
34
|
"publishConfig": {
|
|
35
35
|
"access": "public"
|
|
36
36
|
},
|
|
37
|
-
"gitHead": "
|
|
37
|
+
"gitHead": "0797de955876b050fb24875de0423453e268b2ce"
|
|
38
38
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
--[=[
|
|
2
|
+
Utility functions for hoacekat stories.
|
|
3
|
+
@class CameraStoryUtils
|
|
4
|
+
]=]
|
|
4
5
|
|
|
5
6
|
local require = require(script.Parent.loader).load(script)
|
|
6
7
|
|
|
@@ -13,6 +14,12 @@ local Math = require("Math")
|
|
|
13
14
|
|
|
14
15
|
local CameraStoryUtils = {}
|
|
15
16
|
|
|
17
|
+
--[=[
|
|
18
|
+
Reflects the camera state to the original camera
|
|
19
|
+
@param maid Maid
|
|
20
|
+
@param topCamera Camera
|
|
21
|
+
@return Camera
|
|
22
|
+
]=]
|
|
16
23
|
function CameraStoryUtils.reflectCamera(maid, topCamera)
|
|
17
24
|
local camera = Instance.new("Camera")
|
|
18
25
|
camera.Name = "ReflectedCamera"
|
|
@@ -30,6 +37,12 @@ function CameraStoryUtils.reflectCamera(maid, topCamera)
|
|
|
30
37
|
return camera
|
|
31
38
|
end
|
|
32
39
|
|
|
40
|
+
--[=[
|
|
41
|
+
Sets up a viewport frame
|
|
42
|
+
@param maid Maid
|
|
43
|
+
@param target GuiBase
|
|
44
|
+
@return ViewportFrame
|
|
45
|
+
]=]
|
|
33
46
|
function CameraStoryUtils.setupViewportFrame(maid, target)
|
|
34
47
|
local viewportFrame = Instance.new("ViewportFrame")
|
|
35
48
|
viewportFrame.ZIndex = 0
|
|
@@ -47,6 +60,13 @@ function CameraStoryUtils.setupViewportFrame(maid, target)
|
|
|
47
60
|
return viewportFrame
|
|
48
61
|
end
|
|
49
62
|
|
|
63
|
+
--[=[
|
|
64
|
+
REturns a promise that resolves to a crate in front of the camera.
|
|
65
|
+
@param maid Maid
|
|
66
|
+
@param viewportFrame ViewportFrame
|
|
67
|
+
@param properties { [string}: any }
|
|
68
|
+
@return Promise<Instance>
|
|
69
|
+
]=]
|
|
50
70
|
function CameraStoryUtils.promiseCrate(maid, viewportFrame, properties)
|
|
51
71
|
return maid:GivePromise(InsertServiceUtils.promiseAsset(182451181)):Then(function(model)
|
|
52
72
|
maid:GiveTask(model)
|
|
@@ -79,6 +99,16 @@ function CameraStoryUtils.promiseCrate(maid, viewportFrame, properties)
|
|
|
79
99
|
end)
|
|
80
100
|
end
|
|
81
101
|
|
|
102
|
+
--[=[
|
|
103
|
+
Retrieves the interpolation
|
|
104
|
+
@param maid Maid
|
|
105
|
+
@param viewportFrame ViewportFrame
|
|
106
|
+
@param low number
|
|
107
|
+
@param high number
|
|
108
|
+
@param period number
|
|
109
|
+
@param toCFrame CFrame
|
|
110
|
+
@return (interpolate: function, color: Color3, label: string?, labelOffset: Vector2?) -> ()
|
|
111
|
+
]=]
|
|
82
112
|
function CameraStoryUtils.getInterpolationFactory(maid, viewportFrame, low, high, period, toCFrame)
|
|
83
113
|
assert(maid, "Bad maid")
|
|
84
114
|
assert(viewportFrame, "Bad viewportFrame")
|