@v12-engine/engine 0.1.0 → 0.4.0

package/dist/attributes.d.ts

@@ -1,66 +0,0 @@
-import type { StatChange } from './defs';
-import type { Entity } from './entity';
-import type { GamePack } from './packs/pack';
-import type { World } from './world';
-/**
- * The attributes pack's id
- *
- * @beta
- */
-export declare const ATTRIBUTES = "core.attributes";
-/**
- * One of the three attributes, each a stat of its own id
- *
- * @beta
- */
-export type Attribute = 'strength' | 'agility' | 'intelligence';
-/**
- * The three attributes, in the order a hero's panel shows them
- *
- * @beta
- */
-export declare const ATTRIBUTE_KEYS: readonly Attribute[];
-/**
- * What a point of each attribute gives, as classic RTS games have it: strength 25 health and 0.05 health a second, agility 0.3
- * armor and 2% attack speed, intelligence 15 mana and 0.05 mana a second
- *
- * @beta
- */
-export declare const CLASSIC_ATTRIBUTES: Readonly<Record<Attribute, StatChange>>;
-/**
- * What the attributes pack is made with (`withAttributes`)
- *
- * @beta
- */
-export interface AttributesOptions {
-    /** What a point of each attribute gives: the classic ones (`CLASSIC_ATTRIBUTES`) for those left out */
-    perPoint?: Partial<Record<Attribute, StatChange>>;
-    /** What a point of a unit's primary attribute gives besides: 1 attack damage when left out */
-    primary?: StatChange;
-    /** A unit's primary attribute, in code: its type's `hero.primary` when left out, none for a unit that has none */
-    primaryOf?: (world: World, entity: Entity) => Attribute | undefined;
-}
-/**
- * What a unit has of each attribute, everything counted (its type, its level, items, buffs, research): its stats'
- * `strength`, `agility` and `intelligence`
- *
- * @beta
- */
-export declare function attributesOf(world: World, entity: Entity): Record<Attribute, number>;
-/**
- * A unit's primary attribute, as the attributes pack of its game says it (`AttributesOptions.primaryOf`, else its type's
- * `hero.primary`); none in a game without the pack
- *
- * @beta
- */
-export declare function primaryAttribute(world: World, entity: Entity): Attribute | undefined;
-/**
- * Hero attributes, as in classic RTS games: strength, agility and intelligence are stats (`ATTRIBUTE_KEYS`), and every point
- * of them adds to the others (`AttributesOptions.perPoint`, `CLASSIC_ATTRIBUTES` when left out), the primary one's
- * to the attack too (`hero.primary`, `primaryOf`). What a unit has of them is what it has of any stat: its type's
- * `stats`, its hero's `growth` by level, items' `bonus`, buffs, research and the `stats` hook, all of it added up
- * before the points are turned into the rest. A game without it has no attributes
- *
- * @beta
- */
-export declare function withAttributes(options?: AttributesOptions): GamePack;