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

    Interface IPreptimeWorld

    interface IPreptimeWorld {
        config: IPreptimeWorldConfig;
        data: IPreptimeData;
        name?: string;
        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;
        getEntities(query?: Readonly<IEntitiesQuery>): IterableIterator<IEntity>;
        getExistingRuntimeWorlds(): readonly IRuntimeWorld[];
        getGroupEntities(groupHandle: number): IterableIterator<IEntity>;
        getResource<T extends object>(type: TTypeProto<T>): T;
        getResources(
            types?: readonly TExistenceQueryParameter<any>[],
        ): IterableIterator<object>;
        hasEntity(entity: Readonly<IEntity>): boolean;
        hasResource<T extends object>(type: T | TTypeProto<T>): boolean;
        load(
            prefab: Readonly<ISerialFormat>,
            options?: Readonly<ISerDeOptions<TDeserializer>>,
            intoGroup?: number,
        ): number;
        merge(
            world: Readonly<IRuntimeWorld | IPreptimeWorld>,
            intoGroup?: number,
        ): [number, IEntity[]];
        prepareRun(
            options?: Readonly<Partial<IPreptimeOptions>>,
        ): Promise<IRuntimeWorld>;
        removeEntity(entity: Readonly<IEntity>): void;
        removeGroup(groupHandle: number): void;
        removeResource<T extends object>(type: TTypeProto<T>): void;
        save(options?: Readonly<ISerDeOptions<TSerializer>>): ISerialFormat;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    config data name?

    Methods

    addEntitiesToGroup addEntity addEntityToGroup addResource assimilateGroup buildEntity clearEntities clearGroups clearResources createEntity createGroup getEntities getExistingRuntimeWorlds getGroupEntities getResource getResources hasEntity hasResource load merge prepareRun removeEntity removeGroup removeResource save

    Properties

    config: IPreptimeWorldConfig

    Configuration of how a runtime should work

    data: IPreptimeData

    Initial data to operate on

    name?: string

    World's name

    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 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>

    • Check if a resource was stored

      Type Parameters

      • T extends object

      Parameters

      • type: T | TTypeProto<T>

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods