sim-ecs - v0.6.5
    Preparing search index...

    Interface IMutableWorld

    interface IMutableWorld {
        addEntitiesToGroup(
            groupHandle: number,
            entities:
                | IterableIterator<IEntity, any, any>
                | readonly Readonly<IEntity>[],
        ): void;
        addEntity(entity: Readonly<IEntity>): void;
        addEntityToGroup(groupHandle: number, entity: Readonly<IEntity>): void;
        addResource<T extends object>(
            type: T | TTypeProto<T>,
            ...args: readonly unknown[],
        ): T | TTypeProto<T>;
        assimilateGroup(
            otherWorld: Readonly<IPreptimeWorld>,
            groupHandle: number,
        ): number;
        buildEntity(uuid?: string): IEntityBuilder;
        clearEntities(): void;
        clearGroups(): void;
        clearResources(): void;
        createEntity(): IEntity;
        createGroup(): number;
        load(
            prefab: Readonly<ISerialFormat>,
            options?: Readonly<ISerDeOptions<TDeserializer>>,
            intoGroup?: number,
        ): number;
        merge(
            world: Readonly<IRuntimeWorld | IPreptimeWorld>,
            intoGroup?: number,
        ): [number, IEntity[]];
        removeEntity(entity: Readonly<IEntity>): void;
        removeGroup(groupHandle: number): void;
        removeResource<T extends object>(type: TTypeProto<T>): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    addEntitiesToGroup addEntity addEntityToGroup addResource assimilateGroup buildEntity clearEntities clearGroups clearResources createEntity createGroup load merge removeEntity removeGroup removeResource

    Methods

    • Add several entities in this world to a group in this world

      Parameters

      • groupHandle: number
      • entities: IterableIterator<IEntity, any, any> | readonly Readonly<IEntity>[]

      Returns void

    • Add an entity in this world to a group in this world

      Parameters

      • groupHandle: number
      • entity: Readonly<IEntity>

      Returns void

    • Add a resource to this world and returns the resource instance

      Type Parameters

      • T extends object

      Parameters

      • type: T | TTypeProto<T>
      • ...args: readonly unknown[]

        constructor parameters

      Returns T | TTypeProto<T>

    • Move group from other world to this one. A new handle will be generated!

      Parameters

      Returns number

    • Remove a group and all entities inside from this world

      Parameters

      • groupHandle: number

      Returns void

    • Remove a resource from this world

      Type Parameters

      • T extends object

      Parameters

      • type: TTypeProto<T>

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods