Catwork¶

Catwork refers to the root object that is returned when the module is required

require(path.to.catwork)

Properties¶

{[string]: Fragment<any>}

A table of fragments currently loaded inside the Catwork module. Destroyed fragments do not appear in this table.

{[string]: Service}

A table of services currently loaded inside the Catwork module.

Plugin?

A reference to the plugin if applicable, this key is only defined if Catwork is running in a plugin context.

string

The current Catwork version.

<A>(params: A) -> Fragment<A>

Creates a new Fragment from the given parameters.

Code Example:

return Catwork.Fragment {
    Name = "MeowService",

    Init = function(self)
        print("meow!")
    end
}

Tip

From 0.4.4 onwards, you are able to define the ID explicitly using the ID key. These are known internally as StaticFragments.

Catwork.Fragment {
    ID = "MeowServiceStatic"
}

(params) -> Service

Creates a service from a given parameter table. For more information, refer to the Services tutorial.

<A>(params: A, service: Service) -> Fragment<A>

Builds a Fragment for a given service, then returns it to the service's FragmentAdded callback.

Warning

Always call this method in a Service.Fragment definition, otherwise the fragment will never initialise.

(name: string) -> {[string]: Fragment<any>}

Returns a list of fragments, or an empty table, of Fragments matching the given name.

Note

These events are designed for tracking object creation in debugging tools.

Event<Fragment<any>>

Fired when a Fragment is created through CreateFragmentForService.

Event<Fragment<any>>

Fired when a Fragment is destroyed.

Event<Service>

Fired when a new service is created.

Event<Template>

Fired when a new template is created.