cluaupp 1.0.0 → 1.4.0

package/runtime/StateMachine/Classes/Transition.lua

@@ -1,336 +0,0 @@
-local mergeTables = require(script.Parent.Parent.Functions.mergeTables)
-
---[=[
-    @class Transition
-
-    Dictates how and when should you move between different states
-]=]
-local Transition = {}
-Transition.__index = Transition
-Transition.Type = "Transition"
---[=[
-    @prop Name string
-    @within Transition
-
-    The name of the state. This is used to identify the state. Usually set while creating the state
-
-    ```lua
-    local Transition = StateMachine.Transition
-
-    local GoToBlue = Transition.new("Blue")
-    GoToBlue.Name = "GoToBlue"
-    ```
-]=]
-Transition.Name = "" :: string
---[=[
-    @prop TargetState string
-    @within Transition
-
-    The name of the state. This is used to identify the state. Usually set while creating the state
-
-    ```lua
-    local Transition = StateMachine.Transition
-
-    local GoToBlue = Transition.new("Blue") -- The target state is now "Blue"
-    print(GoToBlue.TargetState) -- "Blue"
-    ```
-]=]
-Transition.TargetState = "" :: string
---[=[
-    @prop Data {[string]: any}
-    @within Transition
-
-    Contains the state machine data, it can be accessed from within the class
-
-    ```lua
-    local Default: State = State.new("Blue")
-
-    function Default:OnInit(data)
-        print(self.Data)
-    end
-    ```
-]=]
-Transition.Data = {} :: {[string]: any}
---[=[
-    @prop _changeState (newState: string)->()?
-    @within Transition
-    @private
-
-    This is used to change the state of the state machine. This is set by the state machine itself
-]=]
-Transition._changeState = nil :: (newState: string)->()?
---[=[
-    @prop _changeData (index: string, newValue: any)->()?
-    @within Transition
-    @private
-
-    This is used to change the data of the state machine. This is set by the state machine itself
-]=]
-Transition._changeData = nil :: (index: string, newValue: any)-> ()?
---[=[
-    @prop _getState (index: string, newValue: any)-> string
-    @within Transition
-    @private
-
-    Gets the current state of our state machine
-]=]
-Transition._getState = nil :: (index: string, newValue: any)-> string
---[=[
-    @prop _getPreviousState ()-> string?
-    @within Transition
-    @private
-
-    Gets the previous state of our state machine
-]=]
-Transition._getPreviousState = nil :: ()-> string?
-
---[=[
-    Creates a new transition. Transitions are used to tell our state
-    when and how should it move from the current state to a different one.
-    They are meant to be reusable and allow us to easily add and reuse transitions
-    between states and objects
-
-    ```lua
-    local ReplicatedStorage = game:GetService("ReplicatedStorage")
-
-    local StateMachine = require(ReplicatedStorage.RobloxStateMachine)
-    local Transition = StateMachine.Transition
-
-    local GoToBlue = Transition.new("Blue")
-    GoToBlue.OnHearbeat = false
-
-    function GoToBlue:OnDataChanged(data)
-        return tick() - data.time > 10 -- Will change to blue after 10 seconds 
-    end
-
-    return GoToBlue
-    ```
-
-    @param targetState string? -- The state the transition will change to when it meets the requirements
-
-    @return Transition
-]=]
-function Transition.new(targetState: string?): Transition
-    local self = setmetatable({}, Transition)
-    self.TargetState = targetState or ""
-
-    return self
-end
-
---[=[
-    Extends a state inheriting the behavior from the parent state
-
-    ```lua
-    local transition = Transition.new("Blue")
-    
-    function transition:Print()
-        print("Hello World!")
-    end
-
-    local extendedTransition = transition:Extend("Red")
-
-    function extendedTransition:OnInit()
-        self:Print() -- Will print "Hello World!"
-    end
-    ```
-
-    @param targetState string
-
-    @return Transition
-]=]
-function Transition:Extend(targetState: string): Transition
-    return mergeTables(Transition.new(targetState), self)
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    Called whenever the state machine is created
-
-    ```lua
-    function Transition:OnInit()
-        print("Hello World")
-    end
-    ```
-
-    @param _data {[string]: any} -- This is the data from the StateMachine itself!
-
-    @return ()
-]=]
-function Transition:OnInit(_data: {[string]: any}): ()
-    
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    Called whenever you enter this transition object
-
-    ```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 Transition:OnEnter(_data: {[string]: any}): ()
-
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    Called whenever you leave this transition object
-
-    ```lua
-    function State:OnLeave(data)
-        data.stuff:Clean()
-    end
-    ```
-
-    @param _data {[string]: any} -- This is the data from the StateMachine itself!
-
-    @return ()
-]=]
-function Transition:OnLeave(_data: {[string]: any}): ()
-
-end
-
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-
-    @deprecated v1.1.7 -- This function is redundant since it essencially just works as a blocker for OnDataChanged
-
-    Whether it can change to this state or not. It's a good way to lock the current state
-
-    @param data {[string]: any}
-
-    @return boolean -- By default it returns true
-]=]
-function Transition:CanChangeState(data: {[string]: any}): boolean
-    assert(data, "")
-    return true
-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 Transition:ChangeState(newState: string): ()
-    if not self._changeState then
-        return
-    end
-
-    self._changeState(newState)
-end
-
---[=[
-    :::info
-    This is a **Virtual Method**. Virtual Methods are meant to be overwritten
-    :::
-    
-    Should return true if it should change to the target state
-    and false if it shouldn't
-
-    @param data {[string]: any}
-
-    @return boolean -- By default it returns false
-]=]
-function Transition:OnDataChanged(data: {[string]: any}): boolean
-    assert(data, "")
-    return false
-end
-
---[=[
-    Gets the current state of our state machine
-
-    @return string
-]=]
-function Transition:GetState(): string
-    if not self._getState then
-        return ""
-    end
-
-    return self._getState()
-end
-
---[=[
-    Gets the previous state of our state machine
-
-    @return string
-]=]
-function Transition: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 Transition: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 the state machine is destroyed
-
-    ```lua
-    function Transition:OnDestroy()
-        print("I was destroyed!")
-    end
-    ```
-
-    @return ()
-]=]
-function Transition:OnDestroy(): ()
-    
-end
-
-export type Transition = typeof(Transition)
-
-return setmetatable(Transition, {
-    __call = function(_, properties): Transition
-        return Transition.new(properties)
-    end
-})

package/runtime/StateMachine/Functions/deepCopy.lua

@@ -1,19 +0,0 @@
---[[
-    Deep copy of the object
-]]
-local function deepCopy<T>(object)
-    local newObject = setmetatable({}, getmetatable(object)) -- Clone metaData
-
-    for index: string, value: any in object do
-        if typeof(value) == "table" then
-            newObject[index] = deepCopy(value)
-            continue
-        end
-
-        newObject[index] = value
-    end
-
-    return newObject
-end
-
-return deepCopy

package/runtime/StateMachine/Functions/mergeTables.lua

@@ -1,22 +0,0 @@
---[[
-    Merges two tables together
-]]
-local function mergeTables(baseTable, targetTable)
-    for index: string, value in targetTable do
-        if typeof(baseTable[index]) == typeof(value) then
-            if baseTable[index] ~= (getmetatable(baseTable) or {})[index] then
-                continue
-            end
-        end
-
-        if type(value) == "table" then
-            baseTable[index] = table.clone(value)
-        else
-            baseTable[index] = value
-        end
-    end
-
-    return baseTable
-end
-
-return mergeTables

package/runtime/StateMachine/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) [2023] [prooheckcp]
-
-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.