From 78cbe40fa55e325ed8f3d0541be1200b34a1e37e Mon Sep 17 00:00:00 2001 From: Julian Date: Sun, 11 Sep 2016 11:34:11 +0200 Subject: stats: add some documentation for generate_graph() --- player/lua/stats.lua | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'player/lua') diff --git a/player/lua/stats.lua b/player/lua/stats.lua index 74bb1db468..000708c876 100644 --- a/player/lua/stats.lua +++ b/player/lua/stats.lua @@ -138,7 +138,16 @@ local function has_ansi() return true end - +-- Generate a graph from the given values. +-- Returns an ASS formatted vector drawing as string. +-- +-- values: Array/Table of numbers representing the data. Used like a ring buffer +-- it will get iterated backwards `len` times starting at position `i`. +-- i : Index of the latest data value in `values`. +-- len : The length/amount of numbers in `values`. +-- v_max : The maximum number in `values`. It is used to scale all data +-- values to a range of 0 to `v_max`. +-- scale : A value that will be multiplied with all data values. local function generate_graph(values, i, len, v_max, scale) -- check if at least one value was recorded yet (we assume lua-style 1-indexing) if i < 1 then -- cgit v1.2.3