Framework

The main class

Functions

Add

Allows you to add directories that the framework will Init and Start when Start is called.

Parameters

• dirs: { Instance }
  A list of directories that should be loaded (shallow)

• filter: ((ModuleScript) -> boolean) OPTIONAL
  The filter which should be applied during loading, returning false means to skip the module

Returns

• void

---

Start

Starts the framework and prepares all of the lifecycles/providers.

Parameters

• options: { profiling: boolean? } OPTIONAL
  A list of settings or options to apply to the framework.

Returns

• void

---

Hook

Creates a new hook that uses pre-existing provider functions.

Parameters

• name: string
  The name of the function to run

• callback: (self: Hook, ...any) -> () OPTIONAL
  The callback that should run when Fire is called. Defaults to spawning each listener with arguments

Returns

• Hook