mirror of
https://github.com/Ukendio/jecs.git
synced 2025-04-25 01:20:04 +00:00
Fix ts types
This commit is contained in:
Ukendio
parent
35387c06e0
commit
337f388093
1 changed files with 127 additions and 126 deletions
253
src/index.d.ts
vendored
253
src/index.d.ts
vendored
|
|
@ -1,155 +1,156 @@
|
||||||
type Query<T extends unknown[]> = {
|
type Query<T extends unknown[]> = {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* this: Query<T> is necessary to use a colon instead of a period for emits.
|
* this: Query<T> is necessary to use a colon instead of a period for emits.
|
||||||
*/
|
*/
|
||||||
|
drain: (this: Query<T>) => Query<T>
|
||||||
/**
|
with: (this: Query<T>, ...components: Entity[]) => Query<T>
|
||||||
* Modifies the Query to exclude specified components
|
/**
|
||||||
* @param components The components to exclude
|
* Modifies the Query to exclude specified components
|
||||||
* @returns Modified Query
|
* @param components The components to exclude
|
||||||
*/
|
* @returns Modified Query
|
||||||
without: (this: Query<T>, ...components: Entity[]) => Query<T>;
|
*/
|
||||||
/**
|
without: (this: Query<T>, ...components: Entity[]) => Query<T>;
|
||||||
* Modifies component data with a callback function
|
/**
|
||||||
* @param fn The function to modify data
|
* Modifies component data with a callback function
|
||||||
*/
|
* @param fn The function to modify data
|
||||||
replace: (this: Query<T>, fn: (...components: T) => T extends [infer U] ? U : LuaTuple<T>) => void;
|
*/
|
||||||
|
replace: (this: Query<T>, fn: (...components: T) => T extends [infer U] ? U : LuaTuple<T>) => void;
|
||||||
} & IterableFunction<LuaTuple<[Entity, ...T]>>;
|
} & IterableFunction<LuaTuple<[Entity, ...T]>>;
|
||||||
|
|
||||||
// Utility Types
|
// Utility Types
|
||||||
export type Entity<T = unknown> = number & { __nominal_type_dont_use: T };
|
export type Entity<T = unknown> = number & { __nominal_type_dont_use: T };
|
||||||
export type EntityType<T> = T extends Entity<infer A> ? A : never;
|
export type EntityType<T> = T extends Entity<infer A> ? A : never;
|
||||||
export type InferComponents<A extends Entity[]> = {
|
export type InferComponents<A extends Entity[]> = {
|
||||||
[K in keyof A]: EntityType<A[K]>;
|
[K in keyof A]: EntityType<A[K]>;
|
||||||
};
|
};
|
||||||
type Nullable<T extends unknown[]> = {
|
type Nullable<T extends unknown[]> = {
|
||||||
[K in keyof T]: T[K] | undefined;
|
[K in keyof T]: T[K] | undefined;
|
||||||
};
|
};
|
||||||
|
|
||||||
export class World {
|
export class World {
|
||||||
/**
|
/**
|
||||||
* Creates a new World
|
* Creates a new World
|
||||||
*/
|
*/
|
||||||
constructor();
|
constructor();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a new entity
|
* Creates a new entity
|
||||||
* @returns Entity
|
* @returns Entity
|
||||||
*/
|
*/
|
||||||
entity(): Entity;
|
entity(): Entity;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a new entity located in the first 256 ids.
|
* Creates a new entity located in the first 256 ids.
|
||||||
* These should be used for static components for fast access.
|
* These should be used for static components for fast access.
|
||||||
* @returns Entity<T>
|
* @returns Entity<T>
|
||||||
*/
|
*/
|
||||||
component<T = unknown>(): Entity<T>;
|
component<T = unknown>(): Entity<T>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the target of a relationship. For example, when a user calls
|
* Gets the target of a relationship. For example, when a user calls
|
||||||
* `world.target(id, ChildOf(parent))`, you will obtain the parent entity.
|
* `world.target(id, ChildOf(parent))`, you will obtain the parent entity.
|
||||||
* @param id Entity
|
* @param id Entity
|
||||||
* @param relation The Relationship
|
* @param relation The Relationship
|
||||||
* @returns The Parent Entity if it exists
|
* @returns The Parent Entity if it exists
|
||||||
*/
|
*/
|
||||||
target(id: Entity, relation: Entity): Entity | undefined;
|
target(id: Entity, relation: Entity): Entity | undefined;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Clears an entity from the world.
|
* Clears an entity from the world.
|
||||||
* @praram id Entity to be cleared
|
* @praram id Entity to be cleared
|
||||||
*/
|
*/
|
||||||
clear(id: Entity): void;
|
clear(id: Entity): void;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Deletes an entity and all its related components and relationships.
|
* Deletes an entity and all its related components and relationships.
|
||||||
* @param id Entity to be destroyed
|
* @param id Entity to be destroyed
|
||||||
*/
|
*/
|
||||||
delete(id: Entity): void;
|
delete(id: Entity): void;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds a component to the entity with no value
|
* Adds a component to the entity with no value
|
||||||
* @param id Target Entity
|
* @param id Target Entity
|
||||||
* @param component Component
|
* @param component Component
|
||||||
*/
|
*/
|
||||||
add<T>(id: Entity, component: Entity<T>): void;
|
add<T>(id: Entity, component: Entity<T>): void;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Assigns a value to a component on the given entity
|
* Assigns a value to a component on the given entity
|
||||||
* @param id Target Entity
|
* @param id Target Entity
|
||||||
* @param component Target Component
|
* @param component Target Component
|
||||||
* @param data Component Data
|
* @param data Component Data
|
||||||
*/
|
*/
|
||||||
set<T>(id: Entity, component: Entity<T>, data: T): void;
|
set<T>(id: Entity, component: Entity<T>, data: T): void;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes a component from the given entity
|
* Removes a component from the given entity
|
||||||
* @param id Target Entity
|
* @param id Target Entity
|
||||||
* @param component Target Component
|
* @param component Target Component
|
||||||
*/
|
*/
|
||||||
remove(id: Entity, component: Entity): void;
|
remove(id: Entity, component: Entity): void;
|
||||||
|
|
||||||
// Manually typed out get since there is a hard limit.
|
// Manually typed out get since there is a hard limit.
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves the value of one component. This value may be undefined.
|
* Retrieves the value of one component. This value may be undefined.
|
||||||
* @param id Target Entity
|
* @param id Target Entity
|
||||||
* @param component Target Component
|
* @param component Target Component
|
||||||
* @returns Data associated with the component if it exists
|
* @returns Data associated with the component if it exists
|
||||||
*/
|
*/
|
||||||
get<A>(id: number, component: Entity<A>): A | undefined;
|
get<A>(id: number, component: Entity<A>): A | undefined;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves the value of two components. This value may be undefined.
|
* Retrieves the value of two components. This value may be undefined.
|
||||||
* @param id Target Entity
|
* @param id Target Entity
|
||||||
* @param component Target Component 1
|
* @param component Target Component 1
|
||||||
* @param component2 Target Component 2
|
* @param component2 Target Component 2
|
||||||
* @returns Data associated with the components if it exists
|
* @returns Data associated with the components if it exists
|
||||||
*/
|
*/
|
||||||
get<A, B>(
|
get<A, B>(
|
||||||
id: number,
|
id: number,
|
||||||
component: Entity<A>,
|
component: Entity<A>,
|
||||||
component2: Entity<B>
|
component2: Entity<B>
|
||||||
): LuaTuple<Nullable<[A, B]>>;
|
): LuaTuple<Nullable<[A, B]>>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves the value of three components. This value may be undefined.
|
* Retrieves the value of three components. This value may be undefined.
|
||||||
* @param id Target Entity
|
* @param id Target Entity
|
||||||
* @param component Target Component 1
|
* @param component Target Component 1
|
||||||
* @param component2 Target Component 2
|
* @param component2 Target Component 2
|
||||||
* @param component3 Target Component 3
|
* @param component3 Target Component 3
|
||||||
* @returns Data associated with the components if it exists
|
* @returns Data associated with the components if it exists
|
||||||
*/
|
*/
|
||||||
get<A, B, C>(
|
get<A, B, C>(
|
||||||
id: number,
|
id: number,
|
||||||
component: Entity<A>,
|
component: Entity<A>,
|
||||||
component2: Entity<B>,
|
component2: Entity<B>,
|
||||||
component3: Entity<C>
|
component3: Entity<C>
|
||||||
): LuaTuple<Nullable<[A, B, C]>>;
|
): LuaTuple<Nullable<[A, B, C]>>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves the value of four components. This value may be undefined.
|
* Retrieves the value of four components. This value may be undefined.
|
||||||
* @param id Target Entity
|
* @param id Target Entity
|
||||||
* @param component Target Component 1
|
* @param component Target Component 1
|
||||||
* @param component2 Target Component 2
|
* @param component2 Target Component 2
|
||||||
* @param component3 Target Component 3
|
* @param component3 Target Component 3
|
||||||
* @param component4 Target Component 4
|
* @param component4 Target Component 4
|
||||||
* @returns Data associated with the components if it exists
|
* @returns Data associated with the components if it exists
|
||||||
*/
|
*/
|
||||||
get<A, B, C, D>(
|
get<A, B, C, D>(
|
||||||
id: number,
|
id: number,
|
||||||
component: Entity<A>,
|
component: Entity<A>,
|
||||||
component2: Entity<B>,
|
component2: Entity<B>,
|
||||||
component3: Entity<C>,
|
component3: Entity<C>,
|
||||||
component4: Entity<D>
|
component4: Entity<D>
|
||||||
): LuaTuple<Nullable<[A, B, C, D]>>;
|
): LuaTuple<Nullable<[A, B, C, D]>>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Searches the world for entities that match a given query
|
* Searches the world for entities that match a given query
|
||||||
* @param components Queried Components
|
* @param components Queried Components
|
||||||
* @returns Query
|
* @returns Query
|
||||||
*/
|
*/
|
||||||
query<T extends Entity[]>(...components: T): Query<InferComponents<T>>;
|
query<T extends Entity[]>(...components: T): Query<InferComponents<T>>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -176,4 +177,4 @@ export const OnAdd: Entity;
|
||||||
export const OnRemove: Entity;
|
export const OnRemove: Entity;
|
||||||
export const OnSet: Entity;
|
export const OnSet: Entity;
|
||||||
export const Wildcard: Entity;
|
export const Wildcard: Entity;
|
||||||
export const Rest: Entity;
|
export const Rest: Entity;
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue