@amxts/menu-core 0.1.0

package/prebuilt/manifest.json

@@ -0,0 +1,703 @@
+{
+	"format": 1,
+	"module": "@amxts/menu-core",
+	"version": "0.1.0",
+	"from": {
+		"@amxts/core": {
+			"version": "0.1.0",
+			"hash": "e3b12482fd1df1dcadee7e27a12ba915d97bf859"
+		},
+		"@amxts/config-core": {
+			"version": "0.1.0",
+			"hash": "fcdce20fc0fa51cce2d963ef408be861e44da388"
+		},
+		"@amxts/menu-core": {
+			"version": "0.1.0",
+			"hash": "68d0866205e1d840d37924f519429eaf11b6f778"
+		}
+	},
+	"options": {
+		"@amxts/config-core": {
+			"baseDir": ""
+		},
+		"@amxts/menu-core": {
+			"file": "menu",
+			"fallback": ""
+		}
+	},
+	"forwards": {},
+	"places": [
+		"constants.ts",
+		"effects.ts",
+		"entities.ts",
+		"events.ts",
+		"facade.ts",
+		"flags.ts",
+		"fs.ts",
+		"hooks.ts",
+		"kit.ts",
+		"menu-core.ts",
+		"modules/config-core.ts",
+		"modules/config-core/src/files.ts",
+		"modules/config-core/src/ini-tree.ts",
+		"modules/config-core/src/ini.ts",
+		"modules/config-core/src/internal.ts",
+		"modules/config-core/src/json.ts",
+		"modules/config-core/src/tree.ts",
+		"modules/config-core/src/types.ts",
+		"modules/config-core/src/yaml.ts",
+		"modules/menu-core.ts",
+		"modules/menu-core/src/internal.ts",
+		"modules/menu-core/src/menu-file.ts",
+		"modules/menu-core/src/types.ts",
+		"natives.ts",
+		"os.ts",
+		"promise.ts",
+		"vector.ts"
+	],
+	"natives": [
+		{
+			"name": "mc_register_condition",
+			"params": [
+				{
+					"name": "name",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Registers a condition menus refer to - an item's condition, ACTIVE_ON, a\n * FILTER. The first plugin to register a name answers for it (case-insensitive).\n * Callback: public callback(id, viewerId, const name[]) - true when it holds.\n * Returns the condition's id.\n */"
+		},
+		{
+			"name": "mc_register_action",
+			"params": [
+				{
+					"name": "name",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "_isCritical",
+					"kind": "bool",
+					"pawnDefault": "false"
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Registers an action run when an item is chosen. Built in, not registered:\n * SHOW_<SECTION> opens that menu, CLOSE_MENU closes it; an action line may\n * list several, space-separated. Names are case-sensitive; the first wins.\n * Callback: public callback(id, const action[]) in an items menu,\n * public callback(id, targetId) in a LIST_ menu. isCritical is accepted and\n * does nothing. Returns the action's id.\n */"
+		},
+		{
+			"name": "mc_register_placeholder",
+			"params": [
+				{
+					"name": "name",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Registers a placeholder, %name% in titles and items, without the %.\n * Callback: public callback(id, targetId, value[], len) - fills value[].\n * A name registered again keeps the first. Returns the placeholder's id.\n */"
+		},
+		{
+			"name": "mc_register_menu",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Registers the config file's [section] as a menu. Returns the menu's id, or\n * -1 when the section is missing, has no TITLE or no items, or is MAIN.\n */"
+		},
+		{
+			"name": "mc_show_menu",
+			"params": [
+				{
+					"name": "player",
+					"kind": "player",
+					"pawnDefault": null
+				},
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "time",
+					"kind": "int",
+					"pawnDefault": "-1"
+				},
+				{
+					"name": "targetId",
+					"kind": "int",
+					"pawnDefault": "0"
+				},
+				{
+					"name": "resetHistory",
+					"kind": "bool",
+					"pawnDefault": "false"
+				},
+				{
+					"name": "forceOpen",
+					"kind": "bool",
+					"pawnDefault": "false"
+				},
+				{
+					"name": "ignoreHistory",
+					"kind": "bool",
+					"pawnDefault": "false"
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Shows a menu. time: countdown seconds, -1 for the menu's TIME (or the\n * countdown running). targetId: who a LIST_ menu is about. resetHistory\n * starts the way back anew; forceOpen opens over a menu that holds on (a\n * countdown, a lock); ignoreHistory leaves this menu out of the way back.\n * Returns 1 when it opened; 0 when the player is not in the game, there is no\n * such menu, a show filter or ACTIVE_ON stopped it.\n */"
+		},
+		{
+			"name": "mc_set_menu_timer",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "time",
+					"kind": "int",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Sets the menu's shared countdown: starts one of `time` seconds when none\n * runs, or changes the seconds left (0 stops it). Returns 1, or 0 when there\n * is no such menu or nothing to change.\n */"
+		},
+		{
+			"name": "mc_notify_condition_changed",
+			"params": [
+				{
+					"name": "condition",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "void",
+			"doc": "/** Draws again every menu that uses the condition, for whoever looks at it. */"
+		},
+		{
+			"name": "mc_refresh_menu",
+			"params": [
+				{
+					"name": "sections",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/** Draws the menus again (space-separated names) for whoever looks at them. Returns how many were drawn. */"
+		},
+		{
+			"name": "mc_register_restriction",
+			"params": [
+				{
+					"name": "name",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "message",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Registers a restriction items name in their restriction column; \"*\"\n * answers for every name no other restriction does. Callback:\n * public callback(id, const restrictName[], targetId) - true when the player\n * passes. message is said beside an item it greys out, when the item has no\n * message of its own. Returns the restriction's id.\n */"
+		},
+		{
+			"name": "mc_register_action_condition",
+			"params": [
+				{
+					"name": "menuSection",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "actionName",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Greys out items whose action is actionName in menuSection while the\n * callback says no; \"\" for either matches all. Callback:\n * public callback(id, const menuSection[], const actionName[]). Returns 1.\n */"
+		},
+		{
+			"name": "mc_register_condition_filter",
+			"params": [
+				{
+					"name": "condition",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Registers a filter over a condition someone else registered: it gets the\n * condition's value and returns the one to use. Callback:\n * public bool:callback(id, viewerId, const condition[], bool:currentVal).\n * Returns the filter's id.\n */"
+		},
+		{
+			"name": "mc_register_list_data_source",
+			"params": [
+				{
+					"name": "menuName",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * The rows of a LIST_ menu, instead of the players. Callback:\n * public callback(id, Array:items) - pushes 289-cell items and returns 1:\n * [0] the target the action gets (-2: a line of text), [1..64] an action of\n * its own, [65..128] the text (%name%), [129..160] a restriction,\n * [161..288] the message when it greys the row out. A second source for the\n * menu replaces the first. Returns the source's id.\n */"
+		},
+		{
+			"name": "mc_register_menu_open_callback",
+			"params": [
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/** Called when a menu opens. Callback: public callback(id, const section[]). Returns its id. */"
+		},
+		{
+			"name": "mc_register_menu_close_callback",
+			"params": [
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Called when a menu closes - by a key, a timeout, another menu opening over\n * it, the player leaving. Callback: public callback(id, const section[], bool:isTimeout).\n * Returns its id.\n */"
+		},
+		{
+			"name": "mc_register_show_filter",
+			"params": [
+				{
+					"name": "callback",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Asked before any menu opens; returning false stops it (mc_show_menu returns\n * 0) - the place to tell the player why. Callback:\n * public bool:callback(id, const section[]). Returns its id.\n */"
+		},
+		{
+			"name": "mc_cancel_menu_timer",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/** Stops the menu's shared countdown and closes it for everyone. Returns 1, or 0 when none ran. */"
+		},
+		{
+			"name": "mc_lock_menu",
+			"params": [
+				{
+					"name": "player",
+					"kind": "player",
+					"pawnDefault": null
+				},
+				{
+					"name": "lock",
+					"kind": "bool",
+					"pawnDefault": "true"
+				}
+			],
+			"result": "void",
+			"doc": "/** Locks (or unlocks) the player's menu: nothing can be chosen, and no other menu replaces it. */"
+		},
+		{
+			"name": "mc_hide_menu",
+			"params": [
+				{
+					"name": "player",
+					"kind": "player",
+					"pawnDefault": null
+				}
+			],
+			"result": "void",
+			"doc": "/** Closes the player's menu. */"
+		},
+		{
+			"name": "mc_is_menu_locked",
+			"params": [
+				{
+					"name": "player",
+					"kind": "player",
+					"pawnDefault": null
+				}
+			],
+			"result": "bool",
+			"doc": "/** Whether the player's menu is locked. */"
+		},
+		{
+			"name": "mc_get_active_menu",
+			"params": [
+				{
+					"name": "id",
+					"kind": "int",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/** The id of the menu the player looks at, or -1. */"
+		},
+		{
+			"name": "mc_get_menu_property_string",
+			"params": [
+				{
+					"name": "menuIdx",
+					"kind": "int",
+					"pawnDefault": null
+				},
+				{
+					"name": "property",
+					"kind": "tag",
+					"pawnDefault": null,
+					"tag": "MenuProperty"
+				}
+			],
+			"result": "string",
+			"doc": "/**\n * A string property of a menu by its id (mc_get_active_menu): MP_SECTION, the\n * section name, into out[]. Returns its length; 0 when the id or the property\n * is not one.\n */"
+		},
+		{
+			"name": "mc_set_menu_property",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "property",
+					"kind": "tag",
+					"pawnDefault": null,
+					"tag": "MenuProperty"
+				},
+				{
+					"name": "value",
+					"kind": "int",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Sets MP_LOCKED, MP_GLOBAL_TIMER, MP_TIMER_DURATION, MP_HIDE_BACK or\n * MP_HIDE_EXIT. Returns 1, or 0 when there is no such menu or property.\n */"
+		},
+		{
+			"name": "mc_set_menu_property_string",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "property",
+					"kind": "tag",
+					"pawnDefault": null,
+					"tag": "MenuProperty"
+				},
+				{
+					"name": "value",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Sets MP_ON_TIMEOUT (the action when the countdown ends), MP_ACTIVE_ON (the\n * condition the menu opens under) or MP_FILTER (\"CONDITION|MESSAGE\", added to\n * a LIST_ menu's filters). Returns 1, or 0 when there is no such menu or\n * property.\n */"
+		},
+		{
+			"name": "mc_add_menu_item",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "name",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "placeholder",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "condition",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "action",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "restriction",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "restrictMsg",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "iPosition",
+					"kind": "int",
+					"pawnDefault": "-1"
+				},
+				{
+					"name": "emptyBefore",
+					"kind": "int",
+					"pawnDefault": "0"
+				},
+				{
+					"name": "emptyAfter",
+					"kind": "int",
+					"pawnDefault": "0"
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Adds an item to a menu. name, condition and action take \"A|B\" variants: the\n * first whose condition holds is shown. iPosition: its place among the items,\n * -1 the end; emptyBefore/emptyAfter: blank lines around it. Returns 1, or 0\n * when there is no such menu or the name gives no item.\n */"
+		},
+		{
+			"name": "mc_add_fixed_menu_item",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "slot",
+					"kind": "int",
+					"pawnDefault": null
+				},
+				{
+					"name": "name",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "placeholder",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "action",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "condition",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "restriction",
+					"kind": "string",
+					"pawnDefault": "\"\""
+				},
+				{
+					"name": "emptyBefore",
+					"kind": "int",
+					"pawnDefault": "0"
+				},
+				{
+					"name": "emptyAfter",
+					"kind": "int",
+					"pawnDefault": "0"
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Adds an item that always takes slot 1-7 of every page. Returns 1, or 0 when\n * there is no such menu or the name gives no item.\n */"
+		},
+		{
+			"name": "mc_add_list_text",
+			"params": [
+				{
+					"name": "aItems",
+					"kind": "int",
+					"pawnDefault": null
+				},
+				{
+					"name": "text",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "centered",
+					"kind": "bool",
+					"pawnDefault": "false"
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Adds a line of text - a header, a separator - to the items a data source\n * fills; call it from the data source callback. Returns 1.\n */"
+		},
+		{
+			"name": "mc_clear_menu_items",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/** Removes every item of a menu, fixed ones too. Returns 1, or 0 when there is no such menu. */"
+		},
+		{
+			"name": "mc_create_menu",
+			"params": [
+				{
+					"name": "section",
+					"kind": "string",
+					"pawnDefault": null
+				},
+				{
+					"name": "title",
+					"kind": "string",
+					"pawnDefault": null
+				}
+			],
+			"result": "int",
+			"doc": "/**\n * Makes a menu in code, without a config section; a name starting with LIST_\n * makes a list menu. Returns 1, or 0 when a menu of that name is there.\n */"
+		},
+		{
+			"name": "mc_set_menu_page",
+			"params": [
+				{
+					"name": "player",
+					"kind": "player",
+					"pawnDefault": null
+				},
+				{
+					"name": "page",
+					"kind": "int",
+					"pawnDefault": null
+				}
+			],
+			"result": "void",
+			"doc": "/** The page, from 0, the player's menu is drawn at next. */"
+		},
+		{
+			"name": "mc_get_menu_text",
+			"params": [
+				{
+					"name": "player",
+					"kind": "player",
+					"pawnDefault": null
+				}
+			],
+			"result": "string",
+			"doc": "/**\n * The text the player's menu shows at the moment, colour codes and all (\"\"\n * when none is open) - for a test or a log to see what the player sees.\n */"
+		}
+	],
+	"beside": {
+		"enums": [
+			{
+				"name": "MenuProperty",
+				"members": [
+					{
+						"name": "MP_LOCKED",
+						"value": 0
+					},
+					{
+						"name": "MP_GLOBAL_TIMER",
+						"value": 1
+					},
+					{
+						"name": "MP_TIMER_DURATION",
+						"value": 2
+					},
+					{
+						"name": "MP_HIDE_BACK",
+						"value": 3
+					},
+					{
+						"name": "MP_HIDE_EXIT",
+						"value": 4
+					},
+					{
+						"name": "MP_SECTION",
+						"value": 5
+					},
+					{
+						"name": "MP_ON_TIMEOUT",
+						"value": 5
+					},
+					{
+						"name": "MP_ACTIVE_ON",
+						"value": 6
+					},
+					{
+						"name": "MP_FILTER",
+						"value": 7
+					}
+				],
+				"doc": "/**\n * Menu properties: mc_set_menu_property takes MP_LOCKED .. MP_HIDE_EXIT,\n * mc_set_menu_property_string MP_ON_TIMEOUT .. MP_FILTER, and\n * mc_get_menu_property_string MP_SECTION.\n */"
+			}
+		],
+		"contract": null,
+		"author": "kukson777"
+	},
+	"systems": {
+		"windows": {
+			"file": "prebuilt/windows/menu-core.aot",
+			"size": 1128304,
+			"sha256": "8f478200e882ce19bdea88c8b7cdf2d4b7c8697993a05848a95b6c8268ee746e"
+		},
+		"linux": {
+			"file": "prebuilt/linux/menu-core.aot",
+			"size": 1140072,
+			"sha256": "3207bb5fdca8963b1edbece735772bfa074960ca0b3927ec424fe82f8d6c8a8e"
+		}
+	}
+}