Silk

A singleton class that is shared between scripts.

Types

Container

</>

type Container = Folder

A Container is a Folder that contains a specific collection of objects as its children. Containers can be added to the framework using Silk.AppendContainers during the initializer phase.

Adding containers:

-- || initializer.server.lua ||

silk:AppendContainers{

	-- Supply a folder 'Assets' as a container with the name 'Asset'
	Asset = silk.ReplicatedStorage:WaitForChild('Assets'),
}

You can access a container by executing Silk.Get<Container>(object: string) -> Instance as a method of the framework. See below for more details.

Accessing objects inside containers:

-- A container named 'Asset'
local asset = silk:GetAsset('Model'):Clone()

Container methods:

• Silk.AppendContainers
• Silk.GetContainer

Service

</>

type Service = Instance

Roblox service as an Instance.

Getting a service:

-- Directly access any service from Silk
local replicatedStorage = silk.ReplicatedStorage

Limitation

You may recieve an error while trying to get some services. This is because the service may not exist in the current list of services. To fix this, open the ModuleScript services and manually type it in.

Functions

getScript

utility

</>

Silk.getScript() → ModuleScript

This utility function returns a reference to the main SILK ModuleScript. You can use it to easily access the contents of the script. For instance, when adding in essential packages to the framework.

Adding essential packages:

-- || initializer.server.lua ||

silk:AppendPackages{

	-- Directly access the children of the ModuleScript
	silk.getScript():WaitForChild('essentials'),
}

new

utility

</>

Silk.new(

object: string | Instance,

parent: Instance?

) → SilkObject

Built-in implementation of a method-chainable object instantiator. Call itself at the end of the chain to return Instance.

Creating a new part:

local part = silk.new('Part', workspace).Name('NewPart').Anchored(true)()

waitFor

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yieldsutility

</>

Silk.waitFor(

objects: {

Instance,

...string

},

timeout: number?

) → Instance

A custom wrapper function for the Instance.WaitForChild method. Use this utility function to simplify your code and avoid redundant chains of consequtive WaitForChild calls.

Usage example:

-- Long, consequtive calls of .WaitForChild...
A:WaitForChild('B'):WaitForChild('C'):WaitForChild('D')

-- ...can be simplied to this
silk.waitFor{ A, 'B', 'C', 'D' }

FireAllClients

network

</>

Silk:FireAllClients(

action: string,

...: any

) → ()

FireClient

network

</>

Silk:FireClient(

client: Player,

action: string,

...: any

) → ()

FireServer

network

</>

Silk:FireServer(

action: string,

...: any

) → ()

InvokeServer

network

</>

Silk:InvokeServer(

action: string,

...: any

) → ...any

RegisterAction

network

</>

Silk:RegisterAction(

action: string,

callback: (...any) → ...any

) → ()

Register an action to the server to quickly handle commuincation between server and client.

tip

Use this method in packages that require server and client communication for initialization.

UnregisterAction

network

</>

Silk:UnregisterAction(action: string) → ()

Remove an existing action from the server.

AppendClasses

initializer

</>

Silk:AppendClasses(classdirectories: {Folder}) → ()

Use this method to supply multiple class directories to the framework.

AppendContainers

initializer

</>

Silk:AppendContainers(containerDirectories: {[string]: Folder}) → ()

Use this method to supply multiple container directories to the framework.

AppendPackages

initializer

</>

Silk:AppendPackages(packageDirectories: {Folder}) → ()

Use this method to supply multiple package directories to the framework.

Declare

</>

Silk:Declare(

callback: (

msg: string,

...any

) → ..any,

msg: string

) → ()

Used internally to indicate potential any errors and warnings to output.

GetClass

</>

Silk:GetClass(class: string) → ModuleScript

Returns the ModuleScript instace associated with the class.

GetContainer

</>

Silk:GetContainer(container: string) → Folder

Returns the Folder instance associated with the container.

GetService

</>

Silk:GetService(service: string) → Instance

Gets a Roblox service as an Instance and caches it internally. This method is called internally whenever a service is attempted to be retrieved via silk.<Service>.

InitClass

</>

Silk:InitClass(class: string) → ...any

This method is called internally whenever a class is referenced silk.Classes.<Class>. This method can be used directly to intialize any class if needed.

InitPackage

</>

Silk:InitPackage(package: Package) → ...any

This method is called internally whenever a package is referenced silk.Packages.<Package>.

tip

Use this method to intialize any singleton packages during the initializer phase.

IsServer

</>

Silk:IsServer() → boolean

Returns true if the current execution is taking place on the server.

Wait

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields

</>

Silk:Wait() → Silk

Yields until the initialization phase is completed, i.e. Silk should be accessed this way for all scripts except the initializer scripts. See Silk.Weave for more information.

Weave

</>

Silk:Weave() → ()

Marks the end of the initialization phase and resumes execution for all scripts yielding with Silk.Wait. Use this method inside of a single initializer script and call it at the end of the phase when all the initializations are complete. See below for more details.

Sample initializer script

-- || initializer.server.lua ||

local silk = require(...)

-- Perform initializations
silk:AppendPackages{ ... }
silk:AppendContainers{ ... }
silk:AppendClasses{ ... }
silk.Packages.Network:AppendCommunicators{ ... }

-- Call Silk.Weave to end the initialization phase
silk:Weave()