Modules

Modules that come with the Evolve Framework.

Custom Objects

This module creates Custom Objects defined by classes you create within the Classes folder under Modules.

Replication

This module supports state replication to clients. It follows the same rules as existing Roblox instance state replication.
Replication only occurs when the base instance is parented to a replicated directory.

Replicated Directories	Non Replicated Directories
Workspace	Replicated First
Players	Network Client
ReplicatedStorage	ServerScriptService
StarterGui	ServerStorage
StarterPack	nil
StarterPlayer

Methods

new( instance Object, string Class, ... )

Returns instance, ... alongside any additional variables returned from class defined new.
Creates new CustomObject based on new constructor defined in the class specified by the second argument. Any more arguments will be passed to the user defined new constructor.

Wrap( instance Object, string Class )

Returns customobject
Wraps passed Object into CustomObject. Allows you to transform existing instances into CustomObjects to retain properties and explorer hierarchy.
If second argument Class is not provided, thread will yield until Object is wrapped via another thread. Useful in waiting for CustomObject to load via another thread before continuing.

Clone( customobject CustomObject )

Returns customobject
Forwards Clone function call to base instance, duplicates all custom properties assigned, calls Initialize method within class of Cloned CustomObject (if defined), and generates new UUID.
NOTE: Do NOT call Clone function within an Initialize function. A safety is in place to error in the case, without it, an infinite loop of cloning would occur.

GetObject( customobject CustomObject )

Returns instance
Returns base instance that the CustomObject wrapper is applied to.

GetClassName( customobject CustomObject )

Returns string
Returns name of Class that the CustomObject was created from.

GetUUID( customobject CustomObject )

Returns number
Returns unique ID assigned to all CustomObjects.

Usage

Here's an example incorporating all of the above methods.

--Some script

local require = require(game:GetService("ReplicatedStorage"):WaitForChild("Evolve")) --Require module loader
local CO = require("CustomObjects") --Require "CustomObjects" module


--new--
local Rain = CO.new("Rain") --Contingent on "Rain" class being created and "new" constructor must return an Instance
if not Rain.IsFalling then --Accessing "IsFalling" property of rain (Returns nil if it does not exist *DOES NOT ERROR*)
    Rain:Start() --Starts rain if it was not already falling. Contingent on "Start" function defined within the "Rain" class
end


--Wrap--
local Ground = CO.Wrap(workspace.Baseplate,"Ground") --Contingent on "Ground" class being created
Ground.Hardness = 100 --Setting "Hardness" as a custom property with value 100
Ground.Anchored = true --You can also address properties that exist within the Instance; in this example it is BasePart property: "Anchored"
Ground:Break() --Contingent on "Break" function being defined in the existing "Ground" class


--Clone--
local newGround = Ground:Clone() --Clones base instance along with all properties and returns a new CustomObject (with new UUID)
Ground:Destroy() --Calling destroy on CustomObject will Destroy base instance and remove the CustomObject wrapper
newGround.Parent = workspace --Addressing BasePart "Parent" property of base instance
Ground = newGround


--GetObject--
local newPart = Instance.new("Part")
newPart.Parent = Ground:GetObject() --"GetObject" function was needed here since you cannot set the "Parent" of an instance to a CustomObject, or as Roblox sees it, a table


--GetClassName--
print(Ground:GetClassName()) --prints "Ground"


--GetUUID--
print(Ground:GetUUID()) --prints "6"

Events

This module handles creation of Events.

Methods

new( string ClassName )

Returns instance or Returns RBXScriptConnection
Creates new Event of type ClassName. Handles parenting and naming if it is an instance.
This module incorporates stravant's Good Signal module. It offers a very performant alternative to BindableEvents using the new Task Library. Passing "Signal" to this function will create a custom RBXScriptConnection and return it.

Usage

I will show a simple example of a car being purchased. A purchase "Signal" event is defined in the "Car" class. It is then Fired within the Car class' "Purchase" function and the firing event is connected to and acted upon in a third script.

--Car Class Module Script
local Car = {}

local require = require(game:GetService("ReplicatedStorage"):WaitForChild("Evolve")) --Require module loader
local Events = require("Events") --Require "Events" module

Car.Purchased = Events.new("Signal")

function Car:Purchase()
   self.Purchased:Fire()
end

return Car

--Some script
local require = require(game:GetService("ReplicatedStorage"):WaitForChild("Evolve")) --Require module loader
local CO = require("CustomObjects") --Require "CustomObjects" module

local Car = CO.Wrap(workspace.Car,"Car")
Car:Purchase()

--Some other script
local require = require(game:GetService("ReplicatedStorage"):WaitForChild("Evolve")) --Require module loader
local CO = require("CustomObjects") --Require "CustomObjects" module

local Car = CO.Wrap(workspace.Car)

Car.Purchased:Connect(function()
   print("Car was purchased!")
end)

Although this example lacks practicality, you can see the custom "Signal" Event being initialized, connected to, and fired, displaying the cross script functionality available with the new bindable event alternative, "Signal".

This use case does not cover all possible event types being created but they follow the same construction procedure as displayed in the first script example.

Maid

Maid class incorporated from Quenty's Nevermore. Read his documentation here.
Works with Signal Event created via Events module.

Table

Methods

new ( string Type )

Returns table

Type	Description
CountedDictionary	# Operator works on the returned table. Allows to easily get length of non-array.

Usage

--Some script

local require = require(game:GetService("ReplicatedStorage"):WaitForChild("Evolve"))
local Table = require("Table") --Require "Table" module

local tbl = {["One"]=1,["Two"]=2,["Three"]=3} --Made a dictionary
print(#tbl) --prints "0"

local tbl = Table.new("CountedDictionary") --Made counted dictionary
tbl["One"]=1,tbl["Two"]=2,tbl["Three"]=3 --Inputting values
print(#tbl) --prints "3"

typeof ( variable Entity )

Returns string
This module returns a function. It is designed to expand on what is returned from the existing typeof function to allow identifying CustomObject and RBXScriptConnection.

Usage

--Some script

local require = require(game:GetService("ReplicatedStorage"):WaitForChild("Evolve"))
local Signal = require("CustomObjects") --Require "CustomObjects" module


local Signal = Events.new("Signal") --Contingent on "Ground" class being created


print(typeof(Signal)) --Using the original 'typeof' function, 'print' outputs "table"
---
local typeof = require("typeof") --Overwrites existing 'typeof' function with our extended version.
---
print(typeof(Signal)) --Using our extended 'typeof' function, 'print' outputs "RBXScriptConnection"