Minetest/VoxeLibre
2
0
Fork 0
mirror of https://git.minetest.land/VoxeLibre/VoxeLibre.git synced 2024-11-23 02:51:06 +01:00
Code Issues Projects Releases Packages Wiki Activity
VoxeLibre/mods/HUD/mcl_info/API.md
Mikita Wiśniewski 19d662dee4 Fix some typos in the API documentation (#4630) 
Reviewed-on: https://git.minetest.land/VoxeLibre/VoxeLibre/pulls/4630
Reviewed-by: teknomunk <teknomunk@protonmail.com>
Co-authored-by: Mikita Wiśniewski <rudzik8@protonmail.com>
Co-committed-by: Mikita Wiśniewski <rudzik8@protonmail.com>
2024-09-12 18:13:52 +02:00

642 B
Raw Blame History

mcl_info

An API to make custom entries in the VL debug hud.

mcl_info.register_debug_field(name,defintion)

Debug field defintion example:

{
	level = 3,
	--show with debug level 3 and upwards

	func = function(player,pos) return minetest.pos_to_string(pos) end,
	-- Function that is run for at each debug
	-- sample (default: every .63 seconds)
	-- It should output a string and determines
	-- the content of the debug field.
}

mcl_info.registered_debug_fields

Table the debug definitions are stored in. Do not modify this directly. If you need to overwrite a field just set it again with mcl_info.register_debug_field().