@v12-engine/engine 0.1.0 → 0.4.0

package/dist/abilities/effectFields.js

@@ -0,0 +1,676 @@
+//#region src/abilities/effectFields.ts
+/** The fields every effect may have, whatever its type (`EffectCommon`): offered on every row of effects */
+var COMMON_EFFECT_FIELDS = {
+	radius: {
+		path: "radius",
+		kind: "number",
+		min: 0,
+		hint: "Hits everything this far around where it lands, not only the target"
+	},
+	shape: {
+		path: "shape",
+		options: [
+			"circle",
+			"cone",
+			"line",
+			"rect",
+			"ring",
+			"arc",
+			"cross"
+		],
+		hint: "The ground it covers, turned the way it was aimed: a cone, a line and an arc go off from the caster, the rest lie around where it landed"
+	},
+	length: {
+		path: "length",
+		kind: "number",
+		min: 0,
+		hint: "Of a cone, a line, a rect and a cross: how long it is, end to end"
+	},
+	width: {
+		path: "width",
+		kind: "number",
+		min: 0,
+		hint: "Of a line, a rect and a cross: how far it covers on either side; of a ring and an arc, how thick it is (1 when left out)"
+	},
+	angle: {
+		path: "angle",
+		kind: "number",
+		min: 0,
+		max: 6.2832,
+		hint: "Of a cone and an arc: how wide it opens, in radians"
+	},
+	affects: {
+		path: "affects",
+		options: [
+			"enemies",
+			"allies",
+			"all"
+		],
+		hint: "Who an effect with a radius applies to: as its type has it when left out"
+	},
+	on: {
+		path: "on",
+		options: ["caster"],
+		hint: "Applies to the caster, wherever the ability was aimed"
+	},
+	ifBuff: {
+		path: "ifBuff",
+		kind: "id",
+		of: "buffs",
+		hint: "Only hits what carries this buff"
+	},
+	tags: {
+		path: "tags",
+		kind: "list",
+		hint: "Only hits what has one of these tags of its type (undead, mechanical): everything when left out"
+	},
+	chance: {
+		path: "chance",
+		kind: "number",
+		min: 0,
+		max: 1,
+		hint: "It happens by chance: this share of the times (0.25: one in four). A trigger goes off by it; an if asks it with its conditions"
+	},
+	look: {
+		path: "look",
+		kind: "text",
+		hint: "Which of its ability's looks draws it (the view's AbilityLook.effects): by this name; by its place in the ability or its type when left out"
+	},
+	only: {
+		path: "only",
+		options: ["heroes"],
+		hint: "Only hits heroes"
+	},
+	kinds: {
+		path: "kinds",
+		kind: "list",
+		hint: "Only hits these kinds of things (unit, building, …): everything but resources when left out"
+	},
+	layers: {
+		path: "layers",
+		kind: "list",
+		hint: "Only hits what is there (ground, air): both when left out"
+	},
+	origin: [
+		{
+			path: "origin.proxy",
+			kind: "id",
+			of: "units",
+			hint: "Goes off from the caster's units of this type (a shadow, a ball, a soldier), not from the caster"
+		},
+		{
+			path: "origin.pick",
+			options: [
+				"nearest",
+				"all",
+				"newest",
+				"oldest"
+			],
+			hint: "Which of them: the one nearest to where it was aimed when left out"
+		},
+		{
+			path: "origin.caster",
+			kind: "either",
+			options: ["otherwise"],
+			hint: "From the caster as well (true), or from the caster where none is picked (otherwise)"
+		},
+		{
+			path: "origin.range",
+			kind: "number",
+			min: 0,
+			hint: "Only those within this far of the caster"
+		},
+		{
+			path: "origin.near",
+			kind: "number",
+			min: 0,
+			hint: "Only those within this far of where it was aimed"
+		},
+		{
+			path: "origin.at",
+			options: ["aim", "proxy"],
+			hint: "Lands where it was aimed (when left out), or where each it goes off from stands"
+		},
+		{
+			path: "origin.target",
+			kind: "boolean",
+			hint: "The one it goes off from is its target too: a swap with it, a dash to it"
+		}
+	],
+	where: conditionFields("where", "what it hits"),
+	sort: {
+		path: "sort",
+		options: [
+			"nearest",
+			"farthest",
+			"lowestHealth",
+			"highestHealth",
+			"lowestHealthShare",
+			"highestHealthShare",
+			"random"
+		],
+		hint: "Of what its area reaches, which first: the nearest to where it landed when left out, the most hurt (lowestHealthShare), at random…"
+	},
+	limit: {
+		path: "limit",
+		kind: "number",
+		min: 0,
+		hint: "Of what its area reaches, only this many, the first by sort"
+	},
+	when: {
+		path: "when",
+		options: [
+			"hit",
+			"arrived",
+			"landed",
+			"end"
+		],
+		hint: "Not now, but at the moment of the nearest row above that comes to it: a missile's hit or end, a pull's arrival, a dash's landing, a zone's end"
+	}
+};
+/** The fields of what an `if` asks of a unit (`UnitCondition`), at `path`: the caster or the target; or an effect's `where` */
+function conditionFields(path, who) {
+	return [
+		{
+			path: `${path}.buff`,
+			kind: "id",
+			of: "buffs",
+			hint: `Only if ${who} carries this buff`
+		},
+		{
+			path: `${path}.noBuff`,
+			kind: "id",
+			of: "buffs",
+			hint: `Only if ${who} does not carry this buff`
+		},
+		{
+			path: `${path}.healthBelow`,
+			kind: "number",
+			min: 0,
+			max: 1,
+			hint: `Only if ${who} has less than this share of its health (0.2: an execute)`
+		},
+		{
+			path: `${path}.healthAbove`,
+			kind: "number",
+			min: 0,
+			max: 1,
+			hint: `Only if ${who} has at least this share of its health`
+		},
+		{
+			path: `${path}.hero`,
+			kind: "boolean",
+			hint: `Only if ${who} is a hero (on) or is not (off)`
+		},
+		{
+			path: `${path}.structure`,
+			kind: "boolean",
+			hint: `Only if ${who} is a structure (on) or is not (off): with hero off, a creep`
+		},
+		{
+			path: `${path}.tags`,
+			kind: "list",
+			hint: `Only if ${who} has one of these tags of its type`
+		},
+		{
+			path: `${path}.notTags`,
+			kind: "list",
+			hint: `Only if ${who} has none of these tags of its type (undead: the living)`
+		},
+		{
+			path: `${path}.is`,
+			options: ["enemy", "ally"],
+			hint: `Only if ${who} is an enemy or an ally of the caster`
+		}
+	];
+}
+/**
+* The engine's fields of an effect by name (`EffectFields`), as the Data panel shows them; `effects`, `onEnd` and
+* `otherwise` are lists of effects. Those of a few values (a missile's `arc`) are a field for each, null for one that
+* is no single value
+*/
+var EFFECT_FIELDS = {
+	to: {
+		path: "to",
+		options: [
+			"home",
+			"point",
+			"target"
+		],
+		hint: "Where to: the side's home, where it was aimed, or by its target"
+	},
+	through: null,
+	collide: null,
+	stops: null,
+	direction: null,
+	rider: null,
+	line: null,
+	ring: null,
+	pool: null,
+	from: null,
+	uses: null,
+	atLevel: null,
+	pick: null,
+	caster: conditionFields("caster", "the caster"),
+	target: conditionFields("target", "the target (each within its radius, where it has one)"),
+	amount: {
+		path: "amount",
+		kind: "number",
+		hint: "How much: of damage, of health, of mana"
+	},
+	buff: {
+		path: "buff",
+		kind: "id",
+		of: "buffs",
+		hint: "The buff put on"
+	},
+	owner: {
+		path: "owner",
+		options: ["neutral"],
+		hint: "Whose it is: the caster's when left out, or the neutral player's"
+	},
+	looksLike: {
+		path: "looksLike",
+		options: ["target", "caster"],
+		hint: "Drawn as the target or the caster is: its model, its owner's colour, its size"
+	},
+	data: null,
+	unit: {
+		path: "unit",
+		kind: "id",
+		of: "units",
+		hint: "The unit type it brings into the world"
+	},
+	whileBuff: {
+		path: "whileBuff",
+		kind: "id",
+		of: "buffs",
+		hint: "Only while the carrier carries this buff"
+	},
+	every: {
+		path: "every",
+		kind: "integer",
+		min: 1,
+		hint: "Only every so many attacks that land: 4 for the fourth shot"
+	},
+	consumes: {
+		path: "consumes",
+		kind: "boolean",
+		hint: "The attack uses up a stack of the buff it needs (whileBuff): the next attack"
+	},
+	slot: {
+		path: "slot",
+		kind: "text",
+		hint: "The slot it takes among what attacks set off (orb, poison): of one slot only the highest priority goes off"
+	},
+	priority: {
+		path: "priority",
+		kind: "number",
+		hint: "Of those sharing its slot, the highest goes off (0 when left out)"
+	},
+	cooldown: {
+		path: "cooldown",
+		kind: "number",
+		min: 0,
+		hint: "Seconds before it can go off again once it did"
+	},
+	as: {
+		path: "as",
+		options: ["themselves"],
+		hint: "The corpses rise as what they were, rather than as its unit"
+	},
+	health: {
+		path: "health",
+		kind: "number",
+		min: 0,
+		max: 1,
+		hint: "The share of its max health it is left with rather than dying: all of it when left out"
+	},
+	below: {
+		path: "below",
+		kind: "number",
+		min: 0,
+		max: 1,
+		hint: "The part of max health the carrier falls below for it to go off (0.3: 30%)"
+	},
+	melee: {
+		path: "melee",
+		kind: "boolean",
+		hint: "Only for an attack from up close (one with no missile)"
+	},
+	stacks: {
+		path: "stacks",
+		kind: "integer",
+		min: 1,
+		hint: "How many stacks come off: all of the buff when left out"
+	},
+	otherwise: {
+		path: "otherwise",
+		kind: "rows",
+		hint: "What happens otherwise: the ability went off not charged (charged), what it asks does not hold (if)"
+	},
+	blocked: {
+		path: "blocked",
+		kind: "boolean",
+		hint: "Buildings and trees in its way stop it"
+	},
+	attack: {
+		path: "attack",
+		kind: "boolean",
+		hint: "Only for attacks: one of the carrier that killed (onKill), one that hurt it (onDamaged)"
+	},
+	ability: {
+		path: "ability",
+		kind: "id",
+		of: "abilities",
+		hint: "The ability ready again: the one the effect belongs to when left out"
+	},
+	leap: {
+		path: "leap",
+		kind: "number",
+		min: 0,
+		hint: "How high it rises on the way, which makes it a leap"
+	},
+	climb: {
+		path: "climb",
+		kind: "number",
+		min: 0,
+		hint: "How much higher than where it takes off the ground on its way may stand"
+	},
+	duration: {
+		path: "duration",
+		kind: "number",
+		min: 0,
+		hint: "Seconds it lasts: its usual time when left out"
+	},
+	scaling: null,
+	damageType: {
+		path: "damageType",
+		options: [
+			"physical",
+			"magic",
+			"true"
+		],
+		hint: "Magic when left out"
+	},
+	how: {
+		path: "how",
+		kind: "text",
+		hint: "How what it kills dies, for the screen"
+	},
+	delay: {
+		path: "delay",
+		kind: "number",
+		min: 0,
+		hint: "Seconds before it goes"
+	},
+	speed: {
+		path: "speed",
+		kind: "number",
+		min: 0,
+		hint: "Units per second"
+	},
+	distance: {
+		path: "distance",
+		kind: "number",
+		min: 0,
+		hint: "How far"
+	},
+	count: {
+		path: "count",
+		kind: "integer",
+		min: 1,
+		hint: "How many"
+	},
+	spread: {
+		path: "spread",
+		kind: "number",
+		min: 0,
+		hint: "The angle the missiles are spread over, in radians"
+	},
+	homing: {
+		path: "homing",
+		kind: "boolean",
+		hint: "Flies after the unit it was cast on, and only hits that one"
+	},
+	toPoint: {
+		path: "toPoint",
+		kind: "boolean",
+		hint: "Flies to the spot it was aimed at and stops there; a pull drags to it rather than to the caster"
+	},
+	sight: {
+		path: "sight",
+		kind: "number",
+		min: 0,
+		hint: "How far the caster’s team sees around it"
+	},
+	effects: {
+		path: "effects",
+		kind: "rows",
+		hint: "What happens to what it reaches"
+	},
+	onEnd: {
+		path: "onEnd",
+		kind: "rows",
+		hint: "What happens where and when it ends"
+	},
+	impact: {
+		path: "impact",
+		kind: "text",
+		hint: "The name its arrival goes by, for whoever draws it"
+	},
+	pierce: {
+		path: "pierce",
+		kind: "either",
+		orNumber: "integer",
+		min: 0,
+		hint: "Goes on after it hit something (true), is used up by the first (false), or goes through so many (a number)"
+	},
+	falloff: {
+		path: "falloff",
+		kind: "number",
+		min: 0,
+		max: 1,
+		hint: "What part of its amounts each one it went through takes off the next (0.3: a third)"
+	},
+	returns: {
+		path: "returns",
+		kind: "boolean",
+		hint: "Flies back to the caster once done, and what happens at its end happens there"
+	},
+	hitsOnReturn: {
+		path: "hitsOnReturn",
+		kind: "boolean",
+		hint: "On its way back it hits what it passes through again"
+	},
+	seek: {
+		path: "seek",
+		kind: "number",
+		min: 0,
+		hint: "Finds its own: flies after the nearest it may hit within this far"
+	},
+	onWall: {
+		path: "onWall",
+		kind: "rows",
+		hint: "What happens where it meets a wall (a cliff, ground nothing walks, a building, a tree), to the last it hit: it stops there"
+	},
+	split: {
+		path: "split",
+		kind: "rows",
+		hint: "What goes off from where it is, the way it flew, once done: missiles fly on from there at their spread"
+	},
+	steer: {
+		path: "steer.rate",
+		kind: "number",
+		min: 0,
+		hint: "Its owner turns it as it flies: at most so many radians a second (π when left out)"
+	},
+	follow: {
+		path: "follow",
+		options: ["caster", "target"],
+		hint: "Goes with the caster or the target, the way it faces; ends when that one dies"
+	},
+	onEnter: {
+		path: "onEnter",
+		kind: "rows",
+		hint: "What happens to each who comes into it (its radius or shape), those inside as it is laid included"
+	},
+	onLeave: {
+		path: "onLeave",
+		kind: "rows",
+		hint: "What happens to each who goes out of it"
+	},
+	edge: {
+		path: "edge",
+		kind: "rows",
+		hint: "What happens to each who crosses its edge, in or out, once it is laid"
+	},
+	seconds: {
+		path: "seconds",
+		kind: "number",
+		min: 0,
+		hint: "Seconds the pull takes"
+	},
+	arc: [{
+		path: "arc.height",
+		kind: "number",
+		min: 0,
+		hint: "Thrown: how high it goes in the middle of its way. It flies over everything and hits where it comes down"
+	}, {
+		path: "arc.time",
+		kind: "number",
+		min: 0,
+		hint: "Seconds it is in the air, however far it goes: its speed when left out"
+	}],
+	bounce: [
+		{
+			path: "bounce.count",
+			kind: "integer",
+			min: 0,
+			hint: "How many times it springs on to the nearest it has not hit yet"
+		},
+		{
+			path: "bounce.range",
+			kind: "number",
+			min: 0,
+			hint: "How far away the next one it springs on to may be"
+		},
+		{
+			path: "bounce.falloff",
+			kind: "number",
+			min: 0,
+			max: 1,
+			hint: "What part of its amounts each spring takes off (0.25: a quarter)"
+		}
+	],
+	stack: {
+		path: "stack",
+		kind: "boolean",
+		hint: "Adds one to how many of the buff the target carries, up to what the buff allows"
+	},
+	sell: {
+		path: "sell",
+		kind: "text",
+		hint: "The resource traded away, by id"
+	},
+	buy: {
+		path: "buy",
+		kind: "text",
+		hint: "The resource traded for, by id"
+	},
+	rate: {
+		path: "rate",
+		kind: "number",
+		min: 0,
+		hint: "How much of what is bought comes for each one sold"
+	},
+	byMissingHealth: {
+		path: "byMissingHealth",
+		kind: "number",
+		min: 0,
+		hint: "A part of the health the target has lost, added to the amount"
+	},
+	byMaxHealth: {
+		path: "byMaxHealth",
+		kind: "number",
+		min: 0,
+		hint: "A part of the target's max health, added to the amount (0.08: 8%)"
+	},
+	byCurrentHealth: {
+		path: "byCurrentHealth",
+		kind: "number",
+		min: 0,
+		hint: "A part of the health the target has now, added to the amount"
+	},
+	byStacks: [
+		{
+			path: "byStacks.buff",
+			kind: "id",
+			of: "buffs",
+			hint: "The buff whose stacks add to the amount"
+		},
+		{
+			path: "byStacks.of",
+			options: ["target", "caster"],
+			hint: "Whose stacks: the target’s when left out"
+		},
+		{
+			path: "byStacks.amount",
+			kind: "number",
+			hint: "How much each stack adds"
+		}
+	],
+	byDistance: [{
+		path: "byDistance.per",
+		kind: "number",
+		hint: "How much more for every unit of distance it came (0.1: a tenth more)"
+	}, {
+		path: "byDistance.most",
+		kind: "number",
+		min: 1,
+		hint: "Times as much at the most"
+	}],
+	targetScaling: [
+		{
+			path: "targetScaling.health",
+			kind: "number",
+			hint: "A part of the target's max health, added to the amount"
+		},
+		{
+			path: "targetScaling.armor",
+			kind: "number",
+			hint: "A part of the target's armor, added to the amount"
+		},
+		{
+			path: "targetScaling.magicResist",
+			kind: "number",
+			hint: "A part of the target's magic resist, added to the amount"
+		}
+	],
+	byDamage: {
+		path: "byDamage",
+		kind: "number",
+		min: 0,
+		hint: "A part of the damage that set the trigger off, added to the amount"
+	},
+	into: {
+		path: "into",
+		kind: "id",
+		of: "units",
+		hint: "The unit type the caster turns into: a form of the hero"
+	},
+	toggle: {
+		path: "toggle",
+		kind: "boolean",
+		hint: "Lasts until the ability is cast again in the form, which turns it back"
+	},
+	back: {
+		path: "back",
+		kind: "list",
+		hint: "What turns it back (ability, time, death): the time and death when left out, and the ability with a toggle"
+	}
+};
+//#endregion
+export { COMMON_EFFECT_FIELDS, EFFECT_FIELDS };
+
+//# sourceMappingURL=effectFields.js.map