@amxts/menu-core 0.2.1 → 0.3.0

package/src/menu-file.ts

@@ -597,7 +597,7 @@ function iniMenu(section: ConfigNode) {
 	const content = section.has("ITEMS") || section.has("VIEW") || section.has("FIXED_ITEMS");
 
 	if (title.length == 0) {
-		if (content) warn(whereOf(section), `[${name}] has no TITLE, so it is not a menu`);
+		warn(whereOf(section), content ? `[${name}] has no TITLE, so it is not a menu` : `[${name}] is not a menu: it has no TITLE, ITEMS or VIEW`);
 		return null;
 	}
 
@@ -633,12 +633,20 @@ function iniMenu(section: ConfigNode) {
 	return withItems(menu, whereOf(section));
 }
 
-/** An INI menu file: [MAIN] with the words, a [section] a menu. */
+// The Pawn menu_core reads its words from [Основное]: a file written for it is read as it is.
+const INI_MAIN_SECTIONS = ["MAIN", "Основное"];
+
+/** Whether a section of an INI menu file is the one with the words. */
+function isMainSection(section: ConfigNode) {
+	return INI_MAIN_SECTIONS.includes(section.key) || section.key.toUpperCase() == "MAIN";
+}
+
+/** An INI menu file: [MAIN] (or the Pawn menu_core's [Основное]) with the words, a [section] a menu. */
 function readIni(root: ConfigNode, file: MenuFile) {
-	const main = root.get("MAIN");
+	const main = root.values().find(isMainSection);
 
 	if (main != null && main.kind == "object") {
-		checkKeys(main, INI_MAIN_KEYS, "[MAIN]", true);
+		checkKeys(main, INI_MAIN_KEYS, `[${main.key}]`, true);
 		file.labels.prefix = fileText(first(main.get("PREFIX")), whereOf(main));
 		const key = main.get("KEY");
 		if (key != null && key.kind == "object") checkKeys(key, INI_LABEL_KEYS, "KEY", true);
@@ -646,7 +654,7 @@ function readIni(root: ConfigNode, file: MenuFile) {
 	}
 
 	for (const section of root.values()) {
-		if (section.key.toUpperCase() == "MAIN" || section.kind != "object") continue;
+		if (isMainSection(section) || section.kind != "object") continue;
 		const menu = iniMenu(section);
 		if (menu != null) file.menus.push(menu);
 	}

package/src/menus.ts

@@ -2,7 +2,7 @@
  * Menu Core's menus: the Menu object, the functions of the module, and how a
  * menu is drawn and chosen from.
  */
-import { accessOf, Forward, Player, clearInterval, lang, print, server, setInterval, setTimeout } from "@amxts/core";
+import { accessOf, Forward, Player, clearInterval, lang, server, setInterval, setTimeout } from "@amxts/core";
 import { callingPlugin, onPluginStop, publicFor, showMenu } from "@amxts/core/kit";
 import { GetLangTransKey, get_maxplayers, register_menucmd, register_menuid } from "@amxts/core/natives";
 import { ActionHandler, ActionTest, ConditionFilter, ConditionTest, ListRow, ListSource, MenuContext, MenuEventType, MenuItemOptions, MenuKind, MenuOptions, MenuShowOptions, NamedContext, PlaceholderValue, RestrictionTest, RowTest } from "./types";
@@ -207,7 +207,9 @@ const PAGE_SLOTS = 7;
 const MAX_DEPTH = 5;
 const ALL_KEYS = 1023;
 /** The conditions Menu Core answers itself while nobody registered them - TEAM_<team> and FLAG_<letters> besides. */
-const BUILT_IN_CONDITIONS = ["IS_ALIVE", "IS_DEAD", "IS_BOT", "IS_ADMIN"];
+const BUILT_IN_CONDITIONS = ["IS_ALIVE", "IS_DEAD", "IS_BOT", "IS_ADMIN", "ADMIN", "ACCESS_ADMIN"];
+/** ADMIN and ACCESS_ADMIN, as the Pawn menu_core answered them: ban, rcon, admin or menu access. */
+const ADMIN_FLAGS = "FLAG_dluy";
 /** The teams of TEAM_<team>: the names of `player.team`. */
 const TEAMS = ["CT", "TERRORIST", "SPECTATOR", "UNASSIGNED"];
 const KEY_LETTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_";
@@ -272,6 +274,7 @@ server.addEventListener("putInServer", (event) => {
 	viewer.menu = "";
 	viewer.history = [];
 	viewer.page = 0;
+	viewer.nextPage = -1;
 	viewer.locked = false;
 });
 
@@ -310,8 +313,18 @@ export function menuAt(index: number) {
 	return find(menus[index].name);
 }
 
-/** The menu of that name in the menu file, read now if it is not yet; `null` when the file has no such menu, or no items in it. */
-export function register(name: string) {
+/**
+ * The menus of those names in the menu file, read now if they are not yet:
+ * `menus.register("SHOP", "SHOP_GUNS")`. Returns the first one's menu;
+ * `null` when the file has no such menu, or no items in it.
+ */
+export function register(...names: string[]) {
+	const found = names.map(registerOne);
+	return found.length > 0 ? found[0] : null;
+}
+
+/** The menu of that name in the menu file, read now if it is not yet; `null` when the file has none. */
+function registerOne(name: string) {
 	const known = find(name);
 	if (known != null) return known;
 	const spec = loadedFile().menus.find(each => each.name == name);
@@ -388,6 +401,16 @@ export function addAction(name: string, run: ActionHandler) {
 	return actions.length - 1;
 }
 
+/** Registers actions by name, for menu files and Pawn plugins: `menus.addActions({ SHOP_HEAL: heal, SHOP_ARMOR: (player) => player.armor = 100 })`. */
+export function addActions(actions: Record<string, ActionHandler>) {
+	for (const [name, run] of Object.entries(actions)) addAction(name, run);
+}
+
+/** Registers placeholders for menu files and Pawn plugins: `menus.addPlaceholders({ nick: (player) => player.name })`. A name registered twice keeps the first. */
+export function addPlaceholders(placeholders: Record<string, PlaceholderValue>) {
+	for (const [name, value] of Object.entries(placeholders)) addPlaceholder(name, value);
+}
+
 /** Registers a placeholder for menu files and Pawn plugins: the text `%name%` stands for in titles and items. A name registered twice keeps the first. In code the text is a function instead. */
 export function addPlaceholder(name: string, value: PlaceholderValue) {
 	const known = placeholders.findIndex(entry => entry.name == name);
@@ -453,11 +476,18 @@ export function textRow(text: string, centered = false) {
  * it is not active, or the player's menu holds on.
  */
 export function show(player: Player, name: string, options: MenuShowOptions = {}) {
-	return open(player, name, options, options.target?.id ?? 0);
+	const viewer = viewerOf(player.id);
+	// The menu he is on, shown from anywhere but its own item - a command, a
+	// timer - opens anew, at its first page; from its item it stays on its page.
+	const anew = viewer.menu == name && viewer.choosing != name;
+	return open(player, name, options, options.target?.id ?? 0, anew);
 }
 
-/** Shows a menu about `target`, a number: a player's `id`, or what a Pawn plugin gave - `0` for none. */
-function open(player: Player, name: string, options: MenuShowOptions, target: number) {
+/**
+ * Shows a menu about `target`, a number: a player's `id`, or what a Pawn
+ * plugin gave - `0` for none. `anew`: the menu he is on starts at its first page.
+ */
+function open(player: Player, name: string, options: MenuShowOptions, target: number, anew = false) {
 	if (!player.isConnected) return false;
 	const viewer = viewerOf(player.id);
 	const menu = menuNamed(name);
@@ -485,7 +515,7 @@ function open(player: Player, name: string, options: MenuShowOptions, target: nu
 
 	if (viewer.depth >= MAX_DEPTH) return false;
 	viewer.depth++;
-	const shown = draw(player, viewer, menu, options, target);
+	const shown = draw(player, viewer, menu, options, target, anew);
 	viewer.depth--;
 	return shown;
 }
@@ -558,7 +588,7 @@ export function isLocked(player: Player) {
 
 /** Sets the page the player's menu is drawn at next, from `0`. */
 export function setPage(player: Player, page: number) {
-	viewerOf(player.id).page = page;
+	viewerOf(player.id).nextPage = page;
 }
 
 /** Whether an action of that name is registered. */
@@ -593,7 +623,8 @@ function contextOf(player: Player, target: number, menu: Menu) {
 /** The context a function registered by name gets: the menu's, and the name it is asked by. */
 function namedContextOf(player: Player, target: number, menu: Menu, name: string) {
 	const context: NamedContext = { player, target: playerOr(target, player), row: target, menu, name };
-	return context;
+	// What an action or a placeholder takes: the context, or its player for a function of the player - the compiler hands it that.
+	return context as NamedContext & Player;
 }
 
 /** The player a target numbers; `fallback` for none. */
@@ -953,7 +984,7 @@ function usesCondition(menu: Menu, name: string) {
 
 function viewerOf(id: number) {
 	if (!viewers.has(id)) {
-		const made: Viewer = { menu: "", page: 0, target: 0, history: [], slots: [], rows: 0, text: "", locked: false, timer: 0, ticker: 0, depth: 0 };
+		const made: Viewer = { menu: "", page: 0, nextPage: -1, choosing: "", target: 0, history: [], slots: [], rows: 0, text: "", locked: false, timer: 0, ticker: 0, depth: 0 };
 		viewers.set(id, made);
 	}
 
@@ -966,7 +997,7 @@ function menuOf(viewer: Viewer) {
 }
 
 function menuNamed(name: string) {
-	return find(name) ?? register(name);
+	return find(name) ?? registerOne(name);
 }
 
 function lookingAt(menu: Menu) {
@@ -1002,7 +1033,7 @@ function isVisible(item: MenuItem, player: Player, target: number, menu: Menu) {
 	return check == null || passes(check, player, player.id, target, menu);
 }
 
-function draw(player: Player, viewer: Viewer, menu: Menu, options: MenuShowOptions, target: number) {
+function draw(player: Player, viewer: Viewer, menu: Menu, options: MenuShowOptions, target: number, anew: boolean) {
 	// A list menu nobody is left in does not open, and nothing of the viewer's changes.
 	const listing = menu.kind == "list" ? listOf(player, menu, target) : noListing();
 
@@ -1039,7 +1070,12 @@ function draw(player: Player, viewer: Viewer, menu: Menu, options: MenuShowOptio
 	if (!given) timer = menu.countdown > 0 ? menu.countdown : viewer.timer;
 	if (timer <= 0) timer = menu.time;
 
-	if (!returning && !options.skipHistory && back < 0) viewer.page = 0;
+	if (viewer.nextPage >= 0) {
+		viewer.page = viewer.nextPage;
+		viewer.nextPage = -1;
+	} else if (anew || (!returning && !options.skipHistory && back < 0)) {
+		viewer.page = 0;
+	}
 
 	const items = menu.kind == "list" ? noItems() : shownItems(player, viewer, menu);
 	const total = menu.kind == "list" ? listing.count : items.length;
@@ -1412,7 +1448,7 @@ function sayEmpty(player: Player, menu: Menu) {
 }
 
 function say(player: Player, message: string) {
-	print(player, `${ui(player.id, labels.prefix, DEFAULTS.prefix)} ${translate(player.id, message)}`);
+	player.print(`${ui(player.id, labels.prefix, DEFAULTS.prefix)} ${translate(player.id, message)}`);
 }
 
 function pressed(player: Player, key: number) {
@@ -1442,7 +1478,9 @@ function pressed(player: Player, key: number) {
 
 	const slot = viewer.slots[key];
 	if (slot.action.length == 0) return;
+	viewer.choosing = menu.name;
 	run(player, slot.action, slot.target, menu);
+	viewer.choosing = "";
 	if (viewer.menu == menu.name) open(player, menu.name, {}, viewer.target);
 }
 
@@ -1569,6 +1607,7 @@ function builtInHolds(player: Player, name: string) {
 	if (upper == "IS_DEAD") return !player.isAlive;
 	if (upper == "IS_BOT") return player.isBot;
 	if (upper == "IS_ADMIN") return isAdmin(player);
+	if (upper == "ADMIN" || upper == "ACCESS_ADMIN") return hasAccess(player, ADMIN_FLAGS);
 	if (upper.startsWith("TEAM_")) return player.team == upper.slice(5);
 	return hasAccess(player, name);
 }