@quenty/timedtween 1.0.1-canary.402.a911cda.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.402.a911cda.0 (2023-08-23)
+
+
+### Features
+
+* Add timed tween package ([122659c](https://github.com/Quenty/NevermoreEngine/commit/122659c7a9faa24a6282b7063199d519f08e9860))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2023 James Onnen (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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## TimedTween
+
+<div align="center">
+  <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/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" />
+  </a>
+</div>
+
+Linear timed tweening model
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/TimedTweenUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/timedtween --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "timedtween",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@quenty/timedtween",
+  "version": "1.0.1-canary.402.a911cda.0",
+  "description": "Linear timed tweening model",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "timedtween"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/timedtween/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/basicpane": "7.18.1-canary.402.a911cda.0",
+    "@quenty/blend": "6.26.1-canary.402.a911cda.0",
+    "@quenty/loader": "6.2.2-canary.402.a911cda.0",
+    "@quenty/math": "2.4.1-canary.402.a911cda.0",
+    "@quenty/promise": "6.7.1-canary.402.a911cda.0",
+    "@quenty/promisemaid": "1.2.1-canary.402.a911cda.0",
+    "@quenty/rx": "7.14.1-canary.402.a911cda.0",
+    "@quenty/steputils": "3.2.0",
+    "@quenty/valueobject": "7.21.1-canary.402.a911cda.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "a911cdaf4f1039b599528cec17b027f4660e4fd8"
+}

package/src/Shared/TimedTween.lua

@@ -0,0 +1,158 @@
+--[=[
+	@class TimedTween
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RunService = game:GetService("RunService")
+
+local BasicPane = require("BasicPane")
+local ValueObject = require("ValueObject")
+local Math = require("Math")
+local StepUtils = require("StepUtils")
+local Observable = require("Observable")
+local Maid = require("Maid")
+local Promise = require("Promise")
+
+local TimedTween = setmetatable({}, BasicPane)
+TimedTween.ClassName = "TimedTween"
+TimedTween.__index = TimedTween
+
+function TimedTween.new(transitionTime)
+	local self = setmetatable(BasicPane.new(), TimedTween)
+
+	self._transitionTime = self._maid:Add(ValueObject.new(0.15, "number"))
+	self._state = self._maid:Add(ValueObject.new({
+		p0 = 0;
+		p1 = 0;
+		t0 = 0;
+		t1 = 0;
+	}))
+
+	if transitionTime then
+		self:SetTransitionTime(transitionTime)
+	end
+
+	self._maid:GiveTask(self._transitionTime.Changed:Connect(function()
+		self:_updateState()
+	end))
+
+	self._maid:GiveTask(self.VisibleChanged:Connect(function()
+		self:_updateState()
+	end))
+	self:_updateState()
+
+	return self
+end
+
+function TimedTween:SetTransitionTime(transitionTime)
+	return self._transitionTime:Mount(transitionTime)
+end
+
+function TimedTween:ObserveRenderStepped()
+	return self:ObserveOnSignal(RunService.RenderStepped)
+end
+
+function TimedTween:ObserveOnSignal(signal)
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local startAnimate, stopAnimate = StepUtils.bindToSignal(signal, function()
+			local state = self:_computeState(os.clock())
+			sub:Fire(state.p)
+			return state.rtime > 0
+		end)
+
+		maid:GiveTask(stopAnimate)
+		maid:GiveTask(self._state.Changed:Connect(startAnimate))
+		startAnimate()
+
+		return maid
+	end)
+end
+
+function TimedTween:Observe()
+	return self:ObserveOnSignal(RunService.RenderStepped)
+end
+
+function TimedTween:PromiseFinished()
+	local initState = self:_computeState(os.clock())
+	if initState.rtime <=  0 then
+		return Promise.resolved()
+	end
+
+	local maid = Maid.new()
+	local promise = Promise.new()
+	maid:GiveTask(promise)
+
+	maid:GiveTask(self._state:Observe():Subscribe(function()
+		local state = self:_computeState(os.clock())
+		if state.rtime <= 0 then
+			promise:Resolve()
+			return
+		end
+
+		maid._scheduled = task.delay(state.rtime, function()
+			promise:Resolve()
+		end)
+	end))
+
+	self._maid[promise] = maid
+
+	promise:Finally(function()
+		self._maid[promise] = nil
+	end)
+
+	maid:GiveTask(function()
+		self._maid[promise] = nil
+	end)
+	return promise
+end
+
+function TimedTween:_updateState()
+	local transitionTime = self._transitionTime.Value
+	local target = self:IsVisible() and 1 or 0;
+
+	local now = os.clock()
+	local computed = self:_computeState(now)
+	local p0 = computed.p
+
+	local remainingDist = target - p0
+
+	self._state.Value = {
+		p0 = p0;
+		p1 = target;
+		t0 = now;
+		t1 = now + Math.map(math.abs(remainingDist), 0, 1, 0, transitionTime);
+	}
+end
+
+function TimedTween:_computeState(now)
+	local state = self._state.Value
+	local p
+
+	local duration = math.max(0, state.t1 - state.t0)
+	if duration == 0 then
+		p = state.p1
+	else
+		p = Math.map(math.clamp(now, state.t0, state.t1), state.t0, state.t1, state.p0, state.p1)
+	end
+
+	local rtime = math.abs(state.p1 - p)*duration
+
+	local v
+	if rtime > 0 and duration > 0 then
+		v = (state.p1 - state.p0)/duration
+	else
+		v = 0
+	end
+
+	return {
+		p = p;
+		v = v;
+		rtime = rtime;
+	}
+end
+
+
+return TimedTween

package/src/Shared/TimedTween.story.lua

@@ -0,0 +1,34 @@
+--[[
+	@class TimedTween.story
+]]
+
+local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).load(script)
+
+local Maid = require("Maid")
+local TimedTween = require("TimedTween")
+local Blend = require("Blend")
+
+return function(target)
+	local maid = Maid.new()
+
+	local timedTween = TimedTween.new(0.3)
+	maid:GiveTask(timedTween)
+
+
+	maid:GiveTask(Blend.mount(target, {
+		Blend.New "TextButton" {
+			Size = UDim2.fromScale(1, 1);
+			BackgroundTransparency = Blend.Computed(timedTween:Observe(), function(position)
+				return 1 - position
+			end);
+
+			[Blend.OnEvent "Activated"] = function()
+				timedTween:Toggle()
+			end;
+		};
+	}));
+
+	return function()
+		maid:DoCleaning()
+	end
+end

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}

package/test/default.project.json

@@ -0,0 +1,11 @@
+{
+  "name": "TimedTweenTest",
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "timedtween": {
+        "$path": ".."
+      }
+    }
+  }
+}