From 1f273e4b13d3abdd0c04c66141129e3213493f16 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Sat, 20 Mar 2021 01:56:14 +0000 Subject: [PATCH] comment worldeditadditions.eta --- worldeditadditions/utils/numbers.lua | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/worldeditadditions/utils/numbers.lua b/worldeditadditions/utils/numbers.lua index 84d34f2..2d31878 100644 --- a/worldeditadditions/utils/numbers.lua +++ b/worldeditadditions/utils/numbers.lua @@ -31,6 +31,12 @@ function worldeditadditions.get_ms_time() return minetest.get_us_time() / 1000 end +--- Calculates the estimated time remaining from a list of times. +-- Intended to be used where one has a number of works units, and one has a +-- list of how long the most recent units have taken to run. +-- @param existing_times number[] A list of times - in ms - that the most recent work units have taken. +-- @param done_count number The number of work units completed so far. +-- @param total_count number The total number of work units to be completed. function worldeditadditions.eta(existing_times, done_count, total_count) local max = 100 local average = worldeditadditions.average(