LuaFlowStatistics

class LuaFlowStatistics - sort
get_input_count(string) → uint64 or double Gets the total input count for a given prototype.
set_input_count(string, count) Sets the total input count for a given prototype.
get_output_count(string) → uint64 or double Gets the total output count for a given prototype.
set_output_count(string, count) Sets the total output count for a given prototype.
get_flow_count{name=…, input=…, precision_index=…, count=…} → double Gets the flow count value for the given time frame.
on_flow(string, count) Adds a value to this flow statistics.
input_counts :: dictionary stringarray of uint64 or double [R] List of input counts indexed by name <> value.
output_counts :: dictionary stringarray of uint64 or double [R] List of output counts indexed by name <> value.
force :: LuaForce [R] The force these statistics belong to.
valid :: boolean [R] Is this object valid?
help() → string All methods, and properties that this object supports.

Encapsulates statistic data for different parts of the game.

get_input_count(string) → uint64 or double

Gets the total input count for a given prototype.

Parameters
string: The prototype name.
set_input_count(string, count)

Sets the total input count for a given prototype.

Parameters
string: The prototype name.
count :: uint64 or double: The new count. The type depends on the instance of the statistics.
get_output_count(string) → uint64 or double

Gets the total output count for a given prototype.

Parameters
string: The prototype name.
set_output_count(string, count)

Sets the total output count for a given prototype.

Parameters
string: The prototype name.
count :: uint64 or double: The new count. The type depends on the instance of the statistics.
get_flow_count{name=…, input=…, precision_index=…, count=…} → double

Gets the flow count value for the given time frame.

Parameters
Table with the following fields:
  • name :: string: The prototype name.
  • input :: boolean: Read the input values or the output values
  • precision_index :: defines.flow_precision_index: The precision to read.
  • count :: boolean (optional): If true, the count is returned instead of the per-time-frame value.
on_flow(string, count)

Adds a value to this flow statistics.

Parameters
string: The prototype name.
count :: float: The count: positive or negative determines if the value goes in the input or output statistics.
input_counts :: dictionary stringarray of uint64 or double [Read-only]

List of input counts indexed by name <> value.

output_counts :: dictionary stringarray of uint64 or double [Read-only]

List of output counts indexed by name <> value.

force :: LuaForce [Read-only]

The force these statistics belong to.