@amxts/core 0.1.0 → 0.2.1

package/scripts/docs/game.ts

@@ -21,9 +21,9 @@ export interface GameDoc {
 
 const player: Text = { en: `The player the event is about.`, ru: `Игрок, о котором событие.` };
 // Vector arguments are read only: reapi takes a vector back only as itself.
-const grenadeStart: Text = { en: `The point the grenade is thrown from, a Vector. Read only.`, ru: `Точка, откуда летит граната, Vector. Только чтение.` };
+const grenadeStart: Text = { en: `The point the grenade is thrown from, a Vector.`, ru: `Точка, откуда летит граната, Vector.` };
 const thrower: Text = { en: `The player who threw the grenade.`, ru: `Игрок, который бросил гранату.` };
-const grenadeVelocity: Text = { en: `The grenade's velocity, a Vector. Read only.`, ru: `Скорость гранаты, Vector. Только чтение.` };
+const grenadeVelocity: Text = { en: `The grenade's velocity, a Vector.`, ru: `Скорость гранаты, Vector.` };
 
 // The entity a Ham Sandwich event of one class is about.
 const theWeapon: Text = { en: `The weapon the event is about - one of the class \`classname\` names.`, ru: `Оружие, о котором событие, — одного класса, названного в \`classname\`.` };
@@ -46,10 +46,10 @@ export const GAME: Record<string, GameDoc> = {
 			inflictor: { en: `The source of the damage: a weapon, a grenade, the world.`, ru: `Источник урона: оружие, граната, мир.` },
 			attacker: { en: `The player who does the damage.`, ru: `Игрок, который наносит урон.` },
 			damage: { en: `The damage, before armour. Assign to change it.`, ru: `Урон до брони. Присвойте, чтобы изменить.` },
-			damageType: { en: `The kinds of damage, e.g. \`"Fall"\`, \`"Bullet"\`, \`"Burn"\`.`, ru: `Виды урона, например \`"Fall"\`, \`"Bullet"\`, \`"Burn"\`.` },
+			damageType: { en: `The kinds of damage, e.g. \`"fall"\`, \`"bullet"\`, \`"burn"\`.`, ru: `Виды урона, например \`"fall"\`, \`"bullet"\`, \`"burn"\`.` },
 		},
 	},
-	flPlayerFallDamage: {
+	fallDamage: {
 		summary: {
 			en: `The game works out how much a fall hurts. In a post listener \`event.result\` is that number; return a number to replace it.`,
 			ru: `Игра считает урон от падения. В post-обработчике \`event.result\` — это число; верните своё, чтобы заменить его.`,
@@ -84,7 +84,7 @@ export const GAME: Record<string, GameDoc> = {
 			ru: `Выстрел или нож попал в игрока, ещё до урона. \`preventDefault()\` — и попадания не было.`,
 		},
 		fields: {
-			dir: { en: `The shot's direction, a Vector. Read only.`, ru: `Направление выстрела, Vector. Только чтение.` },
+			direction: { en: `The shot's direction, a Vector.`, ru: `Направление выстрела, Vector.` },
 		},
 	},
 	throwSmokeGrenade: {
@@ -153,7 +153,7 @@ export const GAME: Record<string, GameDoc> = {
 			delay: { en: `The seconds until the next round.`, ru: `Секунды до следующего раунда.` },
 		},
 	},
-	restartRound: {
+	newRound: {
 		summary: { en: `A new round is starting.`, ru: `Начинается новый раунд.` },
 	},
 	checkWinConditions: {
@@ -162,9 +162,21 @@ export const GAME: Record<string, GameDoc> = {
 			ru: `Игра проверяет, не победила ли какая-то сторона. \`preventDefault()\` не даст ей закончить раунд.`,
 		},
 	},
-	onRoundFreezeEnd: {
+	roundStart: {
 		summary: { en: `The freeze time at the start of the round is over.`, ru: `Закончилось время заморозки в начале раунда.` },
 	},
+	shoot: {
+		summary: {
+			en: `A gun fires a shot: the game traces the bullet, through walls as its penetration allows, and deals its damage.`,
+			ru: `Оружие стреляет: игра ведёт пулю, сквозь стены, насколько позволяет пробивание, и наносит её урон.`,
+		},
+	},
+	shootBuckshot: {
+		summary: {
+			en: `A shotgun fires: the game traces each pellet and deals its damage.`,
+			ru: `Дробовик стреляет: игра ведёт каждую дробину и наносит её урон.`,
+		},
+	},
 	radio: {
 		summary: {
 			en: `A radio message is sent. \`preventDefault()\` silences it.`,
@@ -191,14 +203,14 @@ export const GAME: Record<string, GameDoc> = {
 		},
 		fields: {
 			player: { en: `The player who is blinded.`, ru: `Игрок, которого ослепляет.` },
-			color: { en: `The flash's colour, [r, g, b] as a Vector. Read only.`, ru: `Цвет вспышки, [r, g, b] как Vector. Только чтение.` },
+			color: { en: `The flash's colour, [r, g, b] as a Vector.`, ru: `Цвет вспышки, [r, g, b] как Vector.` },
 		},
 	},
 	startDeathCam: {
 		summary: { en: `A dead player's camera starts.`, ru: `Включается камера погибшего игрока.` },
 		fields: { player },
 	},
-	impulseCommands: {
+	impulse: {
 		summary: { en: `A player sends an impulse: \`100\` is the flashlight, \`201\` the spray.`, ru: `Игрок отправляет impulse: \`100\` — фонарик, \`201\` — спрей.` },
 		fields: { player },
 	},
@@ -236,14 +248,14 @@ export const GAME: Record<string, GameDoc> = {
 			},
 		},
 	},
-	buyWeaponByWeaponId: {
+	buyWeapon: {
 		summary: {
 			en: `A player buys a weapon. In a post listener \`event.result\` is the weapon.`,
 			ru: `Игрок покупает оружие. В post-обработчике \`event.result\` — само оружие.`,
 		},
 		fields: { player, weapon: { en: `The weapon bought, as \`weapon.kind\` names it, e.g. \`"ak47"\` or \`"awp"\`.`, ru: `Покупаемое оружие, как его называет \`weapon.kind\`, например \`"ak47"\` или \`"awp"\`.` } },
 	},
-	addAccount: {
+	addMoney: {
 		summary: {
 			en: `A player's money changes. Assign \`event.amount\` to change how much.`,
 			ru: `У игрока меняются деньги. Присвойте \`event.amount\`, чтобы изменить сумму.`,
@@ -256,19 +268,53 @@ export const GAME: Record<string, GameDoc> = {
 			},
 		},
 	},
-	hasRestrictItem: {
+	itemRestricted: {
 		summary: {
 			en: `The game asks if an item is forbidden to a player. Return \`true\` to forbid it.`,
 			ru: `Игра спрашивает, запрещён ли игроку предмет. Верните \`true\`, чтобы запретить.`,
 		},
 		fields: {
 			player,
+			item: {
+				en: `The item asked about, by its kind, e.g. \`"awp"\`, \`"hegrenade"\`, \`"kevlar"\`, \`"defusekit"\`.`,
+				ru: `Предмет, о котором спрашивают, по его виду, например \`"awp"\`, \`"hegrenade"\`, \`"kevlar"\`, \`"defusekit"\`.`,
+			},
 			restriction: {
 				en: `The way the player would get the item, one of \`"buying"\`, \`"touched"\` (picked up) or \`"equipped"\` (given on spawn).`,
 				ru: `Способ, которым игрок получит предмет, — одно из \`"buying"\` (покупка), \`"touched"\` (подобрал) или \`"equipped"\` (выдан при спавне).`,
 			},
 		},
 	},
+	pain: {
+		summary: {
+			en: `A player cries out in pain after a hit.`,
+			ru: `Игрок вскрикивает от боли после попадания.`,
+		},
+		fields: {
+			player,
+			lastHitGroup: {
+				en: `The body part the hit struck, e.g. \`"head"\`, \`"chest"\`, \`"leftLeg"\`.`,
+				ru: `Часть тела, куда пришлось попадание, например \`"head"\`, \`"chest"\`, \`"leftLeg"\`.`,
+			},
+			hasArmour: {
+				en: `\`true\` when the player wears armour: the game picks the sound by it.`,
+				ru: `\`true\`, когда на игроке броня: по ней игра выбирает звук.`,
+			},
+		},
+	},
+	setAnimation: {
+		summary: {
+			en: `The game sets the animation a player's model plays: walking, jumping, attacking, reloading.`,
+			ru: `Игра задаёт анимацию, которую играет модель игрока: ходьба, прыжок, атака, перезарядка.`,
+		},
+		fields: {
+			player,
+			animation: {
+				en: `The animation, e.g. \`"jump"\`, \`"attack1"\`, \`"reload"\`.`,
+				ru: `Анимация, например \`"jump"\`, \`"attack1"\`, \`"reload"\`.`,
+			},
+		},
+	},
 	addResource: {
 		summary: {
 			en: `A file is added to what clients download.`,
@@ -282,7 +328,7 @@ export const GAME: Record<string, GameDoc> = {
 			resourceIndex: { en: `The resource's number in the list.`, ru: `Номер ресурса в списке.` },
 		},
 	},
-	onEvent: {
+	gameEvent: {
 		summary: {
 			en: `The game tells the bots something happened.`,
 			ru: `Игра сообщает ботам, что что-то произошло.`,
@@ -301,8 +347,8 @@ export const GAME: Record<string, GameDoc> = {
 		},
 		fields: {
 			flags: {
-				en: `The extras the death message carries, any of \`"Position"\`, \`"Assistant"\`, \`"KillRarity"\`.`,
-				ru: `Дополнения к сообщению о смерти, любые из \`"Position"\`, \`"Assistant"\`, \`"KillRarity"\`.`,
+				en: `The extras the death message carries, any of \`"position"\`, \`"assistant"\`, \`"killRarity"\`.`,
+				ru: `Дополнения к сообщению о смерти, любые из \`"position"\`, \`"assistant"\`, \`"killRarity"\`.`,
 			},
 			rarity: {
 				en: `The things that made the kill rare, e.g. \`"Headshot"\`, \`"NoScope"\`, \`"Penetrated"\`, \`"InAir"\`.`,
@@ -314,7 +360,7 @@ export const GAME: Record<string, GameDoc> = {
 		summary: { en: `A player throws a grenade.`, ru: `Игрок бросает гранату.` },
 		fields: { player: thrower, velocity: grenadeVelocity },
 	},
-	hintMessageEx: {
+	hintMessage: {
 		summary: { en: `The game shows a player a hint.`, ru: `Игра показывает игроку подсказку.` },
 		fields: {
 			player,
@@ -324,15 +370,15 @@ export const GAME: Record<string, GameDoc> = {
 			},
 		},
 	},
-	sendSayMessage: {
+	chatMessage: {
 		summary: {
 			en: `A player's chat message goes out to the players and to the server console. Assign \`event.text\` to change what they read, or call \`preventDefault()\` so nobody gets it.`,
 			ru: `Сообщение игрока в чат уходит игрокам и в консоль сервера. Чтобы изменить, что они прочтут, присвойте \`event.text\`; чтобы его не получил никто, вызовите \`preventDefault()\`.`,
 		},
 		fields: {
 			player: { en: `The player who wrote the message.`, ru: `Игрок, который написал сообщение.` },
-			cmd: { en: `The command the message came with, \`"say"\` or \`"say_team"\`.`, ru: `Команда, с которой пришло сообщение, \`"say"\` или \`"say_team"\`.` },
-			teamonly: { en: `\`true\` when only the player's team gets the message.`, ru: `\`true\`, когда сообщение получает только команда игрока.` },
+			command: { en: `The command the message came with, \`"say"\` or \`"say_team"\`.`, ru: `Команда, с которой пришло сообщение, \`"say"\` или \`"say_team"\`.` },
+			teamOnly: { en: `\`true\` when only the player's team gets the message.`, ru: `\`true\`, когда сообщение получает только команда игрока.` },
 			text: { en: `The message as the player wrote it. Assign to change it.`, ru: `Сообщение, как его написал игрок. Присвойте, чтобы изменить.` },
 			format: {
 				en: `The chat's format that puts the name, the place and the message together, e.g. \`"#Cstrike_Chat_All"\`.`,
@@ -346,14 +392,14 @@ export const GAME: Record<string, GameDoc> = {
 	},
 	takeDamageImpulse: {
 		summary: {
-			en: `A hurt player is pushed back and slowed down by the hit, after the damage. Assign \`event.knockbackForce\` or \`event.velModifier\` to change how much, or call \`preventDefault()\` for neither.`,
-			ru: `Раненого игрока отбрасывает и замедляет от удара, уже после урона. Чтобы изменить насколько, присвойте \`event.knockbackForce\` или \`event.velModifier\`; чтобы не было ни того ни другого, вызовите \`preventDefault()\`.`,
+			en: `A hurt player is pushed back and slowed down by the hit, after the damage. Assign \`event.knockbackForce\` or \`event.velocityModifier\` to change how much, or call \`preventDefault()\` for neither.`,
+			ru: `Раненого игрока отбрасывает и замедляет от удара, уже после урона. Чтобы изменить насколько, присвойте \`event.knockbackForce\` или \`event.velocityModifier\`; чтобы не было ни того ни другого, вызовите \`preventDefault()\`.`,
 		},
 		fields: {
 			player: { en: `The player who is hurt.`, ru: `Игрок, которого ранили.` },
 			attacker: { en: `The player who did the damage.`, ru: `Игрок, который нанёс урон.` },
 			knockbackForce: { en: `The force that pushes the player away from the attacker. Assign to change it.`, ru: `Сила, которая отталкивает игрока от атакующего. Присвойте, чтобы изменить.` },
-			velModifier: {
+			velocityModifier: {
 				en: `The share of speed the player keeps while slowed by the hit, e.g. \`0.5\` for half. Assign to change it.`,
 				ru: `Доля скорости, которая остаётся у игрока, пока его замедляет удар, например \`0.5\` — половина. Присвойте, чтобы изменить.`,
 			},