Interface Type<C, B, I>

A ClusterBehavior specialized for a specific Cluster.

interface Type<C, B, I> {
    new Typenew (agent: Agent, backing: BehaviorBacking): Instance<C, B, I>;
    cluster: C;
    defaults: ClusterState.Type<C, B>;
    dependencies?: Iterable<Type, any, any>;
    early: boolean;
    Events: ClusterEvents.Type<C, B>;
    ExtensionInterface: ExtensionInterfaceOf<B>;
    id: Uncapitalize<C["name"]>;
    Interface: I;
    Internal: B["Internal"];
    name: string;
    schema?: Schema;
    State: (new () => ClusterState.Type<C, B>);
    supervisor: RootSupervisor;
    supports: ((other: Type) => boolean);
    alter<This, const AlterationsT>(this: This, alterations: AlterationsT): Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>;
    enable<This, const FlagsT>(this: This, flags: FlagsT): Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>;
    for<This, const ClusterT>(this: This, cluster: ClusterT, schema?: Schema): Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>;
    set<This>(this: This, defaults: Partial<RelaxTypes<InstanceType<This["State"]>>>): This;
    with<This, const FeaturesT>(this: This, ...features: FeaturesT): Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>;
}

Type Parameters

Constructors

constructor

Properties

cluster defaults dependencies? early Events ExtensionInterface id Interface Internal name schema? State supervisor supports

Methods

alter enable for set with

Constructors

constructor

  • new Type(agent, backing): Instance<C, B, I>

  • Parameters

    • agent: Agent
    • backing: BehaviorBacking

    Returns Instance<C, B, I>

Properties

Readonlycluster

cluster: C

Base cluster state include all attribute values but may be extended by subclasses.

Readonlydefaults

defaults: ClusterState.Type<C, B>

Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Readonlyearly

early: boolean

ReadonlyEvents

Events: ClusterEvents.Type<C, B>

ReadonlyExtensionInterface

ExtensionInterface: ExtensionInterfaceOf<B>

Readonlyid

id: Uncapitalize<C["name"]>

The behavior ID for ClusterBehaviors is the name of the cluster.

ReadonlyInterface

Interface: I

ReadonlyInternal

Internal: B["Internal"]

Readonlyname

name: string

Optional Readonlyschema

schema?: Schema

ReadonlyState

State: (new () => ClusterState.Type<C, B>)

Readonlysupervisor

supervisor: RootSupervisor

supports

supports: ((other: Type) => boolean)

Type declaration

    • (other): boolean

    • Does this behavior support functionality of a specific implementation?

      Parameters

      Returns boolean

Methods

alter

enable

for

set

  • set<This>(this, defaults): This

  • Type Parameters

    Parameters

    Returns This

with

Settings

Member Visibility

On This Page

Constructors
Properties
Methods