WorldEditAditions

--- Applies the given brush with the given height and size to the given position.
-- @param	pos1		Vector3		The position at which to apply the brush.
-- @param	brush_name	string		The name of the brush to apply.
-- @param	brush_size	Vector3		The size of the brush application. Values are interpreted on the X/Y coordinates, and NOT X/Z!
-- @param	height		number		The height of the brush application.
-- @returns	bool, string|{ added: number, removed: number }	A bool indicating whether the operation was successful or not, followed by either an error message as a string (if it was not successful) or a table of statistics (if it was successful).
local function apply(pos1, brush_name, brush_size, height)

{
	"type": "function",
	"internal": false,
	"description": "Applies the given brush with the given height and size to the given position.",
	"directives": [
		{
			"directive": "param",
			"text": "pos1\t\tVector3\t\tThe position at which to apply the brush.",
			"name": "pos1",
			"type": "Vector3",
			"description": "The position at which to apply the brush."
		},
		{
			"directive": "param",
			"text": "brush_name\tstring\t\tThe name of the brush to apply.",
			"name": "brush_name",
			"type": "string",
			"description": "The name of the brush to apply."
		},
		{
			"directive": "param",
			"text": "brush_size\tVector3\t\tThe size of the brush application. Values are interpreted on the X/Y coordinates, and NOT X/Z!",
			"name": "brush_size",
			"type": "Vector3",
			"description": "The size of the brush application. Values are interpreted on the X/Y coordinates, and NOT X/Z!"
		},
		{
			"directive": "param",
			"text": "height\t\tnumber\t\tThe height of the brush application.",
			"name": "height",
			"type": "number",
			"description": "The height of the brush application."
		},
		{
			"directive": "returns",
			"text": "bool, string|{ added: number, removed: number }\tA bool indicating whether the operation was successful or not, followed by either an error message as a string (if it was not successful) or a table of statistics (if it was successful).",
			"type": "bool, string|{ added: number, removed: number }",
			"description": "A bool indicating whether the operation was successful or not, followed by either an error message as a string (if it was not successful) or a table of statistics (if it was successful)."
		}
	],
	"line": 7,
	"namespace": "worldeditadditions.sculpt",
	"line_last": 13,
	"name": "apply",
	"instanced": false,
	"args": [
		"pos1",
		"brush_name",
		"brush_size",
		"height"
	],
	"text": "--- Applies the given brush with the given height and size to the given position.\n-- @param\tpos1\t\tVector3\t\tThe position at which to apply the brush.\n-- @param\tbrush_name\tstring\t\tThe name of the brush to apply.\n-- @param\tbrush_size\tVector3\t\tThe size of the brush application. Values are interpreted on the X/Y coordinates, and NOT X/Z!\n-- @param\theight\t\tnumber\t\tThe height of the brush application.\n-- @returns\tbool, string|{ added: number, removed: number }\tA bool indicating whether the operation was successful or not, followed by either an error message as a string (if it was not successful) or a table of statistics (if it was successful).\nlocal function apply(pos1, brush_name, brush_size, height)",
	"params": [
		{
			"directive": "param",
			"text": "pos1\t\tVector3\t\tThe position at which to apply the brush.",
			"name": "pos1",
			"type": "Vector3",
			"description": "The position at which to apply the brush."
		},
		{
			"directive": "param",
			"text": "brush_name\tstring\t\tThe name of the brush to apply.",
			"name": "brush_name",
			"type": "string",
			"description": "The name of the brush to apply."
		},
		{
			"directive": "param",
			"text": "brush_size\tVector3\t\tThe size of the brush application. Values are interpreted on the X/Y coordinates, and NOT X/Z!",
			"name": "brush_size",
			"type": "Vector3",
			"description": "The size of the brush application. Values are interpreted on the X/Y coordinates, and NOT X/Z!"
		},
		{
			"directive": "param",
			"text": "height\t\tnumber\t\tThe height of the brush application.",
			"name": "height",
			"type": "number",
			"description": "The height of the brush application."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool, string|{ added: number, removed: number }\tA bool indicating whether the operation was successful or not, followed by either an error message as a string (if it was not successful) or a table of statistics (if it was successful).",
		"type": "bool, string|{ added: number, removed: number }",
		"description": "A bool indicating whether the operation was successful or not, followed by either an error message as a string (if it was not successful) or a table of statistics (if it was successful)."
	},
	"examples": [],
	"name_full": "worldeditadditions.sculpt.apply",
	"filename": "worldeditadditions/lib/sculpt/apply.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/sculpt/apply.lua#L8-L14"
}

--- Applies the given brush at the given x/z position to the given heightmap.
-- Important: Where a Vector3 is mentioned in the parameter list, it reall MUST
-- be a Vector3 instance.
-- Also important: Remember that the position there is RELATIVE TO THE HEIGHTMAP'S origin (0, 0) and is on the X and Z axes!
-- @param	brush			table	The ZERO-indexed brush to apply. Values should be normalised to be between 0 and 1.
-- @param	brush_size		Vector3	The size of the brush on the x/y axes.
-- @pram	height			number	The multiplier to apply to each brush pixel value just before applying it. Negative values are allowed - this will cause a subtraction operation instead of an addition.
-- @param	position		Vector3	The position RELATIVE TO THE HEIGHTMAP on the x/z coordinates to centre the brush application on.
-- @param	heightmap		table	The heightmap to apply the brush to. See worldeditadditions.make_heightmap for how to obtain one of these.
-- @param	heightmap_size	Vector3	The size of the aforementioned heightmap. See worldeditadditions.make_heightmap for more information.
-- @returns	true,number,number|false,string		If the operation was not successful, then false followed by an error message as a string is returned. If it was successful however, 3 values are returned: true, then the number of nodes added, then the number of nodes removed.
local function apply_heightmap(brush, brush_size, height, position, heightmap, heightmap_size)

{
	"type": "function",
	"internal": false,
	"description": "Applies the given brush at the given x/z position to the given heightmap.\nImportant: Where a Vector3 is mentioned in the parameter list, it reall MUST\nbe a Vector3 instance.\nAlso important: Remember that the position there is RELATIVE TO THE HEIGHTMAP'S origin (0, 0) and is on the X and Z axes!",
	"directives": [
		{
			"directive": "param",
			"text": "brush\t\t\ttable\tThe ZERO-indexed brush to apply. Values should be normalised to be between 0 and 1.",
			"name": "brush",
			"type": "table",
			"description": "The ZERO-indexed brush to apply. Values should be normalised to be between 0 and 1."
		},
		{
			"directive": "param",
			"text": "brush_size\t\tVector3\tThe size of the brush on the x/y axes.",
			"name": "brush_size",
			"type": "Vector3",
			"description": "The size of the brush on the x/y axes."
		},
		{
			"directive": "pram",
			"text": "height\t\t\tnumber\tThe multiplier to apply to each brush pixel value just before applying it. Negative values are allowed - this will cause a subtraction operation instead of an addition."
		},
		{
			"directive": "param",
			"text": "position\t\tVector3\tThe position RELATIVE TO THE HEIGHTMAP on the x/z coordinates to centre the brush application on.",
			"name": "position",
			"type": "Vector3",
			"description": "The position RELATIVE TO THE HEIGHTMAP on the x/z coordinates to centre the brush application on."
		},
		{
			"directive": "param",
			"text": "heightmap\t\ttable\tThe heightmap to apply the brush to. See worldeditadditions.make_heightmap for how to obtain one of these.",
			"name": "heightmap",
			"type": "table",
			"description": "The heightmap to apply the brush to. See worldeditadditions.make_heightmap for how to obtain one of these."
		},
		{
			"directive": "param",
			"text": "heightmap_size\tVector3\tThe size of the aforementioned heightmap. See worldeditadditions.make_heightmap for more information.",
			"name": "heightmap_size",
			"type": "Vector3",
			"description": "The size of the aforementioned heightmap. See worldeditadditions.make_heightmap for more information."
		},
		{
			"directive": "returns",
			"text": "true,number,number|false,string\t\tIf the operation was not successful, then false followed by an error message as a string is returned. If it was successful however, 3 values are returned: true, then the number of nodes added, then the number of nodes removed.",
			"type": "true,number,number|false,string",
			"description": "If the operation was not successful, then false followed by an error message as a string is returned. If it was successful however, 3 values are returned: true, then the number of nodes added, then the number of nodes removed."
		}
	],
	"line": 7,
	"namespace": "worldeditadditions.sculpt",
	"line_last": 18,
	"name": "apply_heightmap",
	"instanced": false,
	"args": [
		"brush",
		"brush_size",
		"height",
		"position",
		"heightmap",
		"heightmap_size"
	],
	"text": "--- Applies the given brush at the given x/z position to the given heightmap.\n-- Important: Where a Vector3 is mentioned in the parameter list, it reall MUST\n-- be a Vector3 instance.\n-- Also important: Remember that the position there is RELATIVE TO THE HEIGHTMAP'S origin (0, 0) and is on the X and Z axes!\n-- @param\tbrush\t\t\ttable\tThe ZERO-indexed brush to apply. Values should be normalised to be between 0 and 1.\n-- @param\tbrush_size\t\tVector3\tThe size of the brush on the x/y axes.\n-- @pram\theight\t\t\tnumber\tThe multiplier to apply to each brush pixel value just before applying it. Negative values are allowed - this will cause a subtraction operation instead of an addition.\n-- @param\tposition\t\tVector3\tThe position RELATIVE TO THE HEIGHTMAP on the x/z coordinates to centre the brush application on.\n-- @param\theightmap\t\ttable\tThe heightmap to apply the brush to. See worldeditadditions.make_heightmap for how to obtain one of these.\n-- @param\theightmap_size\tVector3\tThe size of the aforementioned heightmap. See worldeditadditions.make_heightmap for more information.\n-- @returns\ttrue,number,number|false,string\t\tIf the operation was not successful, then false followed by an error message as a string is returned. If it was successful however, 3 values are returned: true, then the number of nodes added, then the number of nodes removed.\nlocal function apply_heightmap(brush, brush_size, height, position, heightmap, heightmap_size)",
	"params": [
		{
			"directive": "param",
			"text": "brush\t\t\ttable\tThe ZERO-indexed brush to apply. Values should be normalised to be between 0 and 1.",
			"name": "brush",
			"type": "table",
			"description": "The ZERO-indexed brush to apply. Values should be normalised to be between 0 and 1."
		},
		{
			"directive": "param",
			"text": "brush_size\t\tVector3\tThe size of the brush on the x/y axes.",
			"name": "brush_size",
			"type": "Vector3",
			"description": "The size of the brush on the x/y axes."
		},
		{
			"directive": "param",
			"text": "position\t\tVector3\tThe position RELATIVE TO THE HEIGHTMAP on the x/z coordinates to centre the brush application on.",
			"name": "position",
			"type": "Vector3",
			"description": "The position RELATIVE TO THE HEIGHTMAP on the x/z coordinates to centre the brush application on."
		},
		{
			"directive": "param",
			"text": "heightmap\t\ttable\tThe heightmap to apply the brush to. See worldeditadditions.make_heightmap for how to obtain one of these.",
			"name": "heightmap",
			"type": "table",
			"description": "The heightmap to apply the brush to. See worldeditadditions.make_heightmap for how to obtain one of these."
		},
		{
			"directive": "param",
			"text": "heightmap_size\tVector3\tThe size of the aforementioned heightmap. See worldeditadditions.make_heightmap for more information.",
			"name": "heightmap_size",
			"type": "Vector3",
			"description": "The size of the aforementioned heightmap. See worldeditadditions.make_heightmap for more information."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "true,number,number|false,string\t\tIf the operation was not successful, then false followed by an error message as a string is returned. If it was successful however, 3 values are returned: true, then the number of nodes added, then the number of nodes removed.",
		"type": "true,number,number|false,string",
		"description": "If the operation was not successful, then false followed by an error message as a string is returned. If it was successful however, 3 values are returned: true, then the number of nodes added, then the number of nodes removed."
	},
	"examples": [],
	"name_full": "worldeditadditions.sculpt.apply_heightmap",
	"filename": "worldeditadditions/lib/sculpt/apply_heightmap.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/sculpt/apply_heightmap.lua#L8-L19"
}

--- Makes a sculpting brush that is as close to a target size as possible.
-- @param	brush_name	string	The name of the brush to create.
-- @param	target_size	Vector3	The target size of the brush to create.
-- @returns	true,table,Vector3|false,string	If the operation was successful, true followed by the brush in a 1D ZERO-indexed table followed by the actual size of the brush as a Vector3 (x & y components used only). If the operation was not successful, false and an error message string is returned instead.
local function make_brush(brush_name, target_size)

{
	"type": "function",
	"internal": false,
	"description": "Makes a sculpting brush that is as close to a target size as possible.",
	"directives": [
		{
			"directive": "param",
			"text": "brush_name\tstring\tThe name of the brush to create.",
			"name": "brush_name",
			"type": "string",
			"description": "The name of the brush to create."
		},
		{
			"directive": "param",
			"text": "target_size\tVector3\tThe target size of the brush to create.",
			"name": "target_size",
			"type": "Vector3",
			"description": "The target size of the brush to create."
		},
		{
			"directive": "returns",
			"text": "true,table,Vector3|false,string\tIf the operation was successful, true followed by the brush in a 1D ZERO-indexed table followed by the actual size of the brush as a Vector3 (x & y components used only). If the operation was not successful, false and an error message string is returned instead.",
			"type": "true,table,Vector3|false,string",
			"description": "If the operation was successful, true followed by the brush in a 1D ZERO-indexed table followed by the actual size of the brush as a Vector3 (x & y components used only). If the operation was not successful, false and an error message string is returned instead."
		}
	],
	"line": 5,
	"namespace": "worldeditadditions.sculpt",
	"line_last": 9,
	"name": "make_brush",
	"instanced": false,
	"args": [
		"brush_name",
		"target_size"
	],
	"text": "--- Makes a sculpting brush that is as close to a target size as possible.\n-- @param\tbrush_name\tstring\tThe name of the brush to create.\n-- @param\ttarget_size\tVector3\tThe target size of the brush to create.\n-- @returns\ttrue,table,Vector3|false,string\tIf the operation was successful, true followed by the brush in a 1D ZERO-indexed table followed by the actual size of the brush as a Vector3 (x & y components used only). If the operation was not successful, false and an error message string is returned instead.\nlocal function make_brush(brush_name, target_size)",
	"params": [
		{
			"directive": "param",
			"text": "brush_name\tstring\tThe name of the brush to create.",
			"name": "brush_name",
			"type": "string",
			"description": "The name of the brush to create."
		},
		{
			"directive": "param",
			"text": "target_size\tVector3\tThe target size of the brush to create.",
			"name": "target_size",
			"type": "Vector3",
			"description": "The target size of the brush to create."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "true,table,Vector3|false,string\tIf the operation was successful, true followed by the brush in a 1D ZERO-indexed table followed by the actual size of the brush as a Vector3 (x & y components used only). If the operation was not successful, false and an error message string is returned instead.",
		"type": "true,table,Vector3|false,string",
		"description": "If the operation was successful, true followed by the brush in a 1D ZERO-indexed table followed by the actual size of the brush as a Vector3 (x & y components used only). If the operation was not successful, false and an error message string is returned instead."
	},
	"examples": [],
	"name_full": "worldeditadditions.sculpt.make_brush",
	"filename": "worldeditadditions/lib/sculpt/make_brush.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/sculpt/make_brush.lua#L6-L10"
}

--- Generates a textual preview of a given brush.
-- @param	brush		table	The brush in question to preview.
-- @param	size		Vector3	The size of the brush.
-- @returns	string		A preview of the brush as a string.
local function make_preview(brush, size, framed)

{
	"type": "function",
	"internal": false,
	"description": "Generates a textual preview of a given brush.",
	"directives": [
		{
			"directive": "param",
			"text": "brush\t\ttable\tThe brush in question to preview.",
			"name": "brush",
			"type": "table",
			"description": "The brush in question to preview."
		},
		{
			"directive": "param",
			"text": "size\t\tVector3\tThe size of the brush.",
			"name": "size",
			"type": "Vector3",
			"description": "The size of the brush."
		},
		{
			"directive": "returns",
			"text": "string\t\tA preview of the brush as a string.",
			"type": "string",
			"description": "A preview of the brush as a string."
		}
	],
	"line": 7,
	"namespace": "worldeditadditions.sculpt",
	"line_last": 11,
	"name": "make_preview",
	"instanced": false,
	"args": [
		"brush",
		"size",
		"framed"
	],
	"text": "--- Generates a textual preview of a given brush.\n-- @param\tbrush\t\ttable\tThe brush in question to preview.\n-- @param\tsize\t\tVector3\tThe size of the brush.\n-- @returns\tstring\t\tA preview of the brush as a string.\nlocal function make_preview(brush, size, framed)",
	"params": [
		{
			"directive": "param",
			"text": "brush\t\ttable\tThe brush in question to preview.",
			"name": "brush",
			"type": "table",
			"description": "The brush in question to preview."
		},
		{
			"directive": "param",
			"text": "size\t\tVector3\tThe size of the brush.",
			"name": "size",
			"type": "Vector3",
			"description": "The size of the brush."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "string\t\tA preview of the brush as a string.",
		"type": "string",
		"description": "A preview of the brush as a string."
	},
	"examples": [],
	"name_full": "worldeditadditions.sculpt.make_preview",
	"filename": "worldeditadditions/lib/sculpt/make_preview.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/sculpt/make_preview.lua#L8-L12"
}

--- Generates a textual preview of a given brush.
-- @param	brush_name	string	The name of the brush to create a preview for.
-- @param	target_size	Vector3	The target size of the brush to create. Default: (10, 10, 0).
-- @returns	bool,string	If the operation was successful, true followed by a preview of the brush as a string. If the operation was not successful, false and an error message string is returned instead.
local function preview_brush(brush_name, target_size, framed)

{
	"type": "function",
	"internal": false,
	"description": "Generates a textual preview of a given brush.",
	"directives": [
		{
			"directive": "param",
			"text": "brush_name\tstring\tThe name of the brush to create a preview for.",
			"name": "brush_name",
			"type": "string",
			"description": "The name of the brush to create a preview for."
		},
		{
			"directive": "param",
			"text": "target_size\tVector3\tThe target size of the brush to create. Default: (10, 10, 0).",
			"name": "target_size",
			"type": "Vector3",
			"description": "The target size of the brush to create. Default: (10, 10, 0)."
		},
		{
			"directive": "returns",
			"text": "bool,string\tIf the operation was successful, true followed by a preview of the brush as a string. If the operation was not successful, false and an error message string is returned instead.",
			"type": "bool,string",
			"description": "If the operation was successful, true followed by a preview of the brush as a string. If the operation was not successful, false and an error message string is returned instead."
		}
	],
	"line": 10,
	"namespace": "worldeditadditions.sculpt",
	"line_last": 14,
	"name": "preview_brush",
	"instanced": false,
	"args": [
		"brush_name",
		"target_size",
		"framed"
	],
	"text": "--- Generates a textual preview of a given brush.\n-- @param\tbrush_name\tstring\tThe name of the brush to create a preview for.\n-- @param\ttarget_size\tVector3\tThe target size of the brush to create. Default: (10, 10, 0).\n-- @returns\tbool,string\tIf the operation was successful, true followed by a preview of the brush as a string. If the operation was not successful, false and an error message string is returned instead.\nlocal function preview_brush(brush_name, target_size, framed)",
	"params": [
		{
			"directive": "param",
			"text": "brush_name\tstring\tThe name of the brush to create a preview for.",
			"name": "brush_name",
			"type": "string",
			"description": "The name of the brush to create a preview for."
		},
		{
			"directive": "param",
			"text": "target_size\tVector3\tThe target size of the brush to create. Default: (10, 10, 0).",
			"name": "target_size",
			"type": "Vector3",
			"description": "The target size of the brush to create. Default: (10, 10, 0)."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool,string\tIf the operation was successful, true followed by a preview of the brush as a string. If the operation was not successful, false and an error message string is returned instead.",
		"type": "bool,string",
		"description": "If the operation was successful, true followed by a preview of the brush as a string. If the operation was not successful, false and an error message string is returned instead."
	},
	"examples": [],
	"name_full": "worldeditadditions.sculpt.preview_brush",
	"filename": "worldeditadditions/lib/sculpt/preview_brush.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/sculpt/preview_brush.lua#L11-L15"
}

--- Additively adds a point to the current selection defined by pos1..pos2 or
-- makes a selection from the provided point.
-- @param	name	string	Player name.
-- @param	pos	vector	The position to include.
-- @returns	void
function selection.add_point(name, newpos)

{
	"type": "function",
	"internal": false,
	"description": "Additively adds a point to the current selection defined by pos1..pos2 or\nmakes a selection from the provided point.",
	"directives": [
		{
			"directive": "param",
			"text": "name\tstring\tPlayer name.",
			"name": "name",
			"type": "string",
			"description": "Player name."
		},
		{
			"directive": "param",
			"text": "pos\tvector\tThe position to include.",
			"name": "pos",
			"type": "vector",
			"description": "The position to include."
		},
		{
			"directive": "returns",
			"text": "void",
			"type": "void"
		}
	],
	"line": 17,
	"namespace": "worldeditadditions.selection",
	"line_last": 22,
	"name": "add_point",
	"instanced": false,
	"args": [
		"name",
		"newpos"
	],
	"text": "--- Additively adds a point to the current selection defined by pos1..pos2 or\n-- makes a selection from the provided point.\n-- @param\tname\tstring\tPlayer name.\n-- @param\tpos\tvector\tThe position to include.\n-- @returns\tvoid\nfunction selection.add_point(name, newpos)",
	"params": [
		{
			"directive": "param",
			"text": "name\tstring\tPlayer name.",
			"name": "name",
			"type": "string",
			"description": "Player name."
		},
		{
			"directive": "param",
			"text": "pos\tvector\tThe position to include.",
			"name": "pos",
			"type": "vector",
			"description": "The position to include."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "void",
		"type": "void"
	},
	"examples": [],
	"name_full": "worldeditadditions.selection.add_point",
	"filename": "worldeditadditions/lib/selection/selection.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/selection/selection.lua#L18-L23"
}

--- Checks if a string is a valid axis.
-- @param	str	string	String to check (be sure to remove any + or -).
-- @param	hv	bool	Include "h" (general horizontal) and "v" (general vertical).
-- @return	bool	If string is a valid axis then true.
function selection.check_axis(str,hv)

{
	"type": "function",
	"internal": false,
	"description": "Checks if a string is a valid axis.",
	"directives": [
		{
			"directive": "param",
			"text": "str\tstring\tString to check (be sure to remove any + or -).",
			"name": "str",
			"type": "string",
			"description": "String to check (be sure to remove any + or -)."
		},
		{
			"directive": "param",
			"text": "hv\tbool\tInclude \"h\" (general horizontal) and \"v\" (general vertical).",
			"name": "hv",
			"type": "bool",
			"description": "Include \"h\" (general horizontal) and \"v\" (general vertical)."
		},
		{
			"directive": "returns",
			"text": "bool\tIf string is a valid axis then true.",
			"type": "bool",
			"description": "If string is a valid axis then true."
		}
	],
	"line": 81,
	"namespace": "worldeditadditions.selection",
	"line_last": 85,
	"name": "check_axis",
	"instanced": false,
	"args": [
		"str",
		"hv"
	],
	"text": "--- Checks if a string is a valid axis.\n-- @param\tstr\tstring\tString to check (be sure to remove any + or -).\n-- @param\thv\tbool\tInclude \"h\" (general horizontal) and \"v\" (general vertical).\n-- @return\tbool\tIf string is a valid axis then true.\nfunction selection.check_axis(str,hv)",
	"params": [
		{
			"directive": "param",
			"text": "str\tstring\tString to check (be sure to remove any + or -).",
			"name": "str",
			"type": "string",
			"description": "String to check (be sure to remove any + or -)."
		},
		{
			"directive": "param",
			"text": "hv\tbool\tInclude \"h\" (general horizontal) and \"v\" (general vertical).",
			"name": "hv",
			"type": "bool",
			"description": "Include \"h\" (general horizontal) and \"v\" (general vertical)."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\tIf string is a valid axis then true.",
		"type": "bool",
		"description": "If string is a valid axis then true."
	},
	"examples": [],
	"name_full": "worldeditadditions.selection.check_axis",
	"filename": "worldeditadditions/lib/selection/selection.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/selection/selection.lua#L82-L86"
}

--- Checks if a string is a valid dir.
-- @param	str	string	String to check (be sure to remove any + or -).
-- @return	bool	If string is a valid dir then true.
function selection.check_dir(str)

{
	"type": "function",
	"internal": false,
	"description": "Checks if a string is a valid dir.",
	"directives": [
		{
			"directive": "param",
			"text": "str\tstring\tString to check (be sure to remove any + or -).",
			"name": "str",
			"type": "string",
			"description": "String to check (be sure to remove any + or -)."
		},
		{
			"directive": "returns",
			"text": "bool\tIf string is a valid dir then true.",
			"type": "bool",
			"description": "If string is a valid dir then true."
		}
	],
	"line": 93,
	"namespace": "worldeditadditions.selection",
	"line_last": 96,
	"name": "check_dir",
	"instanced": false,
	"args": [
		"str"
	],
	"text": "--- Checks if a string is a valid dir.\n-- @param\tstr\tstring\tString to check (be sure to remove any + or -).\n-- @return\tbool\tIf string is a valid dir then true.\nfunction selection.check_dir(str)",
	"params": [
		{
			"directive": "param",
			"text": "str\tstring\tString to check (be sure to remove any + or -).",
			"name": "str",
			"type": "string",
			"description": "String to check (be sure to remove any + or -)."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\tIf string is a valid dir then true.",
		"type": "bool",
		"description": "If string is a valid dir then true."
	},
	"examples": [],
	"name_full": "worldeditadditions.selection.check_dir",
	"filename": "worldeditadditions/lib/selection/selection.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/selection/selection.lua#L94-L97"
}

--- Clears current selection, *but only pos1 and pos2!
-- @param	name	string	Player name.
-- @returns	void
function selection.clear_points(name)

{
	"type": "function",
	"internal": false,
	"description": "Clears current selection, *but only pos1 and pos2!",
	"directives": [
		{
			"directive": "param",
			"text": "name\tstring\tPlayer name.",
			"name": "name",
			"type": "string",
			"description": "Player name."
		},
		{
			"directive": "returns",
			"text": "void",
			"type": "void"
		}
	],
	"line": 71,
	"namespace": "worldeditadditions.selection",
	"line_last": 74,
	"name": "clear_points",
	"instanced": false,
	"args": [
		"name"
	],
	"text": "--- Clears current selection, *but only pos1 and pos2!\n-- @param\tname\tstring\tPlayer name.\n-- @returns\tvoid\nfunction selection.clear_points(name)",
	"params": [
		{
			"directive": "param",
			"text": "name\tstring\tPlayer name.",
			"name": "name",
			"type": "string",
			"description": "Player name."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "void",
		"type": "void"
	},
	"examples": [],
	"name_full": "worldeditadditions.selection.clear_points",
	"filename": "worldeditadditions/lib/selection/selection.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions/lib/selection/selection.lua#L72-L75"
}

--- Add a new listener to the given named event.
-- @param	this		EventEmitter	The EventEmitter instance to add the listener to.
-- @param	event_name	string			The name of the event to listen on.
-- @param	func		function		The callback function to call when the event is emitted. Will be passed a single argument - the object passed as the second argument to .emit().
-- @returns	number		The number of listeners attached to that event.
function EventEmitter.addEventListener(this, event_name, func)

{
	"type": "function",
	"internal": false,
	"description": "Add a new listener to the given named event.",
	"directives": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to add the listener to.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to add the listener to."
		},
		{
			"directive": "param",
			"text": "event_name\tstring\t\t\tThe name of the event to listen on.",
			"name": "event_name",
			"type": "string",
			"description": "The name of the event to listen on."
		},
		{
			"directive": "param",
			"text": "func\t\tfunction\t\tThe callback function to call when the event is emitted. Will be passed a single argument - the object passed as the second argument to .emit().",
			"name": "func",
			"type": "function",
			"description": "The callback function to call when the event is emitted. Will be passed a single argument - the object passed as the second argument to .emit()."
		},
		{
			"directive": "returns",
			"text": "number\t\tThe number of listeners attached to that event.",
			"type": "number",
			"description": "The number of listeners attached to that event."
		}
	],
	"line": 18,
	"namespace": "worldeditadditions_core.EventEmitter",
	"line_last": 23,
	"name": "addEventListener",
	"instanced": false,
	"args": [
		"this",
		"event_name",
		"func"
	],
	"text": "--- Add a new listener to the given named event.\n-- @param\tthis\t\tEventEmitter\tThe EventEmitter instance to add the listener to.\n-- @param\tevent_name\tstring\t\t\tThe name of the event to listen on.\n-- @param\tfunc\t\tfunction\t\tThe callback function to call when the event is emitted. Will be passed a single argument - the object passed as the second argument to .emit().\n-- @returns\tnumber\t\tThe number of listeners attached to that event.\nfunction EventEmitter.addEventListener(this, event_name, func)",
	"params": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to add the listener to.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to add the listener to."
		},
		{
			"directive": "param",
			"text": "event_name\tstring\t\t\tThe name of the event to listen on.",
			"name": "event_name",
			"type": "string",
			"description": "The name of the event to listen on."
		},
		{
			"directive": "param",
			"text": "func\t\tfunction\t\tThe callback function to call when the event is emitted. Will be passed a single argument - the object passed as the second argument to .emit().",
			"name": "func",
			"type": "function",
			"description": "The callback function to call when the event is emitted. Will be passed a single argument - the object passed as the second argument to .emit()."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "number\t\tThe number of listeners attached to that event.",
		"type": "number",
		"description": "The number of listeners attached to that event."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.EventEmitter.addEventListener",
	"filename": "worldeditadditions_core/utils/EventEmitter.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/EventEmitter.lua#L19-L24"
}

--- Clear all listeners from a given event name.
-- @param	this		EventEmitter	The EventEmitter instance to clear listeners from.
-- @param	event_name	string			The name of the event to clear the listeners from.
function EventEmitter.clear(this, event_name)

{
	"type": "function",
	"internal": false,
	"description": "Clear all listeners from a given event name.",
	"directives": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to clear listeners from.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to clear listeners from."
		},
		{
			"directive": "param",
			"text": "event_name\tstring\t\t\tThe name of the event to clear the listeners from.",
			"name": "event_name",
			"type": "string",
			"description": "The name of the event to clear the listeners from."
		}
	],
	"line": 73,
	"namespace": "worldeditadditions_core.EventEmitter",
	"line_last": 76,
	"name": "clear",
	"instanced": false,
	"args": [
		"this",
		"event_name"
	],
	"text": "--- Clear all listeners from a given event name.\n-- @param\tthis\t\tEventEmitter\tThe EventEmitter instance to clear listeners from.\n-- @param\tevent_name\tstring\t\t\tThe name of the event to clear the listeners from.\nfunction EventEmitter.clear(this, event_name)",
	"params": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to clear listeners from.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to clear listeners from."
		},
		{
			"directive": "param",
			"text": "event_name\tstring\t\t\tThe name of the event to clear the listeners from.",
			"name": "event_name",
			"type": "string",
			"description": "The name of the event to clear the listeners from."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.EventEmitter.clear",
	"filename": "worldeditadditions_core/utils/EventEmitter.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/EventEmitter.lua#L74-L77"
}

--- Clear all listeners.
-- @param	this		EventEmitter	The EventEmitter instance to clear listeners from.
function EventEmitter.clear_all(this, event_name)

{
	"type": "function",
	"internal": false,
	"description": "Clear all listeners.",
	"directives": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to clear listeners from.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to clear listeners from."
		}
	],
	"line": 80,
	"namespace": "worldeditadditions_core.EventEmitter",
	"line_last": 82,
	"name": "clear_all",
	"instanced": false,
	"args": [
		"this",
		"event_name"
	],
	"text": "--- Clear all listeners.\n-- @param\tthis\t\tEventEmitter\tThe EventEmitter instance to clear listeners from.\nfunction EventEmitter.clear_all(this, event_name)",
	"params": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to clear listeners from.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to clear listeners from."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.EventEmitter.clear_all",
	"filename": "worldeditadditions_core/utils/EventEmitter.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/EventEmitter.lua#L81-L83"
}

--- Emit an event.
-- @param	this		EventEmitter	The EventEmitter instance to emit the event from.
-- @param	event_name	string			The name of the event to emit.
-- @param	args		table|any		The argument(s) to pass to listener functions. It is strongly advised you pass a table here.
function EventEmitter.emit(this, event_name, args)

{
	"type": "function",
	"internal": false,
	"description": "Emit an event.",
	"directives": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to emit the event from.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to emit the event from."
		},
		{
			"directive": "param",
			"text": "event_name\tstring\t\t\tThe name of the event to emit.",
			"name": "event_name",
			"type": "string",
			"description": "The name of the event to emit."
		},
		{
			"directive": "param",
			"text": "args\t\ttable|any\t\tThe argument(s) to pass to listener functions. It is strongly advised you pass a table here.",
			"name": "args",
			"type": "table|any",
			"description": "The argument(s) to pass to listener functions. It is strongly advised you pass a table here."
		}
	],
	"line": 55,
	"namespace": "worldeditadditions_core.EventEmitter",
	"line_last": 59,
	"name": "emit",
	"instanced": false,
	"args": [
		"this",
		"event_name",
		"args"
	],
	"text": "--- Emit an event.\n-- @param\tthis\t\tEventEmitter\tThe EventEmitter instance to emit the event from.\n-- @param\tevent_name\tstring\t\t\tThe name of the event to emit.\n-- @param\targs\t\ttable|any\t\tThe argument(s) to pass to listener functions. It is strongly advised you pass a table here.\nfunction EventEmitter.emit(this, event_name, args)",
	"params": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to emit the event from.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to emit the event from."
		},
		{
			"directive": "param",
			"text": "event_name\tstring\t\t\tThe name of the event to emit.",
			"name": "event_name",
			"type": "string",
			"description": "The name of the event to emit."
		},
		{
			"directive": "param",
			"text": "args\t\ttable|any\t\tThe argument(s) to pass to listener functions. It is strongly advised you pass a table here.",
			"name": "args",
			"type": "table|any",
			"description": "The argument(s) to pass to listener functions. It is strongly advised you pass a table here."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.EventEmitter.emit",
	"filename": "worldeditadditions_core/utils/EventEmitter.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/EventEmitter.lua#L56-L60"
}

--- Create a new event emitter.
-- @param	tbl	table|nil	Optional. A table to base the new EventEmitter object on. EventEmitter will attach ann instance of itself to this object. The 'events' property on the object MUST NOT be set. IT WILL BE OVERWRITTEN!
-- @returns	table	The new EventEmitter object. If a table is passed in, a new table is NOT created.
function EventEmitter.new(tbl)

{
	"type": "function",
	"internal": false,
	"description": "Create a new event emitter.",
	"directives": [
		{
			"directive": "param",
			"text": "tbl\ttable|nil\tOptional. A table to base the new EventEmitter object on. EventEmitter will attach ann instance of itself to this object. The 'events' property on the object MUST NOT be set. IT WILL BE OVERWRITTEN!",
			"name": "tbl",
			"type": "table|nil",
			"description": "Optional. A table to base the new EventEmitter object on. EventEmitter will attach ann instance of itself to this object. The 'events' property on the object MUST NOT be set. IT WILL BE OVERWRITTEN!"
		},
		{
			"directive": "returns",
			"text": "table\tThe new EventEmitter object. If a table is passed in, a new table is NOT created.",
			"type": "table",
			"description": "The new EventEmitter object. If a table is passed in, a new table is NOT created."
		}
	],
	"line": 7,
	"namespace": "worldeditadditions_core.EventEmitter",
	"line_last": 10,
	"name": "new",
	"instanced": false,
	"args": [
		"tbl"
	],
	"text": "--- Create a new event emitter.\n-- @param\ttbl\ttable|nil\tOptional. A table to base the new EventEmitter object on. EventEmitter will attach ann instance of itself to this object. The 'events' property on the object MUST NOT be set. IT WILL BE OVERWRITTEN!\n-- @returns\ttable\tThe new EventEmitter object. If a table is passed in, a new table is NOT created.\nfunction EventEmitter.new(tbl)",
	"params": [
		{
			"directive": "param",
			"text": "tbl\ttable|nil\tOptional. A table to base the new EventEmitter object on. EventEmitter will attach ann instance of itself to this object. The 'events' property on the object MUST NOT be set. IT WILL BE OVERWRITTEN!",
			"name": "tbl",
			"type": "table|nil",
			"description": "Optional. A table to base the new EventEmitter object on. EventEmitter will attach ann instance of itself to this object. The 'events' property on the object MUST NOT be set. IT WILL BE OVERWRITTEN!"
		}
	],
	"returns": {
		"directive": "returns",
		"text": "table\tThe new EventEmitter object. If a table is passed in, a new table is NOT created.",
		"type": "table",
		"description": "The new EventEmitter object. If a table is passed in, a new table is NOT created."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.EventEmitter.new",
	"filename": "worldeditadditions_core/utils/EventEmitter.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/EventEmitter.lua#L8-L11"
}

--- Remove an existing listener from the given named event.
-- @param	this		EventEmitter	The EventEmitter instance to remove the listener from.
-- @param	event_name	string			The name of the event to remove from.
-- @param	func		function		The callback function to remove from the list of listeners for the given named event.
-- @return	bool		Whether it was actually removed or not. False means it failed to find the given listener function.
function EventEmitter.removeEventListener(this, event_name, func)

{
	"type": "function",
	"internal": false,
	"description": "Remove an existing listener from the given named event.",
	"directives": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to remove the listener from.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to remove the listener from."
		},
		{
			"directive": "param",
			"text": "event_name\tstring\t\t\tThe name of the event to remove from.",
			"name": "event_name",
			"type": "string",
			"description": "The name of the event to remove from."
		},
		{
			"directive": "param",
			"text": "func\t\tfunction\t\tThe callback function to remove from the list of listeners for the given named event.",
			"name": "func",
			"type": "function",
			"description": "The callback function to remove from the list of listeners for the given named event."
		},
		{
			"directive": "returns",
			"text": "bool\t\tWhether it was actually removed or not. False means it failed to find the given listener function.",
			"type": "bool",
			"description": "Whether it was actually removed or not. False means it failed to find the given listener function."
		}
	],
	"line": 36,
	"namespace": "worldeditadditions_core.EventEmitter",
	"line_last": 41,
	"name": "removeEventListener",
	"instanced": false,
	"args": [
		"this",
		"event_name",
		"func"
	],
	"text": "--- Remove an existing listener from the given named event.\n-- @param\tthis\t\tEventEmitter\tThe EventEmitter instance to remove the listener from.\n-- @param\tevent_name\tstring\t\t\tThe name of the event to remove from.\n-- @param\tfunc\t\tfunction\t\tThe callback function to remove from the list of listeners for the given named event.\n-- @return\tbool\t\tWhether it was actually removed or not. False means it failed to find the given listener function.\nfunction EventEmitter.removeEventListener(this, event_name, func)",
	"params": [
		{
			"directive": "param",
			"text": "this\t\tEventEmitter\tThe EventEmitter instance to remove the listener from.",
			"name": "this",
			"type": "EventEmitter",
			"description": "The EventEmitter instance to remove the listener from."
		},
		{
			"directive": "param",
			"text": "event_name\tstring\t\t\tThe name of the event to remove from.",
			"name": "event_name",
			"type": "string",
			"description": "The name of the event to remove from."
		},
		{
			"directive": "param",
			"text": "func\t\tfunction\t\tThe callback function to remove from the list of listeners for the given named event.",
			"name": "func",
			"type": "function",
			"description": "The callback function to remove from the list of listeners for the given named event."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\t\tWhether it was actually removed or not. False means it failed to find the given listener function.",
		"type": "bool",
		"description": "Whether it was actually removed or not. False means it failed to find the given listener function."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.EventEmitter.removeEventListener",
	"filename": "worldeditadditions_core/utils/EventEmitter.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/EventEmitter.lua#L37-L42"
}

--- Determines whether this face is equal to another face or not.
-- @param	a	Face	The first face to compare.
-- @param	b	Face	The second face to compare.
-- @returns	bool		Whether the 2 faces are equal or not.
function Face.equal(a, b)

{
	"type": "function",
	"internal": false,
	"description": "Determines whether this face is equal to another face or not.",
	"directives": [
		{
			"directive": "param",
			"text": "a\tFace\tThe first face to compare.",
			"name": "a",
			"type": "Face",
			"description": "The first face to compare."
		},
		{
			"directive": "param",
			"text": "b\tFace\tThe second face to compare.",
			"name": "b",
			"type": "Face",
			"description": "The second face to compare."
		},
		{
			"directive": "returns",
			"text": "bool\t\tWhether the 2 faces are equal or not.",
			"type": "bool",
			"description": "Whether the 2 faces are equal or not."
		}
	],
	"line": 23,
	"namespace": "worldeditadditions_core.Face",
	"line_last": 27,
	"name": "equal",
	"instanced": false,
	"args": [
		"a",
		"b"
	],
	"text": "--- Determines whether this face is equal to another face or not.\n-- @param\ta\tFace\tThe first face to compare.\n-- @param\tb\tFace\tThe second face to compare.\n-- @returns\tbool\t\tWhether the 2 faces are equal or not.\nfunction Face.equal(a, b)",
	"params": [
		{
			"directive": "param",
			"text": "a\tFace\tThe first face to compare.",
			"name": "a",
			"type": "Face",
			"description": "The first face to compare."
		},
		{
			"directive": "param",
			"text": "b\tFace\tThe second face to compare.",
			"name": "b",
			"type": "Face",
			"description": "The second face to compare."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\t\tWhether the 2 faces are equal or not.",
		"type": "bool",
		"description": "Whether the 2 faces are equal or not."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Face.equal",
	"filename": "worldeditadditions_core/utils/mesh.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/mesh.lua#L24-L28"
}

--- Creates a new face from a list of vertices.
-- The list of vertices should be anti-clockwise.
-- @param	vertices	Vector3[]	A list of Vector3 vertices that define the face.
function Face.new(vertices)

{
	"type": "function",
	"internal": false,
	"description": "Creates a new face from a list of vertices.\nThe list of vertices should be anti-clockwise.",
	"directives": [
		{
			"directive": "param",
			"text": "vertices\tVector3[]\tA list of Vector3 vertices that define the face.",
			"name": "vertices",
			"type": "Vector3[]",
			"description": "A list of Vector3 vertices that define the face."
		}
	],
	"line": 14,
	"namespace": "worldeditadditions_core.Face",
	"line_last": 17,
	"name": "new",
	"instanced": false,
	"args": [
		"vertices"
	],
	"text": "--- Creates a new face from a list of vertices.\n-- The list of vertices should be anti-clockwise.\n-- @param\tvertices\tVector3[]\tA list of Vector3 vertices that define the face.\nfunction Face.new(vertices)",
	"params": [
		{
			"directive": "param",
			"text": "vertices\tVector3[]\tA list of Vector3 vertices that define the face.",
			"name": "vertices",
			"type": "Vector3[]",
			"description": "A list of Vector3 vertices that define the face."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.Face.new",
	"filename": "worldeditadditions_core/utils/mesh.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/mesh.lua#L15-L18"
}

--- Gets the value associated with the given key.
-- @param	key		string	The key to retrieve the value for.
-- @returns	any|nil	The value associated with the given key, or nil if it doesn't exist in this cache.
function LRU:get(key)

{
	"type": "function",
	"internal": false,
	"description": "Gets the value associated with the given key.",
	"directives": [
		{
			"directive": "param",
			"text": "key\t\tstring\tThe key to retrieve the value for.",
			"name": "key",
			"type": "string",
			"description": "The key to retrieve the value for."
		},
		{
			"directive": "returns",
			"text": "any|nil\tThe value associated with the given key, or nil if it doesn't exist in this cache.",
			"type": "any|nil",
			"description": "The value associated with the given key, or nil if it doesn't exist in this cache."
		}
	],
	"line": 36,
	"namespace": "worldeditadditions_core.LRU",
	"line_last": 39,
	"name": "get",
	"instanced": true,
	"args": [
		"key"
	],
	"text": "--- Gets the value associated with the given key.\n-- @param\tkey\t\tstring\tThe key to retrieve the value for.\n-- @returns\tany|nil\tThe value associated with the given key, or nil if it doesn't exist in this cache.\nfunction LRU:get(key)",
	"params": [
		{
			"directive": "param",
			"text": "key\t\tstring\tThe key to retrieve the value for.",
			"name": "key",
			"type": "string",
			"description": "The key to retrieve the value for."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "any|nil\tThe value associated with the given key, or nil if it doesn't exist in this cache.",
		"type": "any|nil",
		"description": "The value associated with the given key, or nil if it doesn't exist in this cache."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.LRU.get",
	"filename": "worldeditadditions_core/utils/lru.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/lru.lua#L37-L40"
}

--- Determines whether the given key is present in this cache object.
-- Does NOT update the most recently used status of said key.
-- @param	key		string	The key to check.
-- @returns	bool	Whether the given key exists in the cache or not.
function LRU:has(key)

{
	"type": "function",
	"internal": false,
	"description": "Determines whether the given key is present in this cache object.\nDoes NOT update the most recently used status of said key.",
	"directives": [
		{
			"directive": "param",
			"text": "key\t\tstring\tThe key to check.",
			"name": "key",
			"type": "string",
			"description": "The key to check."
		},
		{
			"directive": "returns",
			"text": "bool\tWhether the given key exists in the cache or not.",
			"type": "bool",
			"description": "Whether the given key exists in the cache or not."
		}
	],
	"line": 28,
	"namespace": "worldeditadditions_core.LRU",
	"line_last": 32,
	"name": "has",
	"instanced": true,
	"args": [
		"key"
	],
	"text": "--- Determines whether the given key is present in this cache object.\n-- Does NOT update the most recently used status of said key.\n-- @param\tkey\t\tstring\tThe key to check.\n-- @returns\tbool\tWhether the given key exists in the cache or not.\nfunction LRU:has(key)",
	"params": [
		{
			"directive": "param",
			"text": "key\t\tstring\tThe key to check.",
			"name": "key",
			"type": "string",
			"description": "The key to check."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\tWhether the given key exists in the cache or not.",
		"type": "bool",
		"description": "Whether the given key exists in the cache or not."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.LRU.has",
	"filename": "worldeditadditions_core/utils/lru.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/lru.lua#L29-L33"
}

--- Creates a new LRU cache.
-- Optimal sizes: 8, 16, 32, 64 or any value above
-- @param	max_size=32		number	The maximum number of items to store in the cache.
-- @returns	LRU				A new LRU cache.
function LRU.new(max_size)

{
	"type": "function",
	"internal": false,
	"description": "Creates a new LRU cache.\nOptimal sizes: 8, 16, 32, 64 or any value above",
	"directives": [
		{
			"directive": "param",
			"text": "max_size=32\t\tnumber\tThe maximum number of items to store in the cache.",
			"name": "max_size",
			"type": "number",
			"description": "The maximum number of items to store in the cache.",
			"default_value": "32"
		},
		{
			"directive": "returns",
			"text": "LRU\t\t\t\tA new LRU cache.",
			"type": "LRU",
			"description": "A new LRU cache."
		}
	],
	"line": 12,
	"namespace": "worldeditadditions_core.LRU",
	"line_last": 16,
	"name": "new",
	"instanced": false,
	"args": [
		"max_size"
	],
	"text": "--- Creates a new LRU cache.\n-- Optimal sizes: 8, 16, 32, 64 or any value above\n-- @param\tmax_size=32\t\tnumber\tThe maximum number of items to store in the cache.\n-- @returns\tLRU\t\t\t\tA new LRU cache.\nfunction LRU.new(max_size)",
	"params": [
		{
			"directive": "param",
			"text": "max_size=32\t\tnumber\tThe maximum number of items to store in the cache.",
			"name": "max_size",
			"type": "number",
			"description": "The maximum number of items to store in the cache.",
			"default_value": "32"
		}
	],
	"returns": {
		"directive": "returns",
		"text": "LRU\t\t\t\tA new LRU cache.",
		"type": "LRU",
		"description": "A new LRU cache."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.LRU.new",
	"filename": "worldeditadditions_core/utils/lru.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/lru.lua#L13-L17"
}

--- Adds a given key-value pair to this cache.
-- Note that this might (or might not) result in the eviction of another item.
-- @param	key		string	The key of the item to add.
-- @param	value	any		The value to associate with the given key.
-- @returns nil
function LRU:set(key, value)

{
	"type": "function",
	"internal": false,
	"description": "Adds a given key-value pair to this cache.\nNote that this might (or might not) result in the eviction of another item.",
	"directives": [
		{
			"directive": "param",
			"text": "key\t\tstring\tThe key of the item to add.",
			"name": "key",
			"type": "string",
			"description": "The key of the item to add."
		},
		{
			"directive": "param",
			"text": "value\tany\t\tThe value to associate with the given key.",
			"name": "value",
			"type": "any",
			"description": "The value to associate with the given key."
		},
		{
			"directive": "returns",
			"text": "nil",
			"type": "nil"
		}
	],
	"line": 49,
	"namespace": "worldeditadditions_core.LRU",
	"line_last": 54,
	"name": "set",
	"instanced": true,
	"args": [
		"key",
		"value"
	],
	"text": "--- Adds a given key-value pair to this cache.\n-- Note that this might (or might not) result in the eviction of another item.\n-- @param\tkey\t\tstring\tThe key of the item to add.\n-- @param\tvalue\tany\t\tThe value to associate with the given key.\n-- @returns nil\nfunction LRU:set(key, value)",
	"params": [
		{
			"directive": "param",
			"text": "key\t\tstring\tThe key of the item to add.",
			"name": "key",
			"type": "string",
			"description": "The key of the item to add."
		},
		{
			"directive": "param",
			"text": "value\tany\t\tThe value to associate with the given key.",
			"name": "value",
			"type": "any",
			"description": "The value to associate with the given key."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "nil",
		"type": "nil"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.LRU.set",
	"filename": "worldeditadditions_core/utils/lru.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/lru.lua#L50-L55"
}

--- Adds a face to this mesh.
-- @param	self	Mesh	The mesh instance to operate on.
-- @param	face	Face	The face to add.
-- @returns	void
function Mesh.add_face(self, face)

{
	"type": "function",
	"internal": false,
	"description": "Adds a face to this mesh.",
	"directives": [
		{
			"directive": "param",
			"text": "self\tMesh\tThe mesh instance to operate on.",
			"name": "self",
			"type": "Mesh",
			"description": "The mesh instance to operate on."
		},
		{
			"directive": "param",
			"text": "face\tFace\tThe face to add.",
			"name": "face",
			"type": "Face",
			"description": "The face to add."
		},
		{
			"directive": "returns",
			"text": "void",
			"type": "void"
		}
	],
	"line": 55,
	"namespace": "worldeditadditions_core.Mesh",
	"line_last": 59,
	"name": "add_face",
	"instanced": false,
	"args": [
		"self",
		"face"
	],
	"text": "--- Adds a face to this mesh.\n-- @param\tself\tMesh\tThe mesh instance to operate on.\n-- @param\tface\tFace\tThe face to add.\n-- @returns\tvoid\nfunction Mesh.add_face(self, face)",
	"params": [
		{
			"directive": "param",
			"text": "self\tMesh\tThe mesh instance to operate on.",
			"name": "self",
			"type": "Mesh",
			"description": "The mesh instance to operate on."
		},
		{
			"directive": "param",
			"text": "face\tFace\tThe face to add.",
			"name": "face",
			"type": "Face",
			"description": "The face to add."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "void",
		"type": "void"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Mesh.add_face",
	"filename": "worldeditadditions_core/utils/mesh.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/mesh.lua#L56-L60"
}

--- Deduplicate the list of faces in this Mesh.
-- Removes all faces that are exactly equal to one another. This reduces the
-- filesize.
-- @returns	number	The number of faces removed.
function Mesh.dedupe(self)

{
	"type": "function",
	"internal": false,
	"description": "Deduplicate the list of faces in this Mesh.\nRemoves all faces that are exactly equal to one another. This reduces the\nfilesize.",
	"directives": [
		{
			"directive": "returns",
			"text": "number\tThe number of faces removed.",
			"type": "number",
			"description": "The number of faces removed."
		}
	],
	"line": 63,
	"namespace": "worldeditadditions_core.Mesh",
	"line_last": 67,
	"name": "dedupe",
	"instanced": false,
	"args": [
		"self"
	],
	"text": "--- Deduplicate the list of faces in this Mesh.\n-- Removes all faces that are exactly equal to one another. This reduces the\n-- filesize.\n-- @returns\tnumber\tThe number of faces removed.\nfunction Mesh.dedupe(self)",
	"params": [],
	"returns": {
		"directive": "returns",
		"text": "number\tThe number of faces removed.",
		"type": "number",
		"description": "The number of faces removed."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Mesh.dedupe",
	"filename": "worldeditadditions_core/utils/mesh.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/mesh.lua#L64-L68"
}

--- Creates a new empty mesh object container.
-- @returns	Mesh
function Mesh.new()

{
	"type": "function",
	"internal": false,
	"description": "Creates a new empty mesh object container.",
	"directives": [
		{
			"directive": "returns",
			"text": "Mesh",
			"type": "Mesh"
		}
	],
	"line": 48,
	"namespace": "worldeditadditions_core.Mesh",
	"line_last": 50,
	"name": "new",
	"instanced": false,
	"args": [
		""
	],
	"text": "--- Creates a new empty mesh object container.\n-- @returns\tMesh\nfunction Mesh.new()",
	"params": [],
	"returns": {
		"directive": "returns",
		"text": "Mesh",
		"type": "Mesh"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Mesh.new",
	"filename": "worldeditadditions_core/utils/mesh.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/mesh.lua#L49-L51"
}

--- Parses a list of node names, accounting for special keywords and group names.
-- @param	nodelist	string[]	The list of nodes to parse.
-- @returns	bool,string|table<string|function|number>	A success bool (true = success), followed by eitheran error string if success == false or the parsed nodelist if success == true.
-- 
-- Different data types in the parsed nodelist mean different things:
-- 
-- - **string:** The name of a group
-- - **function:** A special function to call with the node id to match against as the first and only argument.
-- - **number:** The id of the node to check against.
local function __parse_nodelist(nodelist)

{
	"type": "function",
	"internal": false,
	"description": "Parses a list of node names, accounting for special keywords and group names.",
	"directives": [
		{
			"directive": "param",
			"text": "nodelist\tstring[]\tThe list of nodes to parse.",
			"name": "nodelist",
			"type": "string[]",
			"description": "The list of nodes to parse."
		},
		{
			"directive": "returns",
			"text": "bool,string|table<string|function|number>\tA success bool (true = success), followed by eitheran error string if success == false or the parsed nodelist if success == true.\n\nDifferent data types in the parsed nodelist mean different things:\n\n- **string:** The name of a group\n- **function:** A special function to call with the node id to match against as the first and only argument.\n- **number:** The id of the node to check against.",
			"type": "bool,string|table<string|function|number>",
			"description": "A success bool (true = success), followed by eitheran error string if success == false or the parsed nodelist if success == true.\n\nDifferent data types in the parsed nodelist mean different things:\n\n- **string:** The name of a group\n- **function:** A special function to call with the node id to match against as the first and only argument.\n- **number:** The id of the node to check against."
		}
	],
	"line": 19,
	"namespace": "worldeditadditions_core.NodeListMatcher",
	"line_last": 28,
	"name": "__parse_nodelist",
	"instanced": false,
	"args": [
		"nodelist"
	],
	"text": "--- Parses a list of node names, accounting for special keywords and group names.\n-- @param\tnodelist\tstring[]\tThe list of nodes to parse.\n-- @returns\tbool,string|table<string|function|number>\tA success bool (true = success), followed by eitheran error string if success == false or the parsed nodelist if success == true.\n-- \n-- Different data types in the parsed nodelist mean different things:\n-- \n-- - **string:** The name of a group\n-- - **function:** A special function to call with the node id to match against as the first and only argument.\n-- - **number:** The id of the node to check against.\nlocal function __parse_nodelist(nodelist)",
	"params": [
		{
			"directive": "param",
			"text": "nodelist\tstring[]\tThe list of nodes to parse.",
			"name": "nodelist",
			"type": "string[]",
			"description": "The list of nodes to parse."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool,string|table<string|function|number>\tA success bool (true = success), followed by eitheran error string if success == false or the parsed nodelist if success == true.\n\nDifferent data types in the parsed nodelist mean different things:\n\n- **string:** The name of a group\n- **function:** A special function to call with the node id to match against as the first and only argument.\n- **number:** The id of the node to check against.",
		"type": "bool,string|table<string|function|number>",
		"description": "A success bool (true = success), followed by eitheran error string if success == false or the parsed nodelist if success == true.\n\nDifferent data types in the parsed nodelist mean different things:\n\n- **string:** The name of a group\n- **function:** A special function to call with the node id to match against as the first and only argument.\n- **number:** The id of the node to check against."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.NodeListMatcher.__parse_nodelist",
	"filename": "worldeditadditions_core/utils/NodeListMatcher.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/NodeListMatcher.lua#L20-L29"
}

--- Determines if the given node id has the given group name.
-- Caches the result for performance. You probably want NodeListMatcher:match_id(node_id).
-- @param	matcher		NodeListMatcher		The NodeListMatcher instance to use to make the query.
-- @param	node_id		number				The numerical id of the node to check.
-- @param	group_name	string				The name of the group to check if the given node id has.
-- @returns	bool		True if the given node id belongs to the specified group, and false if it does not.
function NodeListMatcher.match_group(matcher, node_id, group_name)

{
	"type": "function",
	"internal": false,
	"description": "Determines if the given node id has the given group name.\nCaches the result for performance. You probably want NodeListMatcher:match_id(node_id).",
	"directives": [
		{
			"directive": "param",
			"text": "matcher\t\tNodeListMatcher\t\tThe NodeListMatcher instance to use to make the query.",
			"name": "matcher",
			"type": "NodeListMatcher",
			"description": "The NodeListMatcher instance to use to make the query."
		},
		{
			"directive": "param",
			"text": "node_id\t\tnumber\t\t\t\tThe numerical id of the node to check.",
			"name": "node_id",
			"type": "number",
			"description": "The numerical id of the node to check."
		},
		{
			"directive": "param",
			"text": "group_name\tstring\t\t\t\tThe name of the group to check if the given node id has.",
			"name": "group_name",
			"type": "string",
			"description": "The name of the group to check if the given node id has."
		},
		{
			"directive": "returns",
			"text": "bool\t\tTrue if the given node id belongs to the specified group, and false if it does not.",
			"type": "bool",
			"description": "True if the given node id belongs to the specified group, and false if it does not."
		}
	],
	"line": 99,
	"namespace": "worldeditadditions_core.NodeListMatcher",
	"line_last": 105,
	"name": "match_group",
	"instanced": false,
	"args": [
		"matcher",
		"node_id",
		"group_name"
	],
	"text": "--- Determines if the given node id has the given group name.\n-- Caches the result for performance. You probably want NodeListMatcher:match_id(node_id).\n-- @param\tmatcher\t\tNodeListMatcher\t\tThe NodeListMatcher instance to use to make the query.\n-- @param\tnode_id\t\tnumber\t\t\t\tThe numerical id of the node to check.\n-- @param\tgroup_name\tstring\t\t\t\tThe name of the group to check if the given node id has.\n-- @returns\tbool\t\tTrue if the given node id belongs to the specified group, and false if it does not.\nfunction NodeListMatcher.match_group(matcher, node_id, group_name)",
	"params": [
		{
			"directive": "param",
			"text": "matcher\t\tNodeListMatcher\t\tThe NodeListMatcher instance to use to make the query.",
			"name": "matcher",
			"type": "NodeListMatcher",
			"description": "The NodeListMatcher instance to use to make the query."
		},
		{
			"directive": "param",
			"text": "node_id\t\tnumber\t\t\t\tThe numerical id of the node to check.",
			"name": "node_id",
			"type": "number",
			"description": "The numerical id of the node to check."
		},
		{
			"directive": "param",
			"text": "group_name\tstring\t\t\t\tThe name of the group to check if the given node id has.",
			"name": "group_name",
			"type": "string",
			"description": "The name of the group to check if the given node id has."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\t\tTrue if the given node id belongs to the specified group, and false if it does not.",
		"type": "bool",
		"description": "True if the given node id belongs to the specified group, and false if it does not."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.NodeListMatcher.match_group",
	"filename": "worldeditadditions_core/utils/NodeListMatcher.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/NodeListMatcher.lua#L100-L106"
}

--- Matches the given node id against the nodelist provided at the instantiation of this NodeListMatcher instance.
-- Returns true if the given node_id matches against any one of the items in the nodelist. In other words, performs a logical OR operation.
-- 
-- We use the term 'item' and not 'node' here since not all items in the nodelist are nodes: nodelists support special keywords such as 'liquidlike' and 'airlike', as well as group names (prefixed with an at sign @).
-- @param	matcher		NodeListMatcher		The NodeListMatcher instance to query against. Use some_matcher:match_id(node_id) to avoid specifying this manually (note the colon : and not a dot . there).
-- @param	node_id		number				The numerical id of the node to match against the internal nodelist.
-- @returns	bool		True if the given node id matches against any of the items in the nodelist.
function NodeListMatcher.match_id(matcher, node_id)

{
	"type": "function",
	"internal": false,
	"description": "Matches the given node id against the nodelist provided at the instantiation of this NodeListMatcher instance.\nReturns true if the given node_id matches against any one of the items in the nodelist. In other words, performs a logical OR operation.\n\nWe use the term 'item' and not 'node' here since not all items in the nodelist are nodes: nodelists support special keywords such as 'liquidlike' and 'airlike', as well as group names (prefixed with an at sign @).",
	"directives": [
		{
			"directive": "param",
			"text": "matcher\t\tNodeListMatcher\t\tThe NodeListMatcher instance to query against. Use some_matcher:match_id(node_id) to avoid specifying this manually (note the colon : and not a dot . there).",
			"name": "matcher",
			"type": "NodeListMatcher",
			"description": "The NodeListMatcher instance to query against. Use some_matcher:match_id(node_id) to avoid specifying this manually (note the colon : and not a dot . there)."
		},
		{
			"directive": "param",
			"text": "node_id\t\tnumber\t\t\t\tThe numerical id of the node to match against the internal nodelist.",
			"name": "node_id",
			"type": "number",
			"description": "The numerical id of the node to match against the internal nodelist."
		},
		{
			"directive": "returns",
			"text": "bool\t\tTrue if the given node id matches against any of the items in the nodelist.",
			"type": "bool",
			"description": "True if the given node id matches against any of the items in the nodelist."
		}
	],
	"line": 73,
	"namespace": "worldeditadditions_core.NodeListMatcher",
	"line_last": 80,
	"name": "match_id",
	"instanced": false,
	"args": [
		"matcher",
		"node_id"
	],
	"text": "--- Matches the given node id against the nodelist provided at the instantiation of this NodeListMatcher instance.\n-- Returns true if the given node_id matches against any one of the items in the nodelist. In other words, performs a logical OR operation.\n-- \n-- We use the term 'item' and not 'node' here since not all items in the nodelist are nodes: nodelists support special keywords such as 'liquidlike' and 'airlike', as well as group names (prefixed with an at sign @).\n-- @param\tmatcher\t\tNodeListMatcher\t\tThe NodeListMatcher instance to query against. Use some_matcher:match_id(node_id) to avoid specifying this manually (note the colon : and not a dot . there).\n-- @param\tnode_id\t\tnumber\t\t\t\tThe numerical id of the node to match against the internal nodelist.\n-- @returns\tbool\t\tTrue if the given node id matches against any of the items in the nodelist.\nfunction NodeListMatcher.match_id(matcher, node_id)",
	"params": [
		{
			"directive": "param",
			"text": "matcher\t\tNodeListMatcher\t\tThe NodeListMatcher instance to query against. Use some_matcher:match_id(node_id) to avoid specifying this manually (note the colon : and not a dot . there).",
			"name": "matcher",
			"type": "NodeListMatcher",
			"description": "The NodeListMatcher instance to query against. Use some_matcher:match_id(node_id) to avoid specifying this manually (note the colon : and not a dot . there)."
		},
		{
			"directive": "param",
			"text": "node_id\t\tnumber\t\t\t\tThe numerical id of the node to match against the internal nodelist.",
			"name": "node_id",
			"type": "number",
			"description": "The numerical id of the node to match against the internal nodelist."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\t\tTrue if the given node id matches against any of the items in the nodelist.",
		"type": "bool",
		"description": "True if the given node id matches against any of the items in the nodelist."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.NodeListMatcher.match_id",
	"filename": "worldeditadditions_core/utils/NodeListMatcher.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/NodeListMatcher.lua#L74-L81"
}

--- Creates a new NodeListMatcher instance with the given node list.
-- Once created, you probably want to call the :match_id(node_id) function.
-- @param	nodelist	string[]	The list of nodes to match against.
-- 
-- `airlike` and `liquidlike` are special keywords that instead check if a given node id behaves like air or a liquid respectively.
-- 
-- Node names prefixed with an at sign (@) are considered group names, and given node ids are checked for membership of the given group.
-- @returns	bool,string|NodeListMatcher			A success bool (true == success), and then either a string (if succes == false) or otherwise the newly created NodeListMatcher instance.
function NodeListMatcher.new(nodelist)

{
	"type": "function",
	"internal": false,
	"description": "Creates a new NodeListMatcher instance with the given node list.\nOnce created, you probably want to call the :match_id(node_id) function.",
	"directives": [
		{
			"directive": "param",
			"text": "nodelist\tstring[]\tThe list of nodes to match against.\n\n`airlike` and `liquidlike` are special keywords that instead check if a given node id behaves like air or a liquid respectively.\n\nNode names prefixed with an at sign (@) are considered group names, and given node ids are checked for membership of the given group.",
			"name": "nodelist",
			"type": "string[]",
			"description": "The list of nodes to match against.\n\n`airlike` and `liquidlike` are special keywords that instead check if a given node id behaves like air or a liquid respectively.\n\nNode names prefixed with an at sign (@) are considered group names, and given node ids are checked for membership of the given group."
		},
		{
			"directive": "returns",
			"text": "bool,string|NodeListMatcher\t\t\tA success bool (true == success), and then either a string (if succes == false) or otherwise the newly created NodeListMatcher instance.",
			"type": "bool,string|NodeListMatcher",
			"description": "A success bool (true == success), and then either a string (if succes == false) or otherwise the newly created NodeListMatcher instance."
		}
	],
	"line": 51,
	"namespace": "worldeditadditions_core.NodeListMatcher",
	"line_last": 59,
	"name": "new",
	"instanced": false,
	"args": [
		"nodelist"
	],
	"text": "--- Creates a new NodeListMatcher instance with the given node list.\n-- Once created, you probably want to call the :match_id(node_id) function.\n-- @param\tnodelist\tstring[]\tThe list of nodes to match against.\n-- \n-- `airlike` and `liquidlike` are special keywords that instead check if a given node id behaves like air or a liquid respectively.\n-- \n-- Node names prefixed with an at sign (@) are considered group names, and given node ids are checked for membership of the given group.\n-- @returns\tbool,string|NodeListMatcher\t\t\tA success bool (true == success), and then either a string (if succes == false) or otherwise the newly created NodeListMatcher instance.\nfunction NodeListMatcher.new(nodelist)",
	"params": [
		{
			"directive": "param",
			"text": "nodelist\tstring[]\tThe list of nodes to match against.\n\n`airlike` and `liquidlike` are special keywords that instead check if a given node id behaves like air or a liquid respectively.\n\nNode names prefixed with an at sign (@) are considered group names, and given node ids are checked for membership of the given group.",
			"name": "nodelist",
			"type": "string[]",
			"description": "The list of nodes to match against.\n\n`airlike` and `liquidlike` are special keywords that instead check if a given node id behaves like air or a liquid respectively.\n\nNode names prefixed with an at sign (@) are considered group names, and given node ids are checked for membership of the given group."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool,string|NodeListMatcher\t\t\tA success bool (true == success), and then either a string (if succes == false) or otherwise the newly created NodeListMatcher instance.",
		"type": "bool,string|NodeListMatcher",
		"description": "A success bool (true == success), and then either a string (if succes == false) or otherwise the newly created NodeListMatcher instance."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.NodeListMatcher.new",
	"filename": "worldeditadditions_core/utils/NodeListMatcher.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/NodeListMatcher.lua#L52-L60"
}

--- Send a custom notification.
-- @param	name	string		The name of the player to send the notification to.
-- @param	ntype	string		The type of notification.
-- @param	message	string		The message to send.
-- @param	colour	string?		Optional. The colour of the notification.
-- @param	message_coloured	boolean?	Optional. Whether the message should be coloured.
-- @return	boolean			True if all parameters are valid, false otherwise.
-- @example		Custom notification types
-- Notify.custom(name, "custom", "This one is magenta!", "#FF00FF", true)
-- Notify.custom(name, "custom", "This one is gold with white text!", "#FFC700")
function Notify.custom(name, ntype, message, colour, message_coloured)

{
	"type": "function",
	"internal": false,
	"description": "Send a custom notification.",
	"directives": [
		{
			"directive": "param",
			"text": "name\tstring\t\tThe name of the player to send the notification to.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to send the notification to."
		},
		{
			"directive": "param",
			"text": "ntype\tstring\t\tThe type of notification.",
			"name": "ntype",
			"type": "string",
			"description": "The type of notification."
		},
		{
			"directive": "param",
			"text": "message\tstring\t\tThe message to send.",
			"name": "message",
			"type": "string",
			"description": "The message to send."
		},
		{
			"directive": "param",
			"text": "colour\tstring?\t\tOptional. The colour of the notification.",
			"name": "colour",
			"type": "string?",
			"description": "Optional. The colour of the notification."
		},
		{
			"directive": "param",
			"text": "message_coloured\tboolean?\tOptional. Whether the message should be coloured.",
			"name": "message_coloured",
			"type": "boolean?",
			"description": "Optional. Whether the message should be coloured."
		},
		{
			"directive": "returns",
			"text": "boolean\t\t\tTrue if all parameters are valid, false otherwise.",
			"type": "boolean",
			"description": "True if all parameters are valid, false otherwise."
		},
		{
			"directive": "example",
			"text": "Custom notification types\nNotify.custom(name, \"custom\", \"This one is magenta!\", \"#FF00FF\", true)\nNotify.custom(name, \"custom\", \"This one is gold with white text!\", \"#FFC700\")",
			"description": "Custom notification types",
			"example": "Notify.custom(name, \"custom\", \"This one is magenta!\", \"#FF00FF\", true)\nNotify.custom(name, \"custom\", \"This one is gold with white text!\", \"#FFC700\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">custom</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">custom</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">This one is magenta!</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">#FF00FF</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#4D9375\">true</span><span style=\"color:#DBD7CAEE\">)</span></span>\n<span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">custom</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">custom</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">This one is gold with white text!</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">#FFC700</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"line": 82,
	"namespace": "worldeditadditions_core.notify",
	"line_last": 92,
	"name": "custom",
	"instanced": false,
	"args": [
		"name",
		"ntype",
		"message",
		"colour",
		"message_coloured"
	],
	"text": "--- Send a custom notification.\n-- @param\tname\tstring\t\tThe name of the player to send the notification to.\n-- @param\tntype\tstring\t\tThe type of notification.\n-- @param\tmessage\tstring\t\tThe message to send.\n-- @param\tcolour\tstring?\t\tOptional. The colour of the notification.\n-- @param\tmessage_coloured\tboolean?\tOptional. Whether the message should be coloured.\n-- @return\tboolean\t\t\tTrue if all parameters are valid, false otherwise.\n-- @example\t\tCustom notification types\n-- Notify.custom(name, \"custom\", \"This one is magenta!\", \"#FF00FF\", true)\n-- Notify.custom(name, \"custom\", \"This one is gold with white text!\", \"#FFC700\")\nfunction Notify.custom(name, ntype, message, colour, message_coloured)",
	"params": [
		{
			"directive": "param",
			"text": "name\tstring\t\tThe name of the player to send the notification to.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to send the notification to."
		},
		{
			"directive": "param",
			"text": "ntype\tstring\t\tThe type of notification.",
			"name": "ntype",
			"type": "string",
			"description": "The type of notification."
		},
		{
			"directive": "param",
			"text": "message\tstring\t\tThe message to send.",
			"name": "message",
			"type": "string",
			"description": "The message to send."
		},
		{
			"directive": "param",
			"text": "colour\tstring?\t\tOptional. The colour of the notification.",
			"name": "colour",
			"type": "string?",
			"description": "Optional. The colour of the notification."
		},
		{
			"directive": "param",
			"text": "message_coloured\tboolean?\tOptional. Whether the message should be coloured.",
			"name": "message_coloured",
			"type": "boolean?",
			"description": "Optional. Whether the message should be coloured."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "boolean\t\t\tTrue if all parameters are valid, false otherwise.",
		"type": "boolean",
		"description": "True if all parameters are valid, false otherwise."
	},
	"examples": [
		{
			"directive": "example",
			"text": "Custom notification types\nNotify.custom(name, \"custom\", \"This one is magenta!\", \"#FF00FF\", true)\nNotify.custom(name, \"custom\", \"This one is gold with white text!\", \"#FFC700\")",
			"description": "Custom notification types",
			"example": "Notify.custom(name, \"custom\", \"This one is magenta!\", \"#FF00FF\", true)\nNotify.custom(name, \"custom\", \"This one is gold with white text!\", \"#FFC700\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">custom</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">custom</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">This one is magenta!</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">#FF00FF</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#4D9375\">true</span><span style=\"color:#DBD7CAEE\">)</span></span>\n<span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">custom</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">custom</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">This one is gold with white text!</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">#FFC700</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"name_full": "worldeditadditions_core.notify.custom",
	"filename": "worldeditadditions_core/utils/notify/notify.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/notify/notify.lua#L83-L93"
}

--- Suppress a player's notifications while function executes.
-- @param	name	string		The name of the player to suppress.
-- @param	func	function	The function to execute while the player is suppressed.
-- @returns	bool, string		Success, result of the executed function.
function Notify.suppress_for_function(name, func)

{
	"type": "function",
	"internal": false,
	"description": "Suppress a player's notifications while function executes.",
	"directives": [
		{
			"directive": "param",
			"text": "name\tstring\t\tThe name of the player to suppress.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to suppress."
		},
		{
			"directive": "param",
			"text": "func\tfunction\tThe function to execute while the player is suppressed.",
			"name": "func",
			"type": "function",
			"description": "The function to execute while the player is suppressed."
		},
		{
			"directive": "returns",
			"text": "bool, string\t\tSuccess, result of the executed function.",
			"type": "bool, string",
			"description": "Success, result of the executed function."
		}
	],
	"line": 150,
	"namespace": "worldeditadditions_core.notify",
	"line_last": 154,
	"name": "suppress_for_function",
	"instanced": false,
	"args": [
		"name",
		"func"
	],
	"text": "--- Suppress a player's notifications while function executes.\n-- @param\tname\tstring\t\tThe name of the player to suppress.\n-- @param\tfunc\tfunction\tThe function to execute while the player is suppressed.\n-- @returns\tbool, string\t\tSuccess, result of the executed function.\nfunction Notify.suppress_for_function(name, func)",
	"params": [
		{
			"directive": "param",
			"text": "name\tstring\t\tThe name of the player to suppress.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to suppress."
		},
		{
			"directive": "param",
			"text": "func\tfunction\tThe function to execute while the player is suppressed.",
			"name": "func",
			"type": "function",
			"description": "The function to execute while the player is suppressed."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool, string\t\tSuccess, result of the executed function.",
		"type": "bool, string",
		"description": "Success, result of the executed function."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.notify.suppress_for_function",
	"filename": "worldeditadditions_core/utils/notify/notify.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/notify/notify.lua#L151-L155"
}

--- Suppress a player's notifications.
-- @param	name	string		The name of the player to suppress.
-- @param	time	number > 1	The number of seconds to suppress notifications for.
--								number < 1 immediately removes the suppression.
function Notify.suppress_for_player(name, time)

{
	"type": "function",
	"internal": false,
	"description": "Suppress a player's notifications.",
	"directives": [
		{
			"directive": "param",
			"text": "name\tstring\t\tThe name of the player to suppress.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to suppress."
		},
		{
			"directive": "param",
			"text": "time\tnumber > 1\tThe number of seconds to suppress notifications for.\n\t\t\t\t\t\t\tnumber < 1 immediately removes the suppression.",
			"name": "time",
			"type": "number > 1",
			"description": "The number of seconds to suppress notifications for.\n"
		}
	],
	"line": 135,
	"namespace": "worldeditadditions_core.notify",
	"line_last": 139,
	"name": "suppress_for_player",
	"instanced": false,
	"args": [
		"name",
		"time"
	],
	"text": "--- Suppress a player's notifications.\n-- @param\tname\tstring\t\tThe name of the player to suppress.\n-- @param\ttime\tnumber > 1\tThe number of seconds to suppress notifications for.\n--\t\t\t\t\t\t\t\tnumber < 1 immediately removes the suppression.\nfunction Notify.suppress_for_player(name, time)",
	"params": [
		{
			"directive": "param",
			"text": "name\tstring\t\tThe name of the player to suppress.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to suppress."
		},
		{
			"directive": "param",
			"text": "time\tnumber > 1\tThe number of seconds to suppress notifications for.\n\t\t\t\t\t\t\tnumber < 1 immediately removes the suppression.",
			"name": "time",
			"type": "number > 1",
			"description": "The number of seconds to suppress notifications for.\n"
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.notify.suppress_for_player",
	"filename": "worldeditadditions_core/utils/notify/notify.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/notify/notify.lua#L136-L140"
}

--- Send a notification of type `ntype` (for metatable).
--  (Same as `Notify[ntype](name, message)`)
-- @param	_self	table	Provided automatically by Lua. You do not need to set this automatically - see example.
-- @param	name	string	The name of the player to send the notification to.
-- @param	ntype	string	The type of notification.
-- @param	message	string	The message to send.
-- @return	table	The Notify instance.
-- @example Basic usage
-- worldeditadditions_core.notify(player_name, "info", "All registered commands:\n....")
local call = function(_self, name, ntype, message)

{
	"type": "function",
	"internal": false,
	"description": "Send a notification of type `ntype` (for metatable).\n (Same as `Notify[ntype](name, message)`)",
	"directives": [
		{
			"directive": "param",
			"text": "_self\ttable\tProvided automatically by Lua. You do not need to set this automatically - see example.",
			"name": "_self",
			"type": "table",
			"description": "Provided automatically by Lua. You do not need to set this automatically - see example."
		},
		{
			"directive": "param",
			"text": "name\tstring\tThe name of the player to send the notification to.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to send the notification to."
		},
		{
			"directive": "param",
			"text": "ntype\tstring\tThe type of notification.",
			"name": "ntype",
			"type": "string",
			"description": "The type of notification."
		},
		{
			"directive": "param",
			"text": "message\tstring\tThe message to send.",
			"name": "message",
			"type": "string",
			"description": "The message to send."
		},
		{
			"directive": "returns",
			"text": "table\tThe Notify instance.",
			"type": "table",
			"description": "The Notify instance."
		},
		{
			"directive": "example",
			"text": "Basic usage\nworldeditadditions_core.notify(player_name, \"info\", \"All registered commands:\\n....\")",
			"description": "Basic usage",
			"example": "worldeditadditions_core.notify(player_name, \"info\", \"All registered commands:\\n....\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#BD976A\">worldeditadditions_core</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">notify</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">player_name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">info</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">All registered commands:</span><span style=\"color:#C99076\">\\n</span><span style=\"color:#C98A7D\">....</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"line": 61,
	"namespace": "worldeditadditions_core.notify",
	"line_last": 70,
	"text": "--- Send a notification of type `ntype` (for metatable).\n--  (Same as `Notify[ntype](name, message)`)\n-- @param\t_self\ttable\tProvided automatically by Lua. You do not need to set this automatically - see example.\n-- @param\tname\tstring\tThe name of the player to send the notification to.\n-- @param\tntype\tstring\tThe type of notification.\n-- @param\tmessage\tstring\tThe message to send.\n-- @return\ttable\tThe Notify instance.\n-- @example Basic usage\n-- worldeditadditions_core.notify(player_name, \"info\", \"All registered commands:\\n....\")\nlocal call = function(_self, name, ntype, message)",
	"params": [
		{
			"directive": "param",
			"text": "_self\ttable\tProvided automatically by Lua. You do not need to set this automatically - see example.",
			"name": "_self",
			"type": "table",
			"description": "Provided automatically by Lua. You do not need to set this automatically - see example."
		},
		{
			"directive": "param",
			"text": "name\tstring\tThe name of the player to send the notification to.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to send the notification to."
		},
		{
			"directive": "param",
			"text": "ntype\tstring\tThe type of notification.",
			"name": "ntype",
			"type": "string",
			"description": "The type of notification."
		},
		{
			"directive": "param",
			"text": "message\tstring\tThe message to send.",
			"name": "message",
			"type": "string",
			"description": "The message to send."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "table\tThe Notify instance.",
		"type": "table",
		"description": "The Notify instance."
	},
	"examples": [
		{
			"directive": "example",
			"text": "Basic usage\nworldeditadditions_core.notify(player_name, \"info\", \"All registered commands:\\n....\")",
			"description": "Basic usage",
			"example": "worldeditadditions_core.notify(player_name, \"info\", \"All registered commands:\\n....\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#BD976A\">worldeditadditions_core</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">notify</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">player_name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">info</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">All registered commands:</span><span style=\"color:#C99076\">\\n</span><span style=\"color:#C98A7D\">....</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"name_full": "worldeditadditions_core.notify.undefined",
	"filename": "worldeditadditions_core/utils/notify/notify.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/notify/notify.lua#L62-L71"
}

--- Register the aforementioned predefined notification types.
-- @param	name	string	The name of the player to send the notification to.
-- @param	message	string	The message to send.
-- @example
-- Notify.error(name, "multi-line error!\n" .. debug.traceback())
-- Notify.warn(name, "This is the last coloured message type!")
-- Notify.ok(name, "I am ok!")
-- Notify.info(name, "There once was a ship that put to sea...")
do

{
	"type": "function",
	"internal": false,
	"description": "Register the aforementioned predefined notification types.",
	"directives": [
		{
			"directive": "param",
			"text": "name\tstring\tThe name of the player to send the notification to.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to send the notification to."
		},
		{
			"directive": "param",
			"text": "message\tstring\tThe message to send.",
			"name": "message",
			"type": "string",
			"description": "The message to send."
		},
		{
			"directive": "example",
			"text": "Notify.error(name, \"multi-line error!\\n\" .. debug.traceback())\nNotify.warn(name, \"This is the last coloured message type!\")\nNotify.ok(name, \"I am ok!\")\nNotify.info(name, \"There once was a ship that put to sea...\")",
			"description": "Example 1",
			"example": "Notify.error(name, \"multi-line error!\\n\" .. debug.traceback())\nNotify.warn(name, \"This is the last coloured message type!\")\nNotify.ok(name, \"I am ok!\")\nNotify.info(name, \"There once was a ship that put to sea...\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">error</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">multi-line error!</span><span style=\"color:#C99076\">\\n</span><span style=\"color:#C98A7D77\">\" </span><span style=\"color:#CB7676\">..</span><span style=\"color:#B8A965\"> debug.traceback</span><span style=\"color:#DBD7CAEE\">())</span></span>\n<span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">warn</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">This is the last coloured message type!</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span>\n<span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">ok</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">I am ok!</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span>\n<span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">info</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">There once was a ship that put to sea...</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"line": 98,
	"namespace": "worldeditadditions_core.notify",
	"line_last": 106,
	"text": "--- Register the aforementioned predefined notification types.\n-- @param\tname\tstring\tThe name of the player to send the notification to.\n-- @param\tmessage\tstring\tThe message to send.\n-- @example\n-- Notify.error(name, \"multi-line error!\\n\" .. debug.traceback())\n-- Notify.warn(name, \"This is the last coloured message type!\")\n-- Notify.ok(name, \"I am ok!\")\n-- Notify.info(name, \"There once was a ship that put to sea...\")\ndo",
	"params": [
		{
			"directive": "param",
			"text": "name\tstring\tThe name of the player to send the notification to.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to send the notification to."
		},
		{
			"directive": "param",
			"text": "message\tstring\tThe message to send.",
			"name": "message",
			"type": "string",
			"description": "The message to send."
		}
	],
	"examples": [
		{
			"directive": "example",
			"text": "Notify.error(name, \"multi-line error!\\n\" .. debug.traceback())\nNotify.warn(name, \"This is the last coloured message type!\")\nNotify.ok(name, \"I am ok!\")\nNotify.info(name, \"There once was a ship that put to sea...\")",
			"description": "Example 1",
			"example": "Notify.error(name, \"multi-line error!\\n\" .. debug.traceback())\nNotify.warn(name, \"This is the last coloured message type!\")\nNotify.ok(name, \"I am ok!\")\nNotify.info(name, \"There once was a ship that put to sea...\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">error</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">multi-line error!</span><span style=\"color:#C99076\">\\n</span><span style=\"color:#C98A7D77\">\" </span><span style=\"color:#CB7676\">..</span><span style=\"color:#B8A965\"> debug.traceback</span><span style=\"color:#DBD7CAEE\">())</span></span>\n<span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">warn</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">This is the last coloured message type!</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span>\n<span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">ok</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">I am ok!</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span>\n<span class=\"line\"><span style=\"color:#BD976A\">Notify</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">info</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#BD976A\">name</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">There once was a ship that put to sea...</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"name_full": "worldeditadditions_core.notify.undefined",
	"filename": "worldeditadditions_core/utils/notify/notify.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/notify/notify.lua#L99-L107"
}

--- Local suppression status handler
-- @param	name	string		The name of the player to check.
-- @param	suppress	table	The table of suppressed players.
-- @return	boolean		True if the player is not suppressed or
--						if the player is clear(ed), false otherwise.
local check_clear_suppressed = function(name, suppress)

{
	"type": "function",
	"internal": false,
	"description": "Local suppression status handler",
	"directives": [
		{
			"directive": "param",
			"text": "name\tstring\t\tThe name of the player to check.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to check."
		},
		{
			"directive": "param",
			"text": "suppress\ttable\tThe table of suppressed players.",
			"name": "suppress",
			"type": "table",
			"description": "The table of suppressed players."
		},
		{
			"directive": "returns",
			"text": "boolean\t\tTrue if the player is not suppressed or\n\t\t\t\t\tif the player is clear(ed), false otherwise.",
			"type": "boolean",
			"description": "True if the player is not suppressed or\n"
		}
	],
	"line": 120,
	"namespace": "worldeditadditions_core.notify",
	"line_last": 125,
	"text": "--- Local suppression status handler\n-- @param\tname\tstring\t\tThe name of the player to check.\n-- @param\tsuppress\ttable\tThe table of suppressed players.\n-- @return\tboolean\t\tTrue if the player is not suppressed or\n--\t\t\t\t\t\tif the player is clear(ed), false otherwise.\nlocal check_clear_suppressed = function(name, suppress)",
	"params": [
		{
			"directive": "param",
			"text": "name\tstring\t\tThe name of the player to check.",
			"name": "name",
			"type": "string",
			"description": "The name of the player to check."
		},
		{
			"directive": "param",
			"text": "suppress\ttable\tThe table of suppressed players.",
			"name": "suppress",
			"type": "table",
			"description": "The table of suppressed players."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "boolean\t\tTrue if the player is not suppressed or\n\t\t\t\t\tif the player is clear(ed), false otherwise.",
		"type": "boolean",
		"description": "True if the player is not suppressed or\n"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.notify.undefined",
	"filename": "worldeditadditions_core/utils/notify/notify.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/notify/notify.lua#L121-L126"
}

--- Facedir: lower 5 bits used for direction, 0 - 23
-- @param	param2	number	`param2` value to rotate.
-- @param	axis	string	The name of the axis to rotate around. Valid values: `x`, `y`, `z`
-- @param	amount	The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!
-- @returns	number	A new param2 value that is rotated the given number of degrees around the given `axis`
local function facedir(param2, axis, amount_rad)

{
	"type": "function",
	"internal": false,
	"description": "Facedir: lower 5 bits used for direction, 0 - 23",
	"directives": [
		{
			"directive": "param",
			"text": "param2\tnumber\t`param2` value to rotate.",
			"name": "param2",
			"type": "number",
			"description": "`param2` value to rotate."
		},
		{
			"directive": "param",
			"text": "axis\tstring\tThe name of the axis to rotate around. Valid values: `x`, `y`, `z`",
			"name": "axis",
			"type": "string",
			"description": "The name of the axis to rotate around. Valid values: `x`, `y`, `z`"
		},
		{
			"directive": "param",
			"text": "amount\tThe number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!",
			"name": "amount",
			"type": "The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!"
		},
		{
			"directive": "returns",
			"text": "number\tA new param2 value that is rotated the given number of degrees around the given `axis`",
			"type": "number",
			"description": "A new param2 value that is rotated the given number of degrees around the given `axis`"
		}
	],
	"line": 32,
	"namespace": "worldeditadditions_core.orientation",
	"line_last": 37,
	"name": "facedir",
	"instanced": false,
	"args": [
		"param2",
		"axis",
		"amount_rad"
	],
	"text": "--- Facedir: lower 5 bits used for direction, 0 - 23\n-- @param\tparam2\tnumber\t`param2` value to rotate.\n-- @param\taxis\tstring\tThe name of the axis to rotate around. Valid values: `x`, `y`, `z`\n-- @param\tamount\tThe number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!\n-- @returns\tnumber\tA new param2 value that is rotated the given number of degrees around the given `axis`\nlocal function facedir(param2, axis, amount_rad)",
	"params": [
		{
			"directive": "param",
			"text": "param2\tnumber\t`param2` value to rotate.",
			"name": "param2",
			"type": "number",
			"description": "`param2` value to rotate."
		},
		{
			"directive": "param",
			"text": "axis\tstring\tThe name of the axis to rotate around. Valid values: `x`, `y`, `z`",
			"name": "axis",
			"type": "string",
			"description": "The name of the axis to rotate around. Valid values: `x`, `y`, `z`"
		},
		{
			"directive": "param",
			"text": "amount\tThe number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!",
			"name": "amount",
			"type": "The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!"
		}
	],
	"returns": {
		"directive": "returns",
		"text": "number\tA new param2 value that is rotated the given number of degrees around the given `axis`",
		"type": "number",
		"description": "A new param2 value that is rotated the given number of degrees around the given `axis`"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.orientation.facedir",
	"filename": "worldeditadditions_core/utils/orientation.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/orientation.lua#L33-L38"
}

--- Wallmounted: lower 3 bits used, 0 - 5
-- @param	param2	number	`param2` value to rotate.
-- @param	axis	string	The name of the axis to rotate around. Valid values: `x`, `y`, `z`
-- @param	amount	The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!
-- @returns	number	A new param2 value that is rotated the given number of degrees around the given `axis`
local function wallmounted(param2, axis, amount_rad)

{
	"type": "function",
	"internal": false,
	"description": "Wallmounted: lower 3 bits used, 0 - 5",
	"directives": [
		{
			"directive": "param",
			"text": "param2\tnumber\t`param2` value to rotate.",
			"name": "param2",
			"type": "number",
			"description": "`param2` value to rotate."
		},
		{
			"directive": "param",
			"text": "axis\tstring\tThe name of the axis to rotate around. Valid values: `x`, `y`, `z`",
			"name": "axis",
			"type": "string",
			"description": "The name of the axis to rotate around. Valid values: `x`, `y`, `z`"
		},
		{
			"directive": "param",
			"text": "amount\tThe number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!",
			"name": "amount",
			"type": "The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!"
		},
		{
			"directive": "returns",
			"text": "number\tA new param2 value that is rotated the given number of degrees around the given `axis`",
			"type": "number",
			"description": "A new param2 value that is rotated the given number of degrees around the given `axis`"
		}
	],
	"line": 53,
	"namespace": "worldeditadditions_core.orientation",
	"line_last": 58,
	"name": "wallmounted",
	"instanced": false,
	"args": [
		"param2",
		"axis",
		"amount_rad"
	],
	"text": "--- Wallmounted: lower 3 bits used, 0 - 5\n-- @param\tparam2\tnumber\t`param2` value to rotate.\n-- @param\taxis\tstring\tThe name of the axis to rotate around. Valid values: `x`, `y`, `z`\n-- @param\tamount\tThe number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!\n-- @returns\tnumber\tA new param2 value that is rotated the given number of degrees around the given `axis`\nlocal function wallmounted(param2, axis, amount_rad)",
	"params": [
		{
			"directive": "param",
			"text": "param2\tnumber\t`param2` value to rotate.",
			"name": "param2",
			"type": "number",
			"description": "`param2` value to rotate."
		},
		{
			"directive": "param",
			"text": "axis\tstring\tThe name of the axis to rotate around. Valid values: `x`, `y`, `z`",
			"name": "axis",
			"type": "string",
			"description": "The name of the axis to rotate around. Valid values: `x`, `y`, `z`"
		},
		{
			"directive": "param",
			"text": "amount\tThe number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!",
			"name": "amount",
			"type": "The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!"
		}
	],
	"returns": {
		"directive": "returns",
		"text": "number\tA new param2 value that is rotated the given number of degrees around the given `axis`",
		"type": "number",
		"description": "A new param2 value that is rotated the given number of degrees around the given `axis`"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.orientation.wallmounted",
	"filename": "worldeditadditions_core/utils/orientation.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/orientation.lua#L54-L59"
}

--- Rotates the given param2 value of the given type by the given COMPILED list of rotations.
-- In other words, reorients a given param2 value of a given param2_type (aka paramtype2 in the Minetest engine but the Minetest engine naming scheme is dumb in this case) according to a given COMPILED rotation list. 
-- @param	param2		number		The param2 value to rotate.
-- @param	param2_type	string		The type of param2 value we're talking about here. Currently, only a value of `facedir` is supported.
-- @param	rotlist_c	Vector3[]	The list of vector rotations to apply to param2. Call `worldeditadditions_core.rotation.rotlist_compile` on a rotation list to get this value. Each one is iteratively applied using the `rotate` argument to Vector3.rotate3d.
-- @returns	number?		Returns the rotated param2 value, or nil if an invalid param2_type value was passed.
local function orient(param2, param2_type, rotlist_c)

{
	"type": "function",
	"internal": false,
	"description": "Rotates the given param2 value of the given type by the given COMPILED list of rotations.\nIn other words, reorients a given param2 value of a given param2_type (aka paramtype2 in the Minetest engine but the Minetest engine naming scheme is dumb in this case) according to a given COMPILED rotation list.",
	"directives": [
		{
			"directive": "param",
			"text": "param2\t\tnumber\t\tThe param2 value to rotate.",
			"name": "param2",
			"type": "number",
			"description": "The param2 value to rotate."
		},
		{
			"directive": "param",
			"text": "param2_type\tstring\t\tThe type of param2 value we're talking about here. Currently, only a value of `facedir` is supported.",
			"name": "param2_type",
			"type": "string",
			"description": "The type of param2 value we're talking about here. Currently, only a value of `facedir` is supported."
		},
		{
			"directive": "param",
			"text": "rotlist_c\tVector3[]\tThe list of vector rotations to apply to param2. Call `worldeditadditions_core.rotation.rotlist_compile` on a rotation list to get this value. Each one is iteratively applied using the `rotate` argument to Vector3.rotate3d.",
			"name": "rotlist_c",
			"type": "Vector3[]",
			"description": "The list of vector rotations to apply to param2. Call `worldeditadditions_core.rotation.rotlist_compile` on a rotation list to get this value. Each one is iteratively applied using the `rotate` argument to Vector3.rotate3d."
		},
		{
			"directive": "returns",
			"text": "number?\t\tReturns the rotated param2 value, or nil if an invalid param2_type value was passed.",
			"type": "number?",
			"description": "Returns the rotated param2 value, or nil if an invalid param2_type value was passed."
		}
	],
	"line": 30,
	"namespace": "worldeditadditions_core.param2",
	"line_last": 36,
	"name": "orient",
	"instanced": false,
	"args": [
		"param2",
		"param2_type",
		"rotlist_c"
	],
	"text": "--- Rotates the given param2 value of the given type by the given COMPILED list of rotations.\n-- In other words, reorients a given param2 value of a given param2_type (aka paramtype2 in the Minetest engine but the Minetest engine naming scheme is dumb in this case) according to a given COMPILED rotation list. \n-- @param\tparam2\t\tnumber\t\tThe param2 value to rotate.\n-- @param\tparam2_type\tstring\t\tThe type of param2 value we're talking about here. Currently, only a value of `facedir` is supported.\n-- @param\trotlist_c\tVector3[]\tThe list of vector rotations to apply to param2. Call `worldeditadditions_core.rotation.rotlist_compile` on a rotation list to get this value. Each one is iteratively applied using the `rotate` argument to Vector3.rotate3d.\n-- @returns\tnumber?\t\tReturns the rotated param2 value, or nil if an invalid param2_type value was passed.\nlocal function orient(param2, param2_type, rotlist_c)",
	"params": [
		{
			"directive": "param",
			"text": "param2\t\tnumber\t\tThe param2 value to rotate.",
			"name": "param2",
			"type": "number",
			"description": "The param2 value to rotate."
		},
		{
			"directive": "param",
			"text": "param2_type\tstring\t\tThe type of param2 value we're talking about here. Currently, only a value of `facedir` is supported.",
			"name": "param2_type",
			"type": "string",
			"description": "The type of param2 value we're talking about here. Currently, only a value of `facedir` is supported."
		},
		{
			"directive": "param",
			"text": "rotlist_c\tVector3[]\tThe list of vector rotations to apply to param2. Call `worldeditadditions_core.rotation.rotlist_compile` on a rotation list to get this value. Each one is iteratively applied using the `rotate` argument to Vector3.rotate3d.",
			"name": "rotlist_c",
			"type": "Vector3[]",
			"description": "The list of vector rotations to apply to param2. Call `worldeditadditions_core.rotation.rotlist_compile` on a rotation list to get this value. Each one is iteratively applied using the `rotate` argument to Vector3.rotate3d."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "number?\t\tReturns the rotated param2 value, or nil if an invalid param2_type value was passed.",
		"type": "number?",
		"description": "Returns the rotated param2 value, or nil if an invalid param2_type value was passed."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.param2.orient",
	"filename": "worldeditadditions_core/utils/param2.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/param2.lua#L31-L37"
}

--- Parses a chance value, and returns the 1-in-N value thereof.
-- @param	str		string	The string to parse.
-- @param	mode	string	The operation mode. Valid modes: "1-in-n" (default), "weight". "1-in-n" refers to a 1-in-N chance of something happening (lower numbers mean greater likelihood). "weight", on the other hand, is instead a weighting that something will happen (higher numbers mean a greater likelihood).
-- @returns	number|nil	The 1-in-N chance if parsing was successful, otherwise nil.
local function parse_chance(str, mode)

{
	"type": "function",
	"internal": false,
	"description": "Parses a chance value, and returns the 1-in-N value thereof.",
	"directives": [
		{
			"directive": "param",
			"text": "str\t\tstring\tThe string to parse.",
			"name": "str",
			"type": "string",
			"description": "The string to parse."
		},
		{
			"directive": "param",
			"text": "mode\tstring\tThe operation mode. Valid modes: \"1-in-n\" (default), \"weight\". \"1-in-n\" refers to a 1-in-N chance of something happening (lower numbers mean greater likelihood). \"weight\", on the other hand, is instead a weighting that something will happen (higher numbers mean a greater likelihood).",
			"name": "mode",
			"type": "string",
			"description": "The operation mode. Valid modes: \"1-in-n\" (default), \"weight\". \"1-in-n\" refers to a 1-in-N chance of something happening (lower numbers mean greater likelihood). \"weight\", on the other hand, is instead a weighting that something will happen (higher numbers mean a greater likelihood)."
		},
		{
			"directive": "returns",
			"text": "number|nil\tThe 1-in-N chance if parsing was successful, otherwise nil.",
			"type": "number|nil",
			"description": "The 1-in-N chance if parsing was successful, otherwise nil."
		}
	],
	"line": 5,
	"namespace": "worldeditadditions_core.parse",
	"line_last": 9,
	"name": "parse_chance",
	"instanced": false,
	"args": [
		"str",
		"mode"
	],
	"text": "--- Parses a chance value, and returns the 1-in-N value thereof.\n-- @param\tstr\t\tstring\tThe string to parse.\n-- @param\tmode\tstring\tThe operation mode. Valid modes: \"1-in-n\" (default), \"weight\". \"1-in-n\" refers to a 1-in-N chance of something happening (lower numbers mean greater likelihood). \"weight\", on the other hand, is instead a weighting that something will happen (higher numbers mean a greater likelihood).\n-- @returns\tnumber|nil\tThe 1-in-N chance if parsing was successful, otherwise nil.\nlocal function parse_chance(str, mode)",
	"params": [
		{
			"directive": "param",
			"text": "str\t\tstring\tThe string to parse.",
			"name": "str",
			"type": "string",
			"description": "The string to parse."
		},
		{
			"directive": "param",
			"text": "mode\tstring\tThe operation mode. Valid modes: \"1-in-n\" (default), \"weight\". \"1-in-n\" refers to a 1-in-N chance of something happening (lower numbers mean greater likelihood). \"weight\", on the other hand, is instead a weighting that something will happen (higher numbers mean a greater likelihood).",
			"name": "mode",
			"type": "string",
			"description": "The operation mode. Valid modes: \"1-in-n\" (default), \"weight\". \"1-in-n\" refers to a 1-in-N chance of something happening (lower numbers mean greater likelihood). \"weight\", on the other hand, is instead a weighting that something will happen (higher numbers mean a greater likelihood)."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "number|nil\tThe 1-in-N chance if parsing was successful, otherwise nil.",
		"type": "number|nil",
		"description": "The 1-in-N chance if parsing was successful, otherwise nil."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.parse.parse_chance",
	"filename": "worldeditadditions_core/utils/parse/chance.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/parse/chance.lua#L6-L10"
}

--- Parses a map of key-value pairs into a table.
-- For example, "count 25000 speed 0.8 rate_erosion 0.006 doawesome true" would be parsed into
-- the following table: { count = 25000, speed = 0.8, rate_erosion = 0.006, doawesome = true }.
-- @param	params_text	string		The string to parse.
-- @param	keywords	string[]?	Optional. A list of keywords. Keywords can be present on their own without a value. If found, their value will be automatically set to bool true.
-- @returns	table		A table of key-value pairs parsed out from the given string.
local function parse_map(params_text, keywords)

{
	"type": "function",
	"internal": false,
	"description": "Parses a map of key-value pairs into a table.\nFor example, \"count 25000 speed 0.8 rate_erosion 0.006 doawesome true\" would be parsed into\nthe following table: { count = 25000, speed = 0.8, rate_erosion = 0.006, doawesome = true }.",
	"directives": [
		{
			"directive": "param",
			"text": "params_text\tstring\t\tThe string to parse.",
			"name": "params_text",
			"type": "string",
			"description": "The string to parse."
		},
		{
			"directive": "param",
			"text": "keywords\tstring[]?\tOptional. A list of keywords. Keywords can be present on their own without a value. If found, their value will be automatically set to bool true.",
			"name": "keywords",
			"type": "string[]?",
			"description": "Optional. A list of keywords. Keywords can be present on their own without a value. If found, their value will be automatically set to bool true."
		},
		{
			"directive": "returns",
			"text": "table\t\tA table of key-value pairs parsed out from the given string.",
			"type": "table",
			"description": "A table of key-value pairs parsed out from the given string."
		}
	],
	"line": 8,
	"namespace": "worldeditadditions_core.parse",
	"line_last": 14,
	"name": "parse_map",
	"instanced": false,
	"args": [
		"params_text",
		"keywords"
	],
	"text": "--- Parses a map of key-value pairs into a table.\n-- For example, \"count 25000 speed 0.8 rate_erosion 0.006 doawesome true\" would be parsed into\n-- the following table: { count = 25000, speed = 0.8, rate_erosion = 0.006, doawesome = true }.\n-- @param\tparams_text\tstring\t\tThe string to parse.\n-- @param\tkeywords\tstring[]?\tOptional. A list of keywords. Keywords can be present on their own without a value. If found, their value will be automatically set to bool true.\n-- @returns\ttable\t\tA table of key-value pairs parsed out from the given string.\nlocal function parse_map(params_text, keywords)",
	"params": [
		{
			"directive": "param",
			"text": "params_text\tstring\t\tThe string to parse.",
			"name": "params_text",
			"type": "string",
			"description": "The string to parse."
		},
		{
			"directive": "param",
			"text": "keywords\tstring[]?\tOptional. A list of keywords. Keywords can be present on their own without a value. If found, their value will be automatically set to bool true.",
			"name": "keywords",
			"type": "string[]?",
			"description": "Optional. A list of keywords. Keywords can be present on their own without a value. If found, their value will be automatically set to bool true."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "table\t\tA table of key-value pairs parsed out from the given string.",
		"type": "table",
		"description": "A table of key-value pairs parsed out from the given string."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.parse.parse_map",
	"filename": "worldeditadditions_core/utils/parse/map.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/parse/map.lua#L9-L15"
}

--- Makes a seed from a string.
-- If the input is a number, it is returned as-is.
-- If the input is a string and can be converted to a number with tonumber(),
-- the output of tonumber() is returned.
-- Otherwise, the string is converted to a number via a simple hashing algorithm
-- (caution: certainlly NOT crypto-secure!).
-- @param   {string}    str     The string to convert.
-- @source https://stackoverflow.com/a/2624210/1460422 The idea came from here
local function parse_seed(str)

{
	"type": "function",
	"internal": false,
	"description": "Makes a seed from a string.\nIf the input is a number, it is returned as-is.\nIf the input is a string and can be converted to a number with tonumber(),\nthe output of tonumber() is returned.\nOtherwise, the string is converted to a number via a simple hashing algorithm\n(caution: certainlly NOT crypto-secure!).",
	"directives": [
		{
			"directive": "param",
			"text": "{string}    str     The string to convert.",
			"name": "{string}    str     The string to convert."
		},
		{
			"directive": "source",
			"text": "https://stackoverflow.com/a/2624210/1460422 The idea came from here"
		}
	],
	"line": 3,
	"namespace": "worldeditadditions_core.parse",
	"line_last": 11,
	"name": "parse_seed",
	"instanced": false,
	"args": [
		"str"
	],
	"text": "--- Makes a seed from a string.\n-- If the input is a number, it is returned as-is.\n-- If the input is a string and can be converted to a number with tonumber(),\n-- the output of tonumber() is returned.\n-- Otherwise, the string is converted to a number via a simple hashing algorithm\n-- (caution: certainlly NOT crypto-secure!).\n-- @param   {string}    str     The string to convert.\n-- @source https://stackoverflow.com/a/2624210/1460422 The idea came from here\nlocal function parse_seed(str)",
	"params": [
		{
			"directive": "param",
			"text": "{string}    str     The string to convert.",
			"name": "{string}    str     The string to convert."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.parse.parse_seed",
	"filename": "worldeditadditions_core/utils/parse/seed.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/parse/seed.lua#L4-L12"
}

--- Parses a list of strings as a list of weighted nodes - e.g. like in
-- the //mix command. Example: "dirt 5 stone sand 2".
-- @param	parts	string[]	The list of strings to parse (try worldeditadditions_core.split)
-- @param	as_list	bool		If true, then table.insert() successive { node = string, weight = number } subtables when parsing instead of populating as an associative array.
-- @param	func_normalise	callable	If specified, the given function will be used to normalise node names instead of worldedit.normalize_nodename. A single argument is passed containing the un-normalised node name, and the return value is assumed to be the normalised node name.
-- @returns	table	A table in the form node_name => weight.
local function parse_weighted_nodes(parts, as_list, func_normalise)

{
	"type": "function",
	"internal": false,
	"description": "Parses a list of strings as a list of weighted nodes - e.g. like in\nthe //mix command. Example: \"dirt 5 stone sand 2\".",
	"directives": [
		{
			"directive": "param",
			"text": "parts\tstring[]\tThe list of strings to parse (try worldeditadditions_core.split)",
			"name": "parts",
			"type": "string[]",
			"description": "The list of strings to parse (try worldeditadditions_core.split)"
		},
		{
			"directive": "param",
			"text": "as_list\tbool\t\tIf true, then table.insert() successive { node = string, weight = number } subtables when parsing instead of populating as an associative array.",
			"name": "as_list",
			"type": "bool",
			"description": "If true, then table.insert() successive { node = string, weight = number } subtables when parsing instead of populating as an associative array."
		},
		{
			"directive": "param",
			"text": "func_normalise\tcallable\tIf specified, the given function will be used to normalise node names instead of worldedit.normalize_nodename. A single argument is passed containing the un-normalised node name, and the return value is assumed to be the normalised node name.",
			"name": "func_normalise",
			"type": "callable",
			"description": "If specified, the given function will be used to normalise node names instead of worldedit.normalize_nodename. A single argument is passed containing the un-normalised node name, and the return value is assumed to be the normalised node name."
		},
		{
			"directive": "returns",
			"text": "table\tA table in the form node_name => weight.",
			"type": "table",
			"description": "A table in the form node_name => weight."
		}
	],
	"line": 6,
	"namespace": "worldeditadditions_core.parse",
	"line_last": 12,
	"name": "parse_weighted_nodes",
	"instanced": false,
	"args": [
		"parts",
		"as_list",
		"func_normalise"
	],
	"text": "--- Parses a list of strings as a list of weighted nodes - e.g. like in\n-- the //mix command. Example: \"dirt 5 stone sand 2\".\n-- @param\tparts\tstring[]\tThe list of strings to parse (try worldeditadditions_core.split)\n-- @param\tas_list\tbool\t\tIf true, then table.insert() successive { node = string, weight = number } subtables when parsing instead of populating as an associative array.\n-- @param\tfunc_normalise\tcallable\tIf specified, the given function will be used to normalise node names instead of worldedit.normalize_nodename. A single argument is passed containing the un-normalised node name, and the return value is assumed to be the normalised node name.\n-- @returns\ttable\tA table in the form node_name => weight.\nlocal function parse_weighted_nodes(parts, as_list, func_normalise)",
	"params": [
		{
			"directive": "param",
			"text": "parts\tstring[]\tThe list of strings to parse (try worldeditadditions_core.split)",
			"name": "parts",
			"type": "string[]",
			"description": "The list of strings to parse (try worldeditadditions_core.split)"
		},
		{
			"directive": "param",
			"text": "as_list\tbool\t\tIf true, then table.insert() successive { node = string, weight = number } subtables when parsing instead of populating as an associative array.",
			"name": "as_list",
			"type": "bool",
			"description": "If true, then table.insert() successive { node = string, weight = number } subtables when parsing instead of populating as an associative array."
		},
		{
			"directive": "param",
			"text": "func_normalise\tcallable\tIf specified, the given function will be used to normalise node names instead of worldedit.normalize_nodename. A single argument is passed containing the un-normalised node name, and the return value is assumed to be the normalised node name.",
			"name": "func_normalise",
			"type": "callable",
			"description": "If specified, the given function will be used to normalise node names instead of worldedit.normalize_nodename. A single argument is passed containing the un-normalised node name, and the return value is assumed to be the normalised node name."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "table\tA table in the form node_name => weight.",
		"type": "table",
		"description": "A table in the form node_name => weight."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.parse.parse_weighted_nodes",
	"filename": "worldeditadditions_core/utils/parse/weighted_nodes.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/parse/weighted_nodes.lua#L7-L13"
}

--- Tokenises a string of multiple commands into an array of individual commands.
-- Preserves the forward slash at the beginning of each command name.
-- Also supports arbitrarily nested and complex curly braces { } for grouping
-- commands together that would normally be split apart.
-- 
-- @example Simple example
-- INPUT: //1 //2 //outset 25 //fixlight
-- OUTPUT: { "//1", "//2", "//outset 25", "//fixlight" }
-- 
-- @example Example with curly braces
-- INPUT: //1 //2 //outset 50 {//many 5 //multi //fixlight //clearcut}
-- OUTPUT: { "//1", "//2", "//outset 50", "//many 5 //multi //fixlight //clearcut"}
-- 
-- @param	command_str		str		The command string to operate on.
-- @returns	bool,(string[]|string)	If the operation was successful, then true followed by a table of strings is returned. If the operation was not successful, then false followed by an error message (as a single string) is returned instead.
function worldeditadditions_core.parse.tokenise_commands(command_str)

{
	"type": "function",
	"internal": false,
	"description": "Tokenises a string of multiple commands into an array of individual commands.\nPreserves the forward slash at the beginning of each command name.\nAlso supports arbitrarily nested and complex curly braces { } for grouping\ncommands together that would normally be split apart.\n",
	"directives": [
		{
			"directive": "example",
			"text": "Simple example\nINPUT: //1 //2 //outset 25 //fixlight\nOUTPUT: { \"//1\", \"//2\", \"//outset 25\", \"//fixlight\" }",
			"description": "Simple example",
			"example": "INPUT: //1 //2 //outset 25 //fixlight\nOUTPUT: { \"//1\", \"//2\", \"//outset 25\", \"//fixlight\" }",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#80A665\">INPUT</span><span style=\"color:#DBD7CAEE\">: </span><span style=\"color:#CB7676\">//</span><span style=\"color:#4C9A91\">1</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#4C9A91\">2</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">outset</span><span style=\"color:#4C9A91\"> 25</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">fixlight</span></span>\n<span class=\"line\"><span style=\"color:#80A665\">OUTPUT</span><span style=\"color:#DBD7CAEE\">: { </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//1</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//2</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//outset 25</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//fixlight</span><span style=\"color:#C98A7D77\">\" </span><span style=\"color:#DBD7CAEE\">}</span></span></code></pre>"
		},
		{
			"directive": "example",
			"text": "Example with curly braces\nINPUT: //1 //2 //outset 50 {//many 5 //multi //fixlight //clearcut}\nOUTPUT: { \"//1\", \"//2\", \"//outset 50\", \"//many 5 //multi //fixlight //clearcut\"}",
			"description": "Example with curly braces",
			"example": "INPUT: //1 //2 //outset 50 {//many 5 //multi //fixlight //clearcut}\nOUTPUT: { \"//1\", \"//2\", \"//outset 50\", \"//many 5 //multi //fixlight //clearcut\"}",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#80A665\">INPUT</span><span style=\"color:#DBD7CAEE\">: </span><span style=\"color:#CB7676\">//</span><span style=\"color:#4C9A91\">1</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#4C9A91\">2</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">outset</span><span style=\"color:#4C9A91\"> 50</span><span style=\"color:#DBD7CAEE\"> {</span><span style=\"color:#CB7676\">//</span><span style=\"color:#BD976A\">many</span><span style=\"color:#4C9A91\"> 5</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">multi</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">fixlight</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">clearcut</span><span style=\"color:#DBD7CAEE\">}</span></span>\n<span class=\"line\"><span style=\"color:#80A665\">OUTPUT</span><span style=\"color:#DBD7CAEE\">: { </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//1</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//2</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//outset 50</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//many 5 //multi //fixlight //clearcut</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">}</span></span></code></pre>"
		},
		{
			"directive": "param",
			"text": "command_str\t\tstr\t\tThe command string to operate on.",
			"name": "command_str",
			"type": "str",
			"description": "The command string to operate on."
		},
		{
			"directive": "returns",
			"text": "bool,(string[]|string)\tIf the operation was successful, then true followed by a table of strings is returned. If the operation was not successful, then false followed by an error message (as a single string) is returned instead.",
			"type": "bool,(string[]|string)",
			"description": "If the operation was successful, then true followed by a table of strings is returned. If the operation was not successful, then false followed by an error message (as a single string) is returned instead."
		}
	],
	"line": 91,
	"namespace": "worldeditadditions_core.parse",
	"line_last": 106,
	"name": "parse.tokenise_commands",
	"instanced": false,
	"args": [
		"command_str"
	],
	"text": "--- Tokenises a string of multiple commands into an array of individual commands.\n-- Preserves the forward slash at the beginning of each command name.\n-- Also supports arbitrarily nested and complex curly braces { } for grouping\n-- commands together that would normally be split apart.\n-- \n-- @example Simple example\n-- INPUT: //1 //2 //outset 25 //fixlight\n-- OUTPUT: { \"//1\", \"//2\", \"//outset 25\", \"//fixlight\" }\n-- \n-- @example Example with curly braces\n-- INPUT: //1 //2 //outset 50 {//many 5 //multi //fixlight //clearcut}\n-- OUTPUT: { \"//1\", \"//2\", \"//outset 50\", \"//many 5 //multi //fixlight //clearcut\"}\n-- \n-- @param\tcommand_str\t\tstr\t\tThe command string to operate on.\n-- @returns\tbool,(string[]|string)\tIf the operation was successful, then true followed by a table of strings is returned. If the operation was not successful, then false followed by an error message (as a single string) is returned instead.\nfunction worldeditadditions_core.parse.tokenise_commands(command_str)",
	"params": [
		{
			"directive": "param",
			"text": "command_str\t\tstr\t\tThe command string to operate on.",
			"name": "command_str",
			"type": "str",
			"description": "The command string to operate on."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool,(string[]|string)\tIf the operation was successful, then true followed by a table of strings is returned. If the operation was not successful, then false followed by an error message (as a single string) is returned instead.",
		"type": "bool,(string[]|string)",
		"description": "If the operation was successful, then true followed by a table of strings is returned. If the operation was not successful, then false followed by an error message (as a single string) is returned instead."
	},
	"examples": [
		{
			"directive": "example",
			"text": "Simple example\nINPUT: //1 //2 //outset 25 //fixlight\nOUTPUT: { \"//1\", \"//2\", \"//outset 25\", \"//fixlight\" }",
			"description": "Simple example",
			"example": "INPUT: //1 //2 //outset 25 //fixlight\nOUTPUT: { \"//1\", \"//2\", \"//outset 25\", \"//fixlight\" }",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#80A665\">INPUT</span><span style=\"color:#DBD7CAEE\">: </span><span style=\"color:#CB7676\">//</span><span style=\"color:#4C9A91\">1</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#4C9A91\">2</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">outset</span><span style=\"color:#4C9A91\"> 25</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">fixlight</span></span>\n<span class=\"line\"><span style=\"color:#80A665\">OUTPUT</span><span style=\"color:#DBD7CAEE\">: { </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//1</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//2</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//outset 25</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//fixlight</span><span style=\"color:#C98A7D77\">\" </span><span style=\"color:#DBD7CAEE\">}</span></span></code></pre>"
		},
		{
			"directive": "example",
			"text": "Example with curly braces\nINPUT: //1 //2 //outset 50 {//many 5 //multi //fixlight //clearcut}\nOUTPUT: { \"//1\", \"//2\", \"//outset 50\", \"//many 5 //multi //fixlight //clearcut\"}",
			"description": "Example with curly braces",
			"example": "INPUT: //1 //2 //outset 50 {//many 5 //multi //fixlight //clearcut}\nOUTPUT: { \"//1\", \"//2\", \"//outset 50\", \"//many 5 //multi //fixlight //clearcut\"}",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#80A665\">INPUT</span><span style=\"color:#DBD7CAEE\">: </span><span style=\"color:#CB7676\">//</span><span style=\"color:#4C9A91\">1</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#4C9A91\">2</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">outset</span><span style=\"color:#4C9A91\"> 50</span><span style=\"color:#DBD7CAEE\"> {</span><span style=\"color:#CB7676\">//</span><span style=\"color:#BD976A\">many</span><span style=\"color:#4C9A91\"> 5</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">multi</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">fixlight</span><span style=\"color:#CB7676\"> //</span><span style=\"color:#BD976A\">clearcut</span><span style=\"color:#DBD7CAEE\">}</span></span>\n<span class=\"line\"><span style=\"color:#80A665\">OUTPUT</span><span style=\"color:#DBD7CAEE\">: { </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//1</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//2</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//outset 50</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">//many 5 //multi //fixlight //clearcut</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">}</span></span></code></pre>"
		}
	],
	"name_full": "worldeditadditions_core.parse.parse.tokenise_commands",
	"filename": "worldeditadditions_core/utils/parse/tokenise_commands.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/parse/tokenise_commands.lua#L92-L107"
}

--- Recombines a list of tokens into a list of commands.
-- @param   parts   string[]    The tokens from tokenise(str).
-- @returns         string[]	The tokens, but run through trim() & grouped into commands (1 element in the list = 1 command)
local function recombine(parts)

{
	"type": "function",
	"internal": false,
	"description": "Recombines a list of tokens into a list of commands.",
	"directives": [
		{
			"directive": "param",
			"text": "parts   string[]    The tokens from tokenise(str).",
			"name": "parts   string[]    The tokens from tokenise(str)."
		},
		{
			"directive": "returns",
			"text": "string[]\tThe tokens, but run through trim() & grouped into commands (1 element in the list = 1 command)",
			"type": "string[]",
			"description": "The tokens, but run through trim() & grouped into commands (1 element in the list = 1 command)"
		}
	],
	"line": 72,
	"namespace": "worldeditadditions_core.parse",
	"line_last": 75,
	"name": "recombine",
	"instanced": false,
	"args": [
		"parts"
	],
	"text": "--- Recombines a list of tokens into a list of commands.\n-- @param   parts   string[]    The tokens from tokenise(str).\n-- @returns         string[]\tThe tokens, but run through trim() & grouped into commands (1 element in the list = 1 command)\nlocal function recombine(parts)",
	"params": [
		{
			"directive": "param",
			"text": "parts   string[]    The tokens from tokenise(str).",
			"name": "parts   string[]    The tokens from tokenise(str)."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "string[]\tThe tokens, but run through trim() & grouped into commands (1 element in the list = 1 command)",
		"type": "string[]",
		"description": "The tokens, but run through trim() & grouped into commands (1 element in the list = 1 command)"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.parse.recombine",
	"filename": "worldeditadditions_core/utils/parse/tokenise_commands.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/parse/tokenise_commands.lua#L73-L76"
}

--- The main tokeniser. Splits the input string up into space separated tokens, except when said spaces are inside { curly braces }.
-- Note that the outermost set of curly braces are stripped.
-- @param   str     string  The input string to tokenise.
-- @returns string[]        A list of tokens
local function tokenise(str)

{
	"type": "function",
	"internal": false,
	"description": "The main tokeniser. Splits the input string up into space separated tokens, except when said spaces are inside { curly braces }.\nNote that the outermost set of curly braces are stripped.",
	"directives": [
		{
			"directive": "param",
			"text": "str     string  The input string to tokenise.",
			"name": "str     string  The input string to tokenise."
		},
		{
			"directive": "returns",
			"text": "string[]        A list of tokens",
			"type": "string[]        A list of tokens"
		}
	],
	"line": 9,
	"namespace": "worldeditadditions_core.parse",
	"line_last": 13,
	"name": "tokenise",
	"instanced": false,
	"args": [
		"str"
	],
	"text": "--- The main tokeniser. Splits the input string up into space separated tokens, except when said spaces are inside { curly braces }.\n-- Note that the outermost set of curly braces are stripped.\n-- @param   str     string  The input string to tokenise.\n-- @returns string[]        A list of tokens\nlocal function tokenise(str)",
	"params": [
		{
			"directive": "param",
			"text": "str     string  The input string to tokenise.",
			"name": "str     string  The input string to tokenise."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "string[]        A list of tokens",
		"type": "string[]        A list of tokens"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.parse.tokenise",
	"filename": "worldeditadditions_core/utils/parse/tokenise_commands.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/parse/tokenise_commands.lua#L10-L14"
}

--- Format string into path
--	@param	str	string	The string to process
--	@return		string|false, string?	The formatted path string or
--				false and an error message.
--	@example	Basic usage
--		local path = path.norm("C:\\Users\\me\\".."/Documents//code.lua")
path.norm = function( str )

{
	"type": "function",
	"internal": false,
	"description": "Format string into path",
	"directives": [
		{
			"directive": "param",
			"text": "str\tstring\tThe string to process",
			"name": "str",
			"type": "string",
			"description": "The string to process"
		},
		{
			"directive": "returns",
			"text": "string|false, string?\tThe formatted path string or\n\t\t\tfalse and an error message.",
			"type": "string|false, string?",
			"description": "The formatted path string or\n"
		},
		{
			"directive": "example",
			"text": "Basic usage\n\tlocal path = path.norm(\"C:\\\\Users\\\\me\\\\\"..\"/Documents//code.lua\")",
			"description": "Basic usage",
			"example": "\tlocal path = path.norm(\"C:\\\\Users\\\\me\\\\\"..\"/Documents//code.lua\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#4D9375\">\tlocal</span><span style=\"color:#BD976A\"> path</span><span style=\"color:#CB7676\"> =</span><span style=\"color:#BD976A\"> path</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">norm</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">C:</span><span style=\"color:#C99076\">\\\\</span><span style=\"color:#C98A7D\">Users</span><span style=\"color:#C99076\">\\\\</span><span style=\"color:#C98A7D\">me</span><span style=\"color:#C99076\">\\\\</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#CB7676\">..</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">/Documents//code.lua</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"line": 21,
	"namespace": "worldeditadditions_core.Path",
	"line_last": 27,
	"text": "--- Format string into path\n--\t@param\tstr\tstring\tThe string to process\n--\t@return\t\tstring|false, string?\tThe formatted path string or\n--\t\t\t\tfalse and an error message.\n--\t@example\tBasic usage\n--\t\tlocal path = path.norm(\"C:\\\\Users\\\\me\\\\\"..\"/Documents//code.lua\")\npath.norm = function( str )",
	"params": [
		{
			"directive": "param",
			"text": "str\tstring\tThe string to process",
			"name": "str",
			"type": "string",
			"description": "The string to process"
		}
	],
	"returns": {
		"directive": "returns",
		"text": "string|false, string?\tThe formatted path string or\n\t\t\tfalse and an error message.",
		"type": "string|false, string?",
		"description": "The formatted path string or\n"
	},
	"examples": [
		{
			"directive": "example",
			"text": "Basic usage\n\tlocal path = path.norm(\"C:\\\\Users\\\\me\\\\\"..\"/Documents//code.lua\")",
			"description": "Basic usage",
			"example": "\tlocal path = path.norm(\"C:\\\\Users\\\\me\\\\\"..\"/Documents//code.lua\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#4D9375\">\tlocal</span><span style=\"color:#BD976A\"> path</span><span style=\"color:#CB7676\"> =</span><span style=\"color:#BD976A\"> path</span><span style=\"color:#DBD7CAEE\">.</span><span style=\"color:#B8A965\">norm</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">C:</span><span style=\"color:#C99076\">\\\\</span><span style=\"color:#C98A7D\">Users</span><span style=\"color:#C99076\">\\\\</span><span style=\"color:#C98A7D\">me</span><span style=\"color:#C99076\">\\\\</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#CB7676\">..</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">/Documents//code.lua</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"name_full": "worldeditadditions_core.Path.undefined",
	"filename": "worldeditadditions_core/utils/path.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/path.lua#L22-L28"
}

--- Joins the given path segments into a single path with dirsep.
--	@param	...	string	The path fragments to process and join.
--	@return		string|false, string?	The joined path or
--				false and an error message.
--	@example	Basic usage
--		local path = file_path("C:\\Users", "me", "/Documents/code.lua")
path.join = function( ... )

{
	"type": "function",
	"internal": false,
	"description": "Joins the given path segments into a single path with dirsep.",
	"directives": [
		{
			"directive": "param",
			"text": "...\tstring\tThe path fragments to process and join.",
			"name": "...",
			"type": "string",
			"description": "The path fragments to process and join."
		},
		{
			"directive": "returns",
			"text": "string|false, string?\tThe joined path or\n\t\t\tfalse and an error message.",
			"type": "string|false, string?",
			"description": "The joined path or\n"
		},
		{
			"directive": "example",
			"text": "Basic usage\n\tlocal path = file_path(\"C:\\\\Users\", \"me\", \"/Documents/code.lua\")",
			"description": "Basic usage",
			"example": "\tlocal path = file_path(\"C:\\\\Users\", \"me\", \"/Documents/code.lua\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#4D9375\">\tlocal</span><span style=\"color:#BD976A\"> path</span><span style=\"color:#CB7676\"> =</span><span style=\"color:#B8A965\"> file_path</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">C:</span><span style=\"color:#C99076\">\\\\</span><span style=\"color:#C98A7D\">Users</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">me</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">/Documents/code.lua</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"line": 33,
	"namespace": "worldeditadditions_core.Path",
	"line_last": 39,
	"text": "--- Joins the given path segments into a single path with dirsep.\n--\t@param\t...\tstring\tThe path fragments to process and join.\n--\t@return\t\tstring|false, string?\tThe joined path or\n--\t\t\t\tfalse and an error message.\n--\t@example\tBasic usage\n--\t\tlocal path = file_path(\"C:\\\\Users\", \"me\", \"/Documents/code.lua\")\npath.join = function( ... )",
	"params": [
		{
			"directive": "param",
			"text": "...\tstring\tThe path fragments to process and join.",
			"name": "...",
			"type": "string",
			"description": "The path fragments to process and join."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "string|false, string?\tThe joined path or\n\t\t\tfalse and an error message.",
		"type": "string|false, string?",
		"description": "The joined path or\n"
	},
	"examples": [
		{
			"directive": "example",
			"text": "Basic usage\n\tlocal path = file_path(\"C:\\\\Users\", \"me\", \"/Documents/code.lua\")",
			"description": "Basic usage",
			"example": "\tlocal path = file_path(\"C:\\\\Users\", \"me\", \"/Documents/code.lua\")",
			"example_highlighted": "<pre class=\"shiki vitesse-dark\" style=\"background-color:#121212;color:#dbd7caee\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color:#4D9375\">\tlocal</span><span style=\"color:#BD976A\"> path</span><span style=\"color:#CB7676\"> =</span><span style=\"color:#B8A965\"> file_path</span><span style=\"color:#DBD7CAEE\">(</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">C:</span><span style=\"color:#C99076\">\\\\</span><span style=\"color:#C98A7D\">Users</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">me</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">, </span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#C98A7D\">/Documents/code.lua</span><span style=\"color:#C98A7D77\">\"</span><span style=\"color:#DBD7CAEE\">)</span></span></code></pre>"
		}
	],
	"name_full": "worldeditadditions_core.Path.undefined",
	"filename": "worldeditadditions_core/utils/path.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/path.lua#L34-L40"
}

--- Clears all the positions for the given player.
-- @param	player_name		string	The name of the player to clear the positions for.
-- @returns	void
local function clear(player_name)

{
	"type": "function",
	"internal": false,
	"description": "Clears all the positions for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to clear the positions for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to clear the positions for."
		},
		{
			"directive": "returns",
			"text": "void",
			"type": "void"
		}
	],
	"line": 246,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 249,
	"name": "clear",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Clears all the positions for the given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to clear the positions for.\n-- @returns\tvoid\nlocal function clear(player_name)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to clear the positions for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to clear the positions for."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "void",
		"type": "void"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.clear",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L247-L250"
}

--- Fetches pos1/pos2 from WorldEdit (if available) and sets them in WorldEditAdditions' postional subsystem
-- @param	player_name		string	The name of the player to sync the positions for.
local function compat_worldedit_get(player_name)

{
	"type": "function",
	"internal": false,
	"description": "Fetches pos1/pos2 from WorldEdit (if available) and sets them in WorldEditAdditions' postional subsystem",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to sync the positions for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to sync the positions for."
		}
	],
	"line": 107,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 109,
	"name": "compat_worldedit_get",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Fetches pos1/pos2 from WorldEdit (if available) and sets them in WorldEditAdditions' postional subsystem\n-- @param\tplayer_name\t\tstring\tThe name of the player to sync the positions for.\nlocal function compat_worldedit_get(player_name)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to sync the positions for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to sync the positions for."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.pos.compat_worldedit_get",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L108-L110"
}

--- Sets pos1/pos2 in worldedit for compatibility.
-- @param	player_name		string	The name of the player to set the position for.
-- @param	i				number	The index of the position to set.
-- @param	pos				Vector3	The position to set.
-- @param	do_update=true	bool	Whether to call worldedit.marker_update() or not.
-- @returns	nil
local function compat_worldedit_set(player_name, i, pos, do_update)

{
	"type": "function",
	"internal": false,
	"description": "Sets pos1/pos2 in worldedit for compatibility.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to set the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set the position for."
		},
		{
			"directive": "param",
			"text": "i\t\t\t\tnumber\tThe index of the position to set.",
			"name": "i",
			"type": "number",
			"description": "The index of the position to set."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3\tThe position to set.",
			"name": "pos",
			"type": "Vector3",
			"description": "The position to set."
		},
		{
			"directive": "param",
			"text": "do_update=true\tbool\tWhether to call worldedit.marker_update() or not.",
			"name": "do_update",
			"type": "bool",
			"description": "Whether to call worldedit.marker_update() or not.",
			"default_value": "true"
		},
		{
			"directive": "returns",
			"text": "nil",
			"type": "nil"
		}
	],
	"line": 85,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 91,
	"name": "compat_worldedit_set",
	"instanced": false,
	"args": [
		"player_name",
		"i",
		"pos",
		"do_update"
	],
	"text": "--- Sets pos1/pos2 in worldedit for compatibility.\n-- @param\tplayer_name\t\tstring\tThe name of the player to set the position for.\n-- @param\ti\t\t\t\tnumber\tThe index of the position to set.\n-- @param\tpos\t\t\t\tVector3\tThe position to set.\n-- @param\tdo_update=true\tbool\tWhether to call worldedit.marker_update() or not.\n-- @returns\tnil\nlocal function compat_worldedit_set(player_name, i, pos, do_update)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to set the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set the position for."
		},
		{
			"directive": "param",
			"text": "i\t\t\t\tnumber\tThe index of the position to set.",
			"name": "i",
			"type": "number",
			"description": "The index of the position to set."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3\tThe position to set.",
			"name": "pos",
			"type": "Vector3",
			"description": "The position to set."
		},
		{
			"directive": "param",
			"text": "do_update=true\tbool\tWhether to call worldedit.marker_update() or not.",
			"name": "do_update",
			"type": "bool",
			"description": "Whether to call worldedit.marker_update() or not.",
			"default_value": "true"
		}
	],
	"returns": {
		"directive": "returns",
		"text": "nil",
		"type": "nil"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.compat_worldedit_set",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L86-L92"
}

--- Counts the number of positioons registered to a given player.
-- @param	player_name		string	The name of the player to fetch the position for.
-- @returns	number			The number of positions registered for the given player.
local function count(player_name)

{
	"type": "function",
	"internal": false,
	"description": "Counts the number of positioons registered to a given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		},
		{
			"directive": "returns",
			"text": "number\t\t\tThe number of positions registered for the given player.",
			"type": "number",
			"description": "The number of positions registered for the given player."
		}
	],
	"line": 177,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 180,
	"name": "count",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Counts the number of positioons registered to a given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to fetch the position for.\n-- @returns\tnumber\t\t\tThe number of positions registered for the given player.\nlocal function count(player_name)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "number\t\t\tThe number of positions registered for the given player.",
		"type": "number",
		"description": "The number of positions registered for the given player."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.count",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L178-L181"
}

--- Ensures that a table exists for the given player.
-- @param	player_name		string	The name of the player to check.
local function ensure_player(player_name)

{
	"type": "function",
	"internal": false,
	"description": "Ensures that a table exists for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to check.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to check."
		}
	],
	"line": 41,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 43,
	"name": "ensure_player",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Ensures that a table exists for the given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to check.\nlocal function ensure_player(player_name)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to check.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to check."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.pos.ensure_player",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L42-L44"
}

--- Gets the position with the given index for the given player.
-- @param	player_name		string	The name of the player to fetch the position for.
-- @param	i				number	The index of the position to fetch.
-- @returns	Vector3?		The position requested, or nil if it doesn't exist.
local function get(player_name, i)

{
	"type": "function",
	"internal": false,
	"description": "Gets the position with the given index for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		},
		{
			"directive": "param",
			"text": "i\t\t\t\tnumber\tThe index of the position to fetch.",
			"name": "i",
			"type": "number",
			"description": "The index of the position to fetch."
		},
		{
			"directive": "returns",
			"text": "Vector3?\t\tThe position requested, or nil if it doesn't exist.",
			"type": "Vector3?",
			"description": "The position requested, or nil if it doesn't exist."
		}
	],
	"line": 114,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 118,
	"name": "get",
	"instanced": false,
	"args": [
		"player_name",
		"i"
	],
	"text": "--- Gets the position with the given index for the given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to fetch the position for.\n-- @param\ti\t\t\t\tnumber\tThe index of the position to fetch.\n-- @returns\tVector3?\t\tThe position requested, or nil if it doesn't exist.\nlocal function get(player_name, i)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		},
		{
			"directive": "param",
			"text": "i\t\t\t\tnumber\tThe index of the position to fetch.",
			"name": "i",
			"type": "number",
			"description": "The index of the position to fetch."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "Vector3?\t\tThe position requested, or nil if it doesn't exist.",
		"type": "Vector3?",
		"description": "The position requested, or nil if it doesn't exist."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.get",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L115-L119"
}

--- Gets a list of all the positions for the given player.
-- @param	player_name		string	The name of the player to fetch the position for.
-- @returns	Vector3[]		A list of positions for the given player.
local function get_all(player_name)

{
	"type": "function",
	"internal": false,
	"description": "Gets a list of all the positions for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		},
		{
			"directive": "returns",
			"text": "Vector3[]\t\tA list of positions for the given player.",
			"type": "Vector3[]",
			"description": "A list of positions for the given player."
		}
	],
	"line": 148,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 151,
	"name": "get_all",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Gets a list of all the positions for the given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to fetch the position for.\n-- @returns\tVector3[]\t\tA list of positions for the given player.\nlocal function get_all(player_name)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "Vector3[]\t\tA list of positions for the given player.",
		"type": "Vector3[]",
		"description": "A list of positions for the given player."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.get_all",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L149-L152"
}

--- Get a bounding box that encloses all the positions currently defined by a given player.
-- @param	player_name		string	The name of the player to fetch the boudnign box for.
-- @returns nil|(Vector3,Vector3)	2 positions that define opposite corners of a region that fully encloses all the defined points for the given player, or nil ir the specified player has no points currently defined.
local function get_bounds(player_name)

{
	"type": "function",
	"internal": false,
	"description": "Get a bounding box that encloses all the positions currently defined by a given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the boudnign box for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the boudnign box for."
		},
		{
			"directive": "returns",
			"text": "nil|(Vector3,Vector3)\t2 positions that define opposite corners of a region that fully encloses all the defined points for the given player, or nil ir the specified player has no points currently defined.",
			"type": "nil|(Vector3,Vector3)",
			"description": "2 positions that define opposite corners of a region that fully encloses all the defined points for the given player, or nil ir the specified player has no points currently defined."
		}
	],
	"line": 159,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 162,
	"name": "get_bounds",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Get a bounding box that encloses all the positions currently defined by a given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to fetch the boudnign box for.\n-- @returns nil|(Vector3,Vector3)\t2 positions that define opposite corners of a region that fully encloses all the defined points for the given player, or nil ir the specified player has no points currently defined.\nlocal function get_bounds(player_name)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the boudnign box for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the boudnign box for."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "nil|(Vector3,Vector3)\t2 positions that define opposite corners of a region that fully encloses all the defined points for the given player, or nil ir the specified player has no points currently defined.",
		"type": "nil|(Vector3,Vector3)",
		"description": "2 positions that define opposite corners of a region that fully encloses all the defined points for the given player, or nil ir the specified player has no points currently defined."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.get_bounds",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L160-L163"
}

--- Convenience function that returns position 1 for the given player.
-- @param	player_name		string	The name of the player to fetch the position for.
-- @returns	Vector3?		The position requested, or nil if it doesn't exist.
local function get1(player_name) return get(player_name, 1) end

{
	"type": "function",
	"internal": false,
	"description": "Convenience function that returns position 1 for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		},
		{
			"directive": "returns",
			"text": "Vector3?\t\tThe position requested, or nil if it doesn't exist.",
			"type": "Vector3?",
			"description": "The position requested, or nil if it doesn't exist."
		}
	],
	"line": 126,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 129,
	"name": "get1",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Convenience function that returns position 1 for the given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to fetch the position for.\n-- @returns\tVector3?\t\tThe position requested, or nil if it doesn't exist.\nlocal function get1(player_name) return get(player_name, 1) end",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "Vector3?\t\tThe position requested, or nil if it doesn't exist.",
		"type": "Vector3?",
		"description": "The position requested, or nil if it doesn't exist."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.get1",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L127-L130"
}

--- Convenience function that returns pos1 and pos2 with the coordinates sorted for the given player.
-- @param	player_name		string	The name of the player to fetch the position for.
-- @param	sort=false			bool	If true, the pos1 and pos2 are run through Vector3.sort() automatically.
-- @returns	Vector3?,Vector3		The positions requested, or nil if either of them don't exist.
local function get12(player_name, sort)

{
	"type": "function",
	"internal": false,
	"description": "Convenience function that returns pos1 and pos2 with the coordinates sorted for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		},
		{
			"directive": "param",
			"text": "sort=false\t\t\tbool\tIf true, the pos1 and pos2 are run through Vector3.sort() automatically.",
			"name": "sort",
			"type": "bool",
			"description": "If true, the pos1 and pos2 are run through Vector3.sort() automatically.",
			"default_value": "false"
		},
		{
			"directive": "returns",
			"text": "Vector3?,Vector3\t\tThe positions requested, or nil if either of them don't exist.",
			"type": "Vector3?,Vector3",
			"description": "The positions requested, or nil if either of them don't exist."
		}
	],
	"line": 135,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 139,
	"name": "get12",
	"instanced": false,
	"args": [
		"player_name",
		"sort"
	],
	"text": "--- Convenience function that returns pos1 and pos2 with the coordinates sorted for the given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to fetch the position for.\n-- @param\tsort=false\t\t\tbool\tIf true, the pos1 and pos2 are run through Vector3.sort() automatically.\n-- @returns\tVector3?,Vector3\t\tThe positions requested, or nil if either of them don't exist.\nlocal function get12(player_name, sort)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		},
		{
			"directive": "param",
			"text": "sort=false\t\t\tbool\tIf true, the pos1 and pos2 are run through Vector3.sort() automatically.",
			"name": "sort",
			"type": "bool",
			"description": "If true, the pos1 and pos2 are run through Vector3.sort() automatically.",
			"default_value": "false"
		}
	],
	"returns": {
		"directive": "returns",
		"text": "Vector3?,Vector3\t\tThe positions requested, or nil if either of them don't exist.",
		"type": "Vector3?,Vector3",
		"description": "The positions requested, or nil if either of them don't exist."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.get12",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L136-L140"
}

--- Convenience function that returns position 1 for the given player.
-- @param	player_name		string	The name of the player to fetch the position for.
-- @returns	Vector3?		The position requested, or nil if it doesn't exist.
local function get2(player_name) return get(player_name, 2) end

{
	"type": "function",
	"internal": false,
	"description": "Convenience function that returns position 1 for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		},
		{
			"directive": "returns",
			"text": "Vector3?\t\tThe position requested, or nil if it doesn't exist.",
			"type": "Vector3?",
			"description": "The position requested, or nil if it doesn't exist."
		}
	],
	"line": 130,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 133,
	"name": "get2",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Convenience function that returns position 1 for the given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to fetch the position for.\n-- @returns\tVector3?\t\tThe position requested, or nil if it doesn't exist.\nlocal function get2(player_name) return get(player_name, 2) end",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to fetch the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to fetch the position for."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "Vector3?\t\tThe position requested, or nil if it doesn't exist.",
		"type": "Vector3?",
		"description": "The position requested, or nil if it doesn't exist."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.get2",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L131-L134"
}

--- Shows the visual markers for the given player's positions and defined region once more.
-- Often used some time after calling worldeditadditions_core.pos.unmark().
-- @param	player_name		string	The name of the player to operate on.
-- @returns	void
local function mark(player_name)

{
	"type": "function",
	"internal": false,
	"description": "Shows the visual markers for the given player's positions and defined region once more.\nOften used some time after calling worldeditadditions_core.pos.unmark().",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to operate on.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to operate on."
		},
		{
			"directive": "returns",
			"text": "void",
			"type": "void"
		}
	],
	"line": 308,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 312,
	"name": "mark",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Shows the visual markers for the given player's positions and defined region once more.\n-- Often used some time after calling worldeditadditions_core.pos.unmark().\n-- @param\tplayer_name\t\tstring\tThe name of the player to operate on.\n-- @returns\tvoid\nlocal function mark(player_name)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to operate on.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to operate on."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "void",
		"type": "void"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.mark",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L309-L313"
}

--- Removes the last position from the for a given player and returns it.
-- @param	player_name		string	The name of the player to pop the position for.
-- @returns	Vector3?		The position removed, or nil if it doesn't exist.
local function pop(player_name)

{
	"type": "function",
	"internal": false,
	"description": "Removes the last position from the for a given player and returns it.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to pop the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to pop the position for."
		},
		{
			"directive": "returns",
			"text": "Vector3?\t\tThe position removed, or nil if it doesn't exist.",
			"type": "Vector3?",
			"description": "The position removed, or nil if it doesn't exist."
		}
	],
	"line": 260,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 263,
	"name": "pop",
	"instanced": false,
	"args": [
		"player_name"
	],
	"text": "--- Removes the last position from the for a given player and returns it.\n-- @param\tplayer_name\t\tstring\tThe name of the player to pop the position for.\n-- @returns\tVector3?\t\tThe position removed, or nil if it doesn't exist.\nlocal function pop(player_name)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to pop the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to pop the position for."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "Vector3?\t\tThe position removed, or nil if it doesn't exist.",
		"type": "Vector3?",
		"description": "The position removed, or nil if it doesn't exist."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.pop",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L261-L264"
}

--- Adds a position to the list for a given player.
-- @param	player_name		string	The name of the player to add the position for.
-- @param	pos				Vector3	The position to add.
-- @returns	number			The new number of positions for that player.
local function push(player_name, pos)

{
	"type": "function",
	"internal": false,
	"description": "Adds a position to the list for a given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to add the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to add the position for."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3\tThe position to add.",
			"name": "pos",
			"type": "Vector3",
			"description": "The position to add."
		},
		{
			"directive": "returns",
			"text": "number\t\t\tThe new number of positions for that player.",
			"type": "number",
			"description": "The new number of positions for that player."
		}
	],
	"line": 279,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 283,
	"name": "push",
	"instanced": false,
	"args": [
		"player_name",
		"pos"
	],
	"text": "--- Adds a position to the list for a given player.\n-- @param\tplayer_name\t\tstring\tThe name of the player to add the position for.\n-- @param\tpos\t\t\t\tVector3\tThe position to add.\n-- @returns\tnumber\t\t\tThe new number of positions for that player.\nlocal function push(player_name, pos)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to add the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to add the position for."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3\tThe position to add.",
			"name": "pos",
			"type": "Vector3",
			"description": "The position to add."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "number\t\t\tThe new number of positions for that player.",
		"type": "number",
		"description": "The new number of positions for that player."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.push",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L280-L284"
}

--- Sets the position at the given index for the given player.
-- You probably want push_pos, not this function.
-- @param	player_name		string	The name of the player to set the position for.
-- @param	i				number	The index to set the position at.
-- @param	pos				Vector3	The position to set.
-- @returns	bool			Whether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time).
local function set(player_name, i, pos)

{
	"type": "function",
	"internal": false,
	"description": "Sets the position at the given index for the given player.\nYou probably want push_pos, not this function.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to set the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set the position for."
		},
		{
			"directive": "param",
			"text": "i\t\t\t\tnumber\tThe index to set the position at.",
			"name": "i",
			"type": "number",
			"description": "The index to set the position at."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3\tThe position to set.",
			"name": "pos",
			"type": "Vector3",
			"description": "The position to set."
		},
		{
			"directive": "returns",
			"text": "bool\t\t\tWhether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time).",
			"type": "bool",
			"description": "Whether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time)."
		}
	],
	"line": 187,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 193,
	"name": "set",
	"instanced": false,
	"args": [
		"player_name",
		"i",
		"pos"
	],
	"text": "--- Sets the position at the given index for the given player.\n-- You probably want push_pos, not this function.\n-- @param\tplayer_name\t\tstring\tThe name of the player to set the position for.\n-- @param\ti\t\t\t\tnumber\tThe index to set the position at.\n-- @param\tpos\t\t\t\tVector3\tThe position to set.\n-- @returns\tbool\t\t\tWhether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time).\nlocal function set(player_name, i, pos)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to set the position for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set the position for."
		},
		{
			"directive": "param",
			"text": "i\t\t\t\tnumber\tThe index to set the position at.",
			"name": "i",
			"type": "number",
			"description": "The index to set the position at."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3\tThe position to set.",
			"name": "pos",
			"type": "Vector3",
			"description": "The position to set."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\t\t\tWhether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time).",
		"type": "bool",
		"description": "Whether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time)."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.set",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L188-L194"
}

--- Sets the all the positions for the given player.
-- You probably want push_pos, not this function.
-- 
-- WARNING: Will DELETE all points registered for the given player!
-- 
-- @param	player_name		string	The name of the player to set the positions for.
-- @param	pos_list		Vector3	The table of positions to set.
-- @returns	bool			Whether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time).
local function set_all(player_name, pos_list)

{
	"type": "function",
	"internal": false,
	"description": "Sets the all the positions for the given player.\nYou probably want push_pos, not this function.\n\nWARNING: Will DELETE all points registered for the given player!\n",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to set the positions for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set the positions for."
		},
		{
			"directive": "param",
			"text": "pos_list\t\tVector3\tThe table of positions to set.",
			"name": "pos_list",
			"type": "Vector3",
			"description": "The table of positions to set."
		},
		{
			"directive": "returns",
			"text": "bool\t\t\tWhether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time).",
			"type": "bool",
			"description": "Whether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time)."
		}
	],
	"line": 229,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 237,
	"name": "set_all",
	"instanced": false,
	"args": [
		"player_name",
		"pos_list"
	],
	"text": "--- Sets the all the positions for the given player.\n-- You probably want push_pos, not this function.\n-- \n-- WARNING: Will DELETE all points registered for the given player!\n-- \n-- @param\tplayer_name\t\tstring\tThe name of the player to set the positions for.\n-- @param\tpos_list\t\tVector3\tThe table of positions to set.\n-- @returns\tbool\t\t\tWhether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time).\nlocal function set_all(player_name, pos_list)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to set the positions for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set the positions for."
		},
		{
			"directive": "param",
			"text": "pos_list\t\tVector3\tThe table of positions to set.",
			"name": "pos_list",
			"type": "Vector3",
			"description": "The table of positions to set."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\t\t\tWhether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time).",
		"type": "bool",
		"description": "Whether the operation was successful or not (players aren't allowed more than positions_count_limit number of positions at a time)."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.set_all",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L230-L238"
}

--- Sets multiple positions for the given player.
-- @param	player_name		string				The name of the player to set the positions for.
-- @param	pos_list		table<int, Vector3>	A table of Vector3 positions to set, where the key is the index and the value is the position.
local function set_multi(player_name, pos_list)

{
	"type": "function",
	"internal": false,
	"description": "Sets multiple positions for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\t\t\t\tThe name of the player to set the positions for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set the positions for."
		},
		{
			"directive": "param",
			"text": "pos_list\t\ttable<int, Vector3>\tA table of Vector3 positions to set, where the key is the index and the value is the position.",
			"name": "pos_list",
			"type": "table<int, Vector3>",
			"description": "A table of Vector3 positions to set, where the key is the index and the value is the position."
		}
	],
	"line": 220,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 223,
	"name": "set_multi",
	"instanced": false,
	"args": [
		"player_name",
		"pos_list"
	],
	"text": "--- Sets multiple positions for the given player.\n-- @param\tplayer_name\t\tstring\t\t\t\tThe name of the player to set the positions for.\n-- @param\tpos_list\t\ttable<int, Vector3>\tA table of Vector3 positions to set, where the key is the index and the value is the position.\nlocal function set_multi(player_name, pos_list)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\t\t\t\tThe name of the player to set the positions for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set the positions for."
		},
		{
			"directive": "param",
			"text": "pos_list\t\ttable<int, Vector3>\tA table of Vector3 positions to set, where the key is the index and the value is the position.",
			"name": "pos_list",
			"type": "table<int, Vector3>",
			"description": "A table of Vector3 positions to set, where the key is the index and the value is the position."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.pos.set_multi",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L221-L224"
}

--- Convenience function that set position 1 for the given player.
-- @param	player_name		string		The name of the player to set pos1 for.
-- @param	pos				Vector3?	The new Vector3 for pos1 to set.
-- @returns	bool			Whether the operation was successful or not, but in this case will always return true so can be ignored.
local function set1(player_name, pos)

{
	"type": "function",
	"internal": false,
	"description": "Convenience function that set position 1 for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\t\tThe name of the player to set pos1 for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set pos1 for."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3?\tThe new Vector3 for pos1 to set.",
			"name": "pos",
			"type": "Vector3?",
			"description": "The new Vector3 for pos1 to set."
		},
		{
			"directive": "returns",
			"text": "bool\t\t\tWhether the operation was successful or not, but in this case will always return true so can be ignored.",
			"type": "bool",
			"description": "Whether the operation was successful or not, but in this case will always return true so can be ignored."
		}
	],
	"line": 205,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 209,
	"name": "set1",
	"instanced": false,
	"args": [
		"player_name",
		"pos"
	],
	"text": "--- Convenience function that set position 1 for the given player.\n-- @param\tplayer_name\t\tstring\t\tThe name of the player to set pos1 for.\n-- @param\tpos\t\t\t\tVector3?\tThe new Vector3 for pos1 to set.\n-- @returns\tbool\t\t\tWhether the operation was successful or not, but in this case will always return true so can be ignored.\nlocal function set1(player_name, pos)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\t\tThe name of the player to set pos1 for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set pos1 for."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3?\tThe new Vector3 for pos1 to set.",
			"name": "pos",
			"type": "Vector3?",
			"description": "The new Vector3 for pos1 to set."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\t\t\tWhether the operation was successful or not, but in this case will always return true so can be ignored.",
		"type": "bool",
		"description": "Whether the operation was successful or not, but in this case will always return true so can be ignored."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.set1",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L206-L210"
}

--- Convenience function that set position 2 for the given player.
-- @param	player_name		string		The name of the player to set pos1 for.
-- @param	pos				Vector3?	The new Vector3 for pos2 to set.
-- @returns	bool			Whether the operation was successful or not, but in this case will always return true so can be ignored.
local function set2(player_name, pos)

{
	"type": "function",
	"internal": false,
	"description": "Convenience function that set position 2 for the given player.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\t\tThe name of the player to set pos1 for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set pos1 for."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3?\tThe new Vector3 for pos2 to set.",
			"name": "pos",
			"type": "Vector3?",
			"description": "The new Vector3 for pos2 to set."
		},
		{
			"directive": "returns",
			"text": "bool\t\t\tWhether the operation was successful or not, but in this case will always return true so can be ignored.",
			"type": "bool",
			"description": "Whether the operation was successful or not, but in this case will always return true so can be ignored."
		}
	],
	"line": 212,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 216,
	"name": "set2",
	"instanced": false,
	"args": [
		"player_name",
		"pos"
	],
	"text": "--- Convenience function that set position 2 for the given player.\n-- @param\tplayer_name\t\tstring\t\tThe name of the player to set pos1 for.\n-- @param\tpos\t\t\t\tVector3?\tThe new Vector3 for pos2 to set.\n-- @returns\tbool\t\t\tWhether the operation was successful or not, but in this case will always return true so can be ignored.\nlocal function set2(player_name, pos)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\t\tThe name of the player to set pos1 for.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to set pos1 for."
		},
		{
			"directive": "param",
			"text": "pos\t\t\t\tVector3?\tThe new Vector3 for pos2 to set.",
			"name": "pos",
			"type": "Vector3?",
			"description": "The new Vector3 for pos2 to set."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\t\t\tWhether the operation was successful or not, but in this case will always return true so can be ignored.",
		"type": "bool",
		"description": "Whether the operation was successful or not, but in this case will always return true so can be ignored."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.set2",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L213-L217"
}

--- Hides the visual markers for the given player's positions and defined region, but does not clear the points.
-- @param	player_name		string	The name of the player to operate on.
-- @param	markers=true	bool	Whether to hide positional markers.
-- @param	walls=true		bool	Whether to hide the marker walls.
-- @returns	void
local function unmark(player_name, markers, walls)

{
	"type": "function",
	"internal": false,
	"description": "Hides the visual markers for the given player's positions and defined region, but does not clear the points.",
	"directives": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to operate on.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to operate on."
		},
		{
			"directive": "param",
			"text": "markers=true\tbool\tWhether to hide positional markers.",
			"name": "markers",
			"type": "bool",
			"description": "Whether to hide positional markers.",
			"default_value": "true"
		},
		{
			"directive": "param",
			"text": "walls=true\t\tbool\tWhether to hide the marker walls.",
			"name": "walls",
			"type": "bool",
			"description": "Whether to hide the marker walls.",
			"default_value": "true"
		},
		{
			"directive": "returns",
			"text": "void",
			"type": "void"
		}
	],
	"line": 292,
	"namespace": "worldeditadditions_core.pos",
	"line_last": 297,
	"name": "unmark",
	"instanced": false,
	"args": [
		"player_name",
		"markers",
		"walls"
	],
	"text": "--- Hides the visual markers for the given player's positions and defined region, but does not clear the points.\n-- @param\tplayer_name\t\tstring\tThe name of the player to operate on.\n-- @param\tmarkers=true\tbool\tWhether to hide positional markers.\n-- @param\twalls=true\t\tbool\tWhether to hide the marker walls.\n-- @returns\tvoid\nlocal function unmark(player_name, markers, walls)",
	"params": [
		{
			"directive": "param",
			"text": "player_name\t\tstring\tThe name of the player to operate on.",
			"name": "player_name",
			"type": "string",
			"description": "The name of the player to operate on."
		},
		{
			"directive": "param",
			"text": "markers=true\tbool\tWhether to hide positional markers.",
			"name": "markers",
			"type": "bool",
			"description": "Whether to hide positional markers.",
			"default_value": "true"
		},
		{
			"directive": "param",
			"text": "walls=true\t\tbool\tWhether to hide the marker walls.",
			"name": "walls",
			"type": "bool",
			"description": "Whether to hide the marker walls.",
			"default_value": "true"
		}
	],
	"returns": {
		"directive": "returns",
		"text": "void",
		"type": "void"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.pos.unmark",
	"filename": "worldeditadditions_core/core/pos.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/core/pos.lua#L293-L298"
}

--- Creates a new Promise instance.
-- @param fn 	function	The function to wrap into a promise.
function Promise.new(fn)

{
	"type": "function",
	"internal": false,
	"description": "Creates a new Promise instance.",
	"directives": [
		{
			"directive": "param",
			"text": "fn \tfunction\tThe function to wrap into a promise.",
			"name": "fn ",
			"type": "function",
			"description": "The function to wrap into a promise."
		}
	],
	"line": 14,
	"namespace": "worldeditadditions_core.Promise",
	"line_last": 16,
	"name": "new",
	"instanced": false,
	"args": [
		"fn"
	],
	"text": "--- Creates a new Promise instance.\n-- @param fn \tfunction\tThe function to wrap into a promise.\nfunction Promise.new(fn)",
	"params": [
		{
			"directive": "param",
			"text": "fn \tfunction\tThe function to wrap into a promise.",
			"name": "fn ",
			"type": "function",
			"description": "The function to wrap into a promise."
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.Promise.new",
	"filename": "promise.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/promise.lua#L15-L17"
}

--- Executes the function this Promise is wrapping all associated chained functions in sequence.
-- This is a separate method for portability, since Lua does not implement setTimeout which is required to ensure that if an non-async function is wrapped the parent function still has time to call .then_() before it finishes and the associated .then_()ed functions are attached correctly.
-- 
-- WARNING: If you call .then_() AFTER calling .run(), your .then_()ed function may not be called correctly!
-- @returns	Promise	The current promise, for daisy chaining purposes.
function Promise.run(self)

{
	"type": "function",
	"internal": false,
	"description": "Executes the function this Promise is wrapping all associated chained functions in sequence.\nThis is a separate method for portability, since Lua does not implement setTimeout which is required to ensure that if an non-async function is wrapped the parent function still has time to call .then_() before it finishes and the associated .then_()ed functions are attached correctly.\n\nWARNING: If you call .then_() AFTER calling .run(), your .then_()ed function may not be called correctly!",
	"directives": [
		{
			"directive": "returns",
			"text": "Promise\tThe current promise, for daisy chaining purposes.",
			"type": "Promise",
			"description": "The current promise, for daisy chaining purposes."
		}
	],
	"line": 127,
	"namespace": "worldeditadditions_core.Promise",
	"line_last": 132,
	"name": "run",
	"instanced": false,
	"args": [
		"self"
	],
	"text": "--- Executes the function this Promise is wrapping all associated chained functions in sequence.\n-- This is a separate method for portability, since Lua does not implement setTimeout which is required to ensure that if an non-async function is wrapped the parent function still has time to call .then_() before it finishes and the associated .then_()ed functions are attached correctly.\n-- \n-- WARNING: If you call .then_() AFTER calling .run(), your .then_()ed function may not be called correctly!\n-- @returns\tPromise\tThe current promise, for daisy chaining purposes.\nfunction Promise.run(self)",
	"params": [],
	"returns": {
		"directive": "returns",
		"text": "Promise\tThe current promise, for daisy chaining purposes.",
		"type": "Promise",
		"description": "The current promise, for daisy chaining purposes."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Promise.run",
	"filename": "promise.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/promise.lua#L128-L133"
}

--- Determines whether a  given value is present in this queue or not.
-- @param	value	any		The value to check.
-- @returns	bool	Whether the given value exists in the queue or not.
function Queue:contains(value)

{
	"type": "function",
	"internal": false,
	"description": "Determines whether a  given value is present in this queue or not.",
	"directives": [
		{
			"directive": "param",
			"text": "value\tany\t\tThe value to check.",
			"name": "value",
			"type": "any",
			"description": "The value to check."
		},
		{
			"directive": "returns",
			"text": "bool\tWhether the given value exists in the queue or not.",
			"type": "bool",
			"description": "Whether the given value exists in the queue or not."
		}
	],
	"line": 25,
	"namespace": "worldeditadditions_core.Queue",
	"line_last": 28,
	"name": "contains",
	"instanced": true,
	"args": [
		"value"
	],
	"text": "--- Determines whether a  given value is present in this queue or not.\n-- @param\tvalue\tany\t\tThe value to check.\n-- @returns\tbool\tWhether the given value exists in the queue or not.\nfunction Queue:contains(value)",
	"params": [
		{
			"directive": "param",
			"text": "value\tany\t\tThe value to check.",
			"name": "value",
			"type": "any",
			"description": "The value to check."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\tWhether the given value exists in the queue or not.",
		"type": "bool",
		"description": "Whether the given value exists in the queue or not."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Queue.contains",
	"filename": "worldeditadditions_core/utils/queue.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/queue.lua#L26-L29"
}

--- Dequeues an item from the front of the queue.
-- @returns		any|nil		Returns the item at the front of the queue, or nil if no items are currently enqueued. 
function Queue:dequeue()

{
	"type": "function",
	"internal": false,
	"description": "Dequeues an item from the front of the queue.",
	"directives": [
		{
			"directive": "returns",
			"text": "any|nil\t\tReturns the item at the front of the queue, or nil if no items are currently enqueued.",
			"type": "any|nil",
			"description": "Returns the item at the front of the queue, or nil if no items are currently enqueued."
		}
	],
	"line": 51,
	"namespace": "worldeditadditions_core.Queue",
	"line_last": 53,
	"name": "dequeue",
	"instanced": true,
	"args": [
		""
	],
	"text": "--- Dequeues an item from the front of the queue.\n-- @returns\t\tany|nil\t\tReturns the item at the front of the queue, or nil if no items are currently enqueued. \nfunction Queue:dequeue()",
	"params": [],
	"returns": {
		"directive": "returns",
		"text": "any|nil\t\tReturns the item at the front of the queue, or nil if no items are currently enqueued.",
		"type": "any|nil",
		"description": "Returns the item at the front of the queue, or nil if no items are currently enqueued."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Queue.dequeue",
	"filename": "worldeditadditions_core/utils/queue.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/queue.lua#L52-L54"
}

--- Adds a new value to the end of the queue.
-- @param	value	any		The new value to add to the end of the queue.
-- @returns	number	The index of the value that was added to the queue.
function Queue:enqueue(value)

{
	"type": "function",
	"internal": false,
	"description": "Adds a new value to the end of the queue.",
	"directives": [
		{
			"directive": "param",
			"text": "value\tany\t\tThe new value to add to the end of the queue.",
			"name": "value",
			"type": "any",
			"description": "The new value to add to the end of the queue."
		},
		{
			"directive": "returns",
			"text": "number\tThe index of the value that was added to the queue.",
			"type": "number",
			"description": "The index of the value that was added to the queue."
		}
	],
	"line": 15,
	"namespace": "worldeditadditions_core.Queue",
	"line_last": 18,
	"name": "enqueue",
	"instanced": true,
	"args": [
		"value"
	],
	"text": "--- Adds a new value to the end of the queue.\n-- @param\tvalue\tany\t\tThe new value to add to the end of the queue.\n-- @returns\tnumber\tThe index of the value that was added to the queue.\nfunction Queue:enqueue(value)",
	"params": [
		{
			"directive": "param",
			"text": "value\tany\t\tThe new value to add to the end of the queue.",
			"name": "value",
			"type": "any",
			"description": "The new value to add to the end of the queue."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "number\tThe index of the value that was added to the queue.",
		"type": "number",
		"description": "The index of the value that was added to the queue."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Queue.enqueue",
	"filename": "worldeditadditions_core/utils/queue.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/queue.lua#L16-L19"
}

--- Returns whether the queue is empty or not.
-- @returns	bool	Whether the queue is empty or not.
function Queue:is_empty()

{
	"type": "function",
	"internal": false,
	"description": "Returns whether the queue is empty or not.",
	"directives": [
		{
			"directive": "returns",
			"text": "bool\tWhether the queue is empty or not.",
			"type": "bool",
			"description": "Whether the queue is empty or not."
		}
	],
	"line": 37,
	"namespace": "worldeditadditions_core.Queue",
	"line_last": 39,
	"name": "is_empty",
	"instanced": true,
	"args": [
		""
	],
	"text": "--- Returns whether the queue is empty or not.\n-- @returns\tbool\tWhether the queue is empty or not.\nfunction Queue:is_empty()",
	"params": [],
	"returns": {
		"directive": "returns",
		"text": "bool\tWhether the queue is empty or not.",
		"type": "bool",
		"description": "Whether the queue is empty or not."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Queue.is_empty",
	"filename": "worldeditadditions_core/utils/queue.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/queue.lua#L38-L40"
}

--- Creates a new queue instance.
-- @returns	Queue
function Queue.new()

{
	"type": "function",
	"internal": false,
	"description": "Creates a new queue instance.",
	"directives": [
		{
			"directive": "returns",
			"text": "Queue",
			"type": "Queue"
		}
	],
	"line": 7,
	"namespace": "worldeditadditions_core.Queue",
	"line_last": 9,
	"name": "new",
	"instanced": false,
	"args": [
		""
	],
	"text": "--- Creates a new queue instance.\n-- @returns\tQueue\nfunction Queue.new()",
	"params": [],
	"returns": {
		"directive": "returns",
		"text": "Queue",
		"type": "Queue"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Queue.new",
	"filename": "worldeditadditions_core/utils/queue.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/queue.lua#L8-L10"
}

--- Removes the item with the given index from the queue.
-- Item indexes do not change as the items in a queue are added and removed.
-- @param		number		The index of the item to remove from the queue.
-- @returns		nil
function Queue:remove_index(index)

{
	"type": "function",
	"internal": false,
	"description": "Removes the item with the given index from the queue.\nItem indexes do not change as the items in a queue are added and removed.",
	"directives": [
		{
			"directive": "param",
			"text": "number\t\tThe index of the item to remove from the queue.",
			"name": "number",
			"type": "The index of the item to remove from the queue."
		},
		{
			"directive": "returns",
			"text": "nil",
			"type": "nil"
		}
	],
	"line": 43,
	"namespace": "worldeditadditions_core.Queue",
	"line_last": 47,
	"name": "remove_index",
	"instanced": true,
	"args": [
		"index"
	],
	"text": "--- Removes the item with the given index from the queue.\n-- Item indexes do not change as the items in a queue are added and removed.\n-- @param\t\tnumber\t\tThe index of the item to remove from the queue.\n-- @returns\t\tnil\nfunction Queue:remove_index(index)",
	"params": [
		{
			"directive": "param",
			"text": "number\t\tThe index of the item to remove from the queue.",
			"name": "number",
			"type": "The index of the item to remove from the queue."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "nil",
		"type": "nil"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Queue.remove_index",
	"filename": "worldeditadditions_core/utils/queue.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/queue.lua#L44-L48"
}

--- Applies a given list of rotations rotlist to rotate pos1 and pos2 around a given origin, and returns a pos1/pos2 pair of a region that bounds the rotated area.
-- The returned pos1/pos2 are guaranteed to be integer values that fully enclose the rotated region. This function is designed to be used to e.g. find the bounds of a region to pass to a VoxelManip to ensure we grab everything.
-- @param	pos1	Vector3		Position 1 to rotate.
-- @param	pos2	Vector3		Position 2 to rotate.
-- @param	origin	Vector3		The position to rotate pos1 and pos2 around. May be a decimal value.
-- @param	rotlist	table<{axis: string, rad: number}>	The list of rotations. Rotations will be processed in order. Each rotation is a table with a SINGLE axis as a string (x, y, z, -x, -y, or -z; the axis parameter), and an amount in radians to rotate by (the rad parameter). See worldeditadditions.rotate() for more information.
-- @returns	Vector3,Vector3	A pos1 & pos2 that fully enclose the rotated region as described above.
local function find_rotated_vm(pos1, pos2, origin, rotlist)

{
	"type": "function",
	"internal": false,
	"description": "Applies a given list of rotations rotlist to rotate pos1 and pos2 around a given origin, and returns a pos1/pos2 pair of a region that bounds the rotated area.\nThe returned pos1/pos2 are guaranteed to be integer values that fully enclose the rotated region. This function is designed to be used to e.g. find the bounds of a region to pass to a VoxelManip to ensure we grab everything.",
	"directives": [
		{
			"directive": "param",
			"text": "pos1\tVector3\t\tPosition 1 to rotate.",
			"name": "pos1",
			"type": "Vector3",
			"description": "Position 1 to rotate."
		},
		{
			"directive": "param",
			"text": "pos2\tVector3\t\tPosition 2 to rotate.",
			"name": "pos2",
			"type": "Vector3",
			"description": "Position 2 to rotate."
		},
		{
			"directive": "param",
			"text": "origin\tVector3\t\tThe position to rotate pos1 and pos2 around. May be a decimal value.",
			"name": "origin",
			"type": "Vector3",
			"description": "The position to rotate pos1 and pos2 around. May be a decimal value."
		},
		{
			"directive": "param",
			"text": "rotlist\ttable<{axis: string, rad: number}>\tThe list of rotations. Rotations will be processed in order. Each rotation is a table with a SINGLE axis as a string (x, y, z, -x, -y, or -z; the axis parameter), and an amount in radians to rotate by (the rad parameter). See worldeditadditions.rotate() for more information.",
			"name": "rotlist",
			"type": "table<{axis: string, rad: number}>",
			"description": "The list of rotations. Rotations will be processed in order. Each rotation is a table with a SINGLE axis as a string (x, y, z, -x, -y, or -z; the axis parameter), and an amount in radians to rotate by (the rad parameter). See worldeditadditions.rotate() for more information."
		},
		{
			"directive": "returns",
			"text": "Vector3,Vector3\tA pos1 & pos2 that fully enclose the rotated region as described above.",
			"type": "Vector3,Vector3",
			"description": "A pos1 & pos2 that fully enclose the rotated region as described above."
		}
	],
	"line": 42,
	"namespace": "worldeditadditions_core.rotation",
	"line_last": 49,
	"name": "find_rotated_vm",
	"instanced": false,
	"args": [
		"pos1",
		"pos2",
		"origin",
		"rotlist"
	],
	"text": "--- Applies a given list of rotations rotlist to rotate pos1 and pos2 around a given origin, and returns a pos1/pos2 pair of a region that bounds the rotated area.\n-- The returned pos1/pos2 are guaranteed to be integer values that fully enclose the rotated region. This function is designed to be used to e.g. find the bounds of a region to pass to a VoxelManip to ensure we grab everything.\n-- @param\tpos1\tVector3\t\tPosition 1 to rotate.\n-- @param\tpos2\tVector3\t\tPosition 2 to rotate.\n-- @param\torigin\tVector3\t\tThe position to rotate pos1 and pos2 around. May be a decimal value.\n-- @param\trotlist\ttable<{axis: string, rad: number}>\tThe list of rotations. Rotations will be processed in order. Each rotation is a table with a SINGLE axis as a string (x, y, z, -x, -y, or -z; the axis parameter), and an amount in radians to rotate by (the rad parameter). See worldeditadditions.rotate() for more information.\n-- @returns\tVector3,Vector3\tA pos1 & pos2 that fully enclose the rotated region as described above.\nlocal function find_rotated_vm(pos1, pos2, origin, rotlist)",
	"params": [
		{
			"directive": "param",
			"text": "pos1\tVector3\t\tPosition 1 to rotate.",
			"name": "pos1",
			"type": "Vector3",
			"description": "Position 1 to rotate."
		},
		{
			"directive": "param",
			"text": "pos2\tVector3\t\tPosition 2 to rotate.",
			"name": "pos2",
			"type": "Vector3",
			"description": "Position 2 to rotate."
		},
		{
			"directive": "param",
			"text": "origin\tVector3\t\tThe position to rotate pos1 and pos2 around. May be a decimal value.",
			"name": "origin",
			"type": "Vector3",
			"description": "The position to rotate pos1 and pos2 around. May be a decimal value."
		},
		{
			"directive": "param",
			"text": "rotlist\ttable<{axis: string, rad: number}>\tThe list of rotations. Rotations will be processed in order. Each rotation is a table with a SINGLE axis as a string (x, y, z, -x, -y, or -z; the axis parameter), and an amount in radians to rotate by (the rad parameter). See worldeditadditions.rotate() for more information.",
			"name": "rotlist",
			"type": "table<{axis: string, rad: number}>",
			"description": "The list of rotations. Rotations will be processed in order. Each rotation is a table with a SINGLE axis as a string (x, y, z, -x, -y, or -z; the axis parameter), and an amount in radians to rotate by (the rad parameter). See worldeditadditions.rotate() for more information."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "Vector3,Vector3\tA pos1 & pos2 that fully enclose the rotated region as described above.",
		"type": "Vector3,Vector3",
		"description": "A pos1 & pos2 that fully enclose the rotated region as described above."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.rotation.find_rotated_vm",
	"filename": "worldeditadditions_core/utils/rotation.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/rotation.lua#L43-L50"
}

--- Adds item(s) to set.
-- @param	a	set	Set to manipulate.
-- @param	i	not nil	Values(s) to add.
-- @returns	bool	Success of operation.
function Set.add(a,i)

{
	"type": "function",
	"internal": false,
	"description": "Adds item(s) to set.",
	"directives": [
		{
			"directive": "param",
			"text": "a\tset\tSet to manipulate.",
			"name": "a",
			"type": "set",
			"description": "Set to manipulate."
		},
		{
			"directive": "param",
			"text": "i\tnot nil\tValues(s) to add.",
			"name": "i",
			"type": "not nil",
			"description": "Values(s) to add."
		},
		{
			"directive": "returns",
			"text": "bool\tSuccess of operation.",
			"type": "bool",
			"description": "Success of operation."
		}
	],
	"line": 44,
	"namespace": "worldeditadditions_core.Set",
	"line_last": 48,
	"name": "add",
	"instanced": false,
	"args": [
		"a",
		"i"
	],
	"text": "--- Adds item(s) to set.\n-- @param\ta\tset\tSet to manipulate.\n-- @param\ti\tnot nil\tValues(s) to add.\n-- @returns\tbool\tSuccess of operation.\nfunction Set.add(a,i)",
	"params": [
		{
			"directive": "param",
			"text": "a\tset\tSet to manipulate.",
			"name": "a",
			"type": "set",
			"description": "Set to manipulate."
		},
		{
			"directive": "param",
			"text": "i\tnot nil\tValues(s) to add.",
			"name": "i",
			"type": "not nil",
			"description": "Values(s) to add."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\tSuccess of operation.",
		"type": "bool",
		"description": "Success of operation."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Set.add",
	"filename": "worldeditadditions_core/utils/set.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/set.lua#L45-L49"
}

--- Deletes item(s) from set.
-- @param	a	set	Set to manipulate.
-- @param	i	not nil	Values(s) to delete.
-- @returns	bool	Success of operation.
function Set.delete(a,i)

{
	"type": "function",
	"internal": false,
	"description": "Deletes item(s) from set.",
	"directives": [
		{
			"directive": "param",
			"text": "a\tset\tSet to manipulate.",
			"name": "a",
			"type": "set",
			"description": "Set to manipulate."
		},
		{
			"directive": "param",
			"text": "i\tnot nil\tValues(s) to delete.",
			"name": "i",
			"type": "not nil",
			"description": "Values(s) to delete."
		},
		{
			"directive": "returns",
			"text": "bool\tSuccess of operation.",
			"type": "bool",
			"description": "Success of operation."
		}
	],
	"line": 57,
	"namespace": "worldeditadditions_core.Set",
	"line_last": 61,
	"name": "delete",
	"instanced": false,
	"args": [
		"a",
		"i"
	],
	"text": "--- Deletes item(s) from set.\n-- @param\ta\tset\tSet to manipulate.\n-- @param\ti\tnot nil\tValues(s) to delete.\n-- @returns\tbool\tSuccess of operation.\nfunction Set.delete(a,i)",
	"params": [
		{
			"directive": "param",
			"text": "a\tset\tSet to manipulate.",
			"name": "a",
			"type": "set",
			"description": "Set to manipulate."
		},
		{
			"directive": "param",
			"text": "i\tnot nil\tValues(s) to delete.",
			"name": "i",
			"type": "not nil",
			"description": "Values(s) to delete."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\tSuccess of operation.",
		"type": "bool",
		"description": "Success of operation."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Set.delete",
	"filename": "worldeditadditions_core/utils/set.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/set.lua#L58-L62"
}

--- Checks if value(s) are present in set.
-- @param	a	set	Set to inspect.
-- @param	i	not nil	Values(s) to check.
-- @returns	bool	Value(s) are present?
function Set.has(a,i)

{
	"type": "function",
	"internal": false,
	"description": "Checks if value(s) are present in set.",
	"directives": [
		{
			"directive": "param",
			"text": "a\tset\tSet to inspect.",
			"name": "a",
			"type": "set",
			"description": "Set to inspect."
		},
		{
			"directive": "param",
			"text": "i\tnot nil\tValues(s) to check.",
			"name": "i",
			"type": "not nil",
			"description": "Values(s) to check."
		},
		{
			"directive": "returns",
			"text": "bool\tValue(s) are present?",
			"type": "bool",
			"description": "Value(s) are present?"
		}
	],
	"line": 70,
	"namespace": "worldeditadditions_core.Set",
	"line_last": 74,
	"name": "has",
	"instanced": false,
	"args": [
		"a",
		"i"
	],
	"text": "--- Checks if value(s) are present in set.\n-- @param\ta\tset\tSet to inspect.\n-- @param\ti\tnot nil\tValues(s) to check.\n-- @returns\tbool\tValue(s) are present?\nfunction Set.has(a,i)",
	"params": [
		{
			"directive": "param",
			"text": "a\tset\tSet to inspect.",
			"name": "a",
			"type": "set",
			"description": "Set to inspect."
		},
		{
			"directive": "param",
			"text": "i\tnot nil\tValues(s) to check.",
			"name": "i",
			"type": "not nil",
			"description": "Values(s) to check."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "bool\tValue(s) are present?",
		"type": "bool",
		"description": "Value(s) are present?"
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Set.has",
	"filename": "worldeditadditions_core/utils/set.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/set.lua#L71-L75"
}

--- Creates a new set.
-- @param	i	any	Initial values(s) of the set.
-- @returns	Set	A table of keys equal to true.
function Set.new(i)

{
	"type": "function",
	"internal": false,
	"description": "Creates a new set.",
	"directives": [
		{
			"directive": "param",
			"text": "i\tany\tInitial values(s) of the set.",
			"name": "i",
			"type": "any",
			"description": "Initial values(s) of the set."
		},
		{
			"directive": "returns",
			"text": "Set\tA table of keys equal to true.",
			"type": "Set",
			"description": "A table of keys equal to true."
		}
	],
	"line": 29,
	"namespace": "worldeditadditions_core.Set",
	"line_last": 32,
	"name": "new",
	"instanced": false,
	"args": [
		"i"
	],
	"text": "--- Creates a new set.\n-- @param\ti\tany\tInitial values(s) of the set.\n-- @returns\tSet\tA table of keys equal to true.\nfunction Set.new(i)",
	"params": [
		{
			"directive": "param",
			"text": "i\tany\tInitial values(s) of the set.",
			"name": "i",
			"type": "any",
			"description": "Initial values(s) of the set."
		}
	],
	"returns": {
		"directive": "returns",
		"text": "Set\tA table of keys equal to true.",
		"type": "Set",
		"description": "A table of keys equal to true."
	},
	"examples": [],
	"name_full": "worldeditadditions_core.Set.new",
	"filename": "worldeditadditions_core/utils/set.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/set.lua#L30-L33"
}

--- SHALLOW ONLY - applies the values in source to overwrite the equivalent keys in `target`.
-- Warning: This function mutates `target`!
-- @param	source	table	The source to take values from
-- @param	target	table	The target to write values to
local function apply(source, target)

{
	"type": "function",
	"internal": false,
	"description": "SHALLOW ONLY - applies the values in source to overwrite the equivalent keys in `target`.\nWarning: This function mutates `target`!",
	"directives": [
		{
			"directive": "param",
			"text": "source\ttable\tThe source to take values from",
			"name": "source",
			"type": "table",
			"description": "The source to take values from"
		},
		{
			"directive": "param",
			"text": "target\ttable\tThe target to write values to",
			"name": "target",
			"type": "table",
			"description": "The target to write values to"
		}
	],
	"line": 3,
	"namespace": "worldeditadditions_core.table",
	"line_last": 7,
	"name": "apply",
	"instanced": false,
	"args": [
		"source",
		"target"
	],
	"text": "--- SHALLOW ONLY - applies the values in source to overwrite the equivalent keys in `target`.\n-- Warning: This function mutates `target`!\n-- @param\tsource\ttable\tThe source to take values from\n-- @param\ttarget\ttable\tThe target to write values to\nlocal function apply(source, target)",
	"params": [
		{
			"directive": "param",
			"text": "source\ttable\tThe source to take values from",
			"name": "source",
			"type": "table",
			"description": "The source to take values from"
		},
		{
			"directive": "param",
			"text": "target\ttable\tThe target to write values to",
			"name": "target",
			"type": "table",
			"description": "The target to write values to"
		}
	],
	"examples": [],
	"name_full": "worldeditadditions_core.table.apply",
	"filename": "worldeditadditions_core/utils/table/table_apply.lua",
	"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/worldeditadditions_core/utils/table/table_apply.lua#L4-L8"
}