diff options
| author | Tim <t4im@users.noreply.github.com> | 2016-07-12 21:51:10 +0200 |
|---|---|---|
| committer | est31 <est31@users.noreply.github.com> | 2016-07-12 21:51:10 +0200 |
| commit | d7060c212f3d9fb9a69719e9041fdef1f5792fef (patch) | |
| tree | df72254447aa53a74d5d7c00174a088300acecaa /doc/lua_api.txt | |
| parent | d6865c4d8d0eb7aaf2d35447ab01e06ef8249010 (diff) | |
| download | minetest-d7060c212f3d9fb9a69719e9041fdef1f5792fef.tar.gz minetest-d7060c212f3d9fb9a69719e9041fdef1f5792fef.tar.bz2 minetest-d7060c212f3d9fb9a69719e9041fdef1f5792fef.zip | |
Builtin/profiler: Replace game profiler (#4245)
Use the setting "profiler.load" to enable profiling.
Other settings can be found in settingtypes.txt.
* /profiler print [filter] - report statistics to in-game console
* /profiler dump [filter] - report statistics to STDOUT and debug.txt
* /profiler save [format [filter]] - saves statistics to a file in your worldpath
* txt (default) - same treetable format as used by the dump and print commands
* csv - ready for spreadsheet import
* json - useful for adhoc D3 visualizations
* json_pretty - line wrapped and intended json for humans
* lua - serialized lua table of the profile-data, for adhoc scripts
* /profiler reset - reset all gathered profile data.
This can be helpful to discard of any startup measurements that often spike during loading or to get more useful min-values.
[filter] allows limiting the output of the data via substring/pattern matching against the modname.
Note: Serialized data structures might be subject to change with changed or added measurements.
csv might be the most stable, due to flat structure.
Changes to the previous version include:
* Updated and extended API monitoring
* Correct calculation of average (mean) values (undistorted by idleness)
* Reduce instrumentation overhead.
* Fix crashes related to missing parameters for the future and occasional DIV/0's.
* Prevent issues caused by timetravel (overflow, timejump, NTP corrections)
* Prevent modname clashes with internal names.
* Measure each instrumentation individually and label based on registration order.
* Labeling of ABM's and LBM's for easier classification.
Giving several ABM's or LBM's the same label will treat them as one.
Missing labels will be autogenerated based on name or registration order.
* Configurable instrumentation and reporting. Skip e.g. builtin if you don't need it.
* Profile the profiler to measure instrumentation overhead.
Diffstat (limited to 'doc/lua_api.txt')
| -rw-r--r-- | doc/lua_api.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 12b0a9299..e1077a2bb 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -3423,6 +3423,9 @@ Definition tables ### ABM (ActiveBlockModifier) definition (`register_abm`) { + label = "Lava cooling", + -- ^ Descriptive label for profiling purposes (optional). + -- Definitions with identical labels will be listed as one. -- In the following two fields, also group:groupname will work. nodenames = {"default:lava_source"}, neighbors = {"default:water_source", "default:water_flowing"}, -- Any of these --[[ @@ -3439,6 +3442,9 @@ Definition tables ### LBM (LoadingBlockModifier) definition (`register_lbm`) { + label = "Upgrade legacy doors", + -- ^ Descriptive label for profiling purposes (optional). + -- Definitions with identical labels will be listed as one. name = "modname:replace_legacy_door", nodenames = {"default:lava_source"}, -- ^ List of node names to trigger the LBM on. |