cluaupp 1.0.0 → 1.4.0

package/runtime/Spring/_impl/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

package/runtime/Spring/_impl/init.luau

@@ -1,111 +0,0 @@
---!strict
---!native
--- Based on https://gist.github.com/Fraktality/1033625223e13c01aa7144abe4aaf54d
-
-export type Spring = {
-	__index: Spring,
-	Damping: number,
-	Frequency: number,
-	Goal: number,
-	Position: number,
-	Velocity: number,
-	new: (dampingRatio: number, frequency: number, position: number) -> Spring,
-	Set: (self: Spring, goal: number) -> nil,
-	Get: (self: Spring) -> number,
-	Step: (self: Spring, deltaTime: number) -> nil,
-}
-
-local Spring: Spring = {} :: any
-Spring.__index = Spring
-
-function Spring.new(dampingRatio: number, frequency: number, position: number): Spring
-	local self: Spring = setmetatable({}, Spring) :: any
-	
-	assert(dampingRatio*frequency >= 0, 'stop that')
-
-	self.Damping = dampingRatio -- damping ratio
-	self.Frequency = frequency -- nominal frequency
-	self.Goal = position -- goal position
-	self.Position = position -- position
-	self.Velocity = position*0 -- velocity (times 0 so the types match)
-	
-	return self
-end
-
-function Spring:Set(goal: number)
-	self.Goal = goal
-	return nil
-end
-
-function Spring:Get(): number
-	return self.Position
-end
-
-function Spring:Step(deltaTime: number): nil
-	local damping = self.Damping
-	local frequency = self.Frequency*2*math.pi
-	local goal = self.Goal
-	local position = self.Position
-	local velocity = self.Velocity
-
-	local offset = position - goal
-	local decay = math.exp(-deltaTime*damping*frequency)
-
-	-- Given:
-	--   frequency^2*(x[deltaTime] - goal) + 2*damping*frequency*x'[deltaTime] + x''[deltaTime] = 0,
-	--   x[0] = position,
-	--   x'[0] = velocity
-	-- Solve for x[deltaTime], x'[deltaTime]
-	
-	if damping == 1 then -- critically damped
-
-		self.Position = (velocity*deltaTime + offset*(frequency*deltaTime + 1))*decay + goal
-		self.Velocity = (velocity - frequency*deltaTime*(offset*frequency + velocity))*decay
-
-	elseif damping < 1 then -- underdamped
-
-		local c = math.sqrt(1 - damping*damping)
-
-		local i = math.cos(frequency*c*deltaTime)
-		local j = math.sin(frequency*c*deltaTime)
-
-		self.Position = (i*offset + j*(velocity + damping*frequency*offset)/(frequency*c))*decay + goal
-		self.Velocity = (i*c*velocity - j*(velocity*damping + frequency*offset))*decay/c
-
-	elseif damping > 1 then -- overdamped
-
-		local c = math.sqrt(damping*damping - 1)
-
-		local r1 = -frequency*(damping - c)
-		local r2 = -frequency*(damping + c)
-
-		local co2 = (velocity - r1*offset)/(2*frequency*c)
-		local co1 = offset - co2
-
-		local e1 = co1*math.exp(r1*deltaTime)
-		local e2 = co2*math.exp(r2*deltaTime)
-		
-		self.Position = e1 + e2 + goal
-		self.Velocity = r1*e1 + r2*e2
-
-	end
-	return nil
-end
-
-
-function Spring:Impulse(velocity: number)
-	self.Velocity += velocity
-	return nil
-end
-
-function Spring:SetGoal(target: number)
-	self:Set(target)
-	return nil
-end
-
-function Spring:Update(dt: number): number
-	self:Step(dt)
-	return self.Position
-end
-
-return Spring

package/runtime/Spring/init.luau

@@ -1,24 +0,0 @@
---!strict
--- Cluaupp Spring — typed border over nightcycle/spring (_impl).
-
-local Impl = require(script._impl)
-
-export type Spring = {
-	Damping: number,
-	Frequency: number,
-	Goal: number,
-	Position: number,
-	Velocity: number,
-	Set: (self: Spring, goal: number) -> (),
-	Get: (self: Spring) -> number,
-	Step: (self: Spring, deltaTime: number) -> (),
-	Impulse: (self: Spring, velocity: number) -> (),
-	SetGoal: (self: Spring, target: number) -> (),
-	Update: (self: Spring, dt: number) -> number,
-}
-
-type SpringStatic = {
-	new: (dampingRatio: number, frequency: number, position: number) -> Spring,
-}
-
-return Impl :: SpringStatic

package/runtime/StateMachine/Classes/State.lua

@@ -1,375 +0,0 @@
-local Transition = require(script.Parent.Transition)
-local mergeTables = require(script.Parent.Parent.Functions.mergeTables)
-
---[=[
-    @class State
-
-    Describes one of the many states an object can have. It also declares
-    how it should behave when it enters, is and leaves the given state
-]=]
-local State = {}
-State.__index = State
-State.Type = "State"
---[=[
-    @prop Name string
-    @within State
-
-    The name of the state. This is used to identify the state. Usually set while creating the state
-
-    ```lua
-    local Blue: State = State.new("Blue")
-    ```
-]=]
-State.Name = "" :: string
---[=[
-    @prop Transitions string
-    @within State
-
-    A reference for the transitions of this state. This is usually set while creating the state
-
-    ```lua
-    local GoToBlue = require(script.Parent.Parent.Transitions.GoToBlue)
-
-    local State = StateMachine.State
-
-    local Default = State.new("Default")
-    Default.Transitions = {GoToBlue}
-    ```
-]=]
-State.Transitions = {} :: {Transition.Transition}
---[=[
-    @prop Data {[string]: any}
-    @within State
-
-    Contains the state machine data, it can be accessed from within the class
-]=]
-State.Data = {} :: {[string]: any}
---[=[
-    @prop _transitions {[string]: Transition.Transition}
-    @within State
-    @private
-
-    Used to cache the transitions objects
-]=]
-State._transitions = {} :: {[string]: Transition.Transition}
---[=[
-    @prop _changeState (newState: string)->()?
-    @within State
-    @private
-
-    This is used to change the state of the state machine. This is set by the state machine itself
-]=]
-State._changeState = nil :: (newState: string)->()?
---[=[
-    @prop _changeData (index: string, newValue: any)->()?
-    @within State
-    @private
-
-    This is used to change the data of the state machine. This is set by the state machine itself
-]=]
-State._changeData = nil :: (index: string, newValue: any)-> ()?
---[=[
-    @prop _getState (index: string, newValue: any)-> string
-    @within State
-    @private
-
-    Gets the current state of our state machine
-]=]
-State._getState = nil :: (index: string, newValue: any)-> string
---[=[
-    @prop _getPreviousState ()-> string?
-    @within State
-    @private
-
-    Gets the previous state of our state machine
-]=]
-State._getPreviousState = nil :: ()-> string?
---[=[
-    Used to create a new State. The state should manage how the object should behave during
-    that given state. I personally recommend having your states in their own files for organizational
-    purposes
-
-    ```lua
-    local ReplicatedStorage = game:GetService("ReplicatedStorage")
-
-    local StateMachine = require(ReplicatedStorage.RobloxStateMachine)
-    local State = StateMachine.State
-
-    local Default = State.new("Blue") -- The name of this state is "Blue"
-    Default.Transitions = { -- The transitions that will be listened to while in the blue state
-        transition1,
-        transition2
-    }
-    function Default:OnEnter(data)
-        data.part.Color = Color3.fromRGB(0, 166, 255) --This will turn the part Blue when it enters the state blue
-    end
-
-    return Default
-    ```
-
-    @param stateName string?
-
-    @return State
-]=]
-function State.new(stateName: string?): State
-    local self = setmetatable({}, State)
-    
-    self.Name = stateName or ""
-    self.Transitions = {}
-
-    return self
-end
-
---[=[
-    Extends a state inheriting the behavior from the parent state
-
-    ```lua
-    local state = State.new("Blue")
-    
-    function state:Print()
-        print("Hello World!")
-    end
-
-    local extendedState = state:Extend("Red")
-
-    function extendedState:OnInit()
-        self:Print() -- Will print "Hello World!"
-    end
-    ```
-
-    @param stateName string
-
-    @return State
-]=]
-function State:Extend(stateName: string): State
-    return mergeTables(State.new(stateName), self)
-end
-
---[=[
-    Forcelly changes the current state of our state machine to a new one
-
-    @param newState string -- The name of the new state
-
-    @return ()
-]=]
-function State:ChangeState(newState: string): ()
-    if not self._changeState then
-        return
-    end
-
-    self._changeState(newState)
-end
-
---[=[
-    Gets the current state of our state machine
-
-    @return string
-]=]
-function State:GetState(): string
-    if not self._getState then
-        return ""
-    end
-
-    return self._getState()
-end
-
---[=[
-    Gets the previous state of our state machine
-
-    @return string
-]=]
-function State:GetPreviousState(): string
-    if not self._getPreviousState then
-        return ""
-    end
-
-    return self._getPreviousState()
-end
-
---[=[
-    Changing data request. You can also just Get the data and change the data at run time.
-
-    ```lua
-    local example: State = State.new("Blue")
-
-    function example:OnEnter(data)
-        self:ChangeData("color", Color3.fromRGB(255, 0, 0)) -- Change to red :D
-
-        data.part.Color = data.color
-    end
-    ```
-
-    @param index string
-    @param newValue any
-
-    @return ()
-]=]
-function State:ChangeData(index: string, newValue: any): ()
-    if not self._changeData then
-        return
-    end
-
-    self._changeData(index, newValue)
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    Called whenever a state machine is created with this state.
-
-    ```lua
-    function State:OnInit(data)
-        print("I was init!")
-        self.SomeStartingData = tick()
-    end
-    ```
-
-    @param _data {[string]: any} -- This is the data from the StateMachine itself!
-
-    @return ()
-]=]
-function State:OnInit(_data: {[string]: any}): ()
-
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    ```lua
-    function State:CanChangeState(targetState: string)
-        return targetState == "Blue" -- If the target state is blue, we can change to it
-    end
-    ```
-
-    @param _targetState string -- The state we are trying to change to
-
-    @return boolean -- Whether or not we can change to the given state
-]=]
-function State:CanChangeState(_targetState: string): boolean
-    return true
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    :::warning
-    **OnDataChanged** only gets called when the data is changed by a **ChangeData** call
-    :::
-
-    Called whenever the data of the state machine changes.
-
-    ```lua
-    function State:OnDataChanged(data, index, newValue, oldValue)
-        if index == "SomeStartingData" then
-            self.SomeStartingData = value
-        end
-    end
-    ```
-
-    @param _data {[string]: any} -- This is the data from the StateMachine itself!
-    @param _index any -- The index of the data that changed
-    @param _value any -- The new value of the data
-    @param _oldValue any -- The old value of the data
-
-    @return ()
-]=]
-function State:OnDataChanged(_data: {[string]: any}, _index: any, _value: any, _oldValue: any): ()
-
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    Called whenever you enter this state
-
-    ```lua
-    function State:OnEnter(data)
-        data.part.Color = Color3.fromRGB(0, 166, 255)
-    end
-    ```
-
-    @param _data {[string]: any} -- This is the data from the StateMachine itself!
-
-    @return ()
-]=]
-function State:OnEnter(_data: {[string]: any}): ()
-
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    Called every frame after the physics simulation while in this state
-
-    ```lua
-    function Default:OnHeartbeat(data, deltaTime: number)
-        self.timePassed += deltaTime
-    end
-    ```
-
-    @param _data {[string]: any} -- This is the data from the StateMachine itself!
-    @param _deltaTime number
-
-    @return ()
-]=]
-function State:OnHeartbeat(_data: {[string]: any}, _deltaTime: number): ()
-
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    Called whenever you leave this state
-
-    ```lua
-    function State:OnLeave(data)
-        data.stuff:Clean()
-    end
-    ```
-
-    @param _data {[string]: any} -- This is the data from the StateMachine itself!
-
-    @return ()
-]=]
-function State:OnLeave(_data: {[string]: any}): ()
-
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    Called whenever the state machine is destroyed
-
-    ```lua
-    function State:OnDestroy()
-        print("I was destroyed!")
-    end
-    ```
-
-    @return ()
-]=]
-function State:OnDestroy(): ()
-    
-end
-
-export type State = typeof(State)
-
-return setmetatable(State, {
-    __call = function(_, properties): State
-        return State.new(properties)
-    end
-})