Foldit Lua Function metric.GetBonus

metric.GetBonus

Function

number metric.GetBonus(string name)

Description

Bonus score of the metric with the given name

V1 Function Name

New to V2

metric.GetBonus returns the bonus for the binder metric specified by name.

Use metric.GetNames to determine the names of the binder metrics available for the current puzzles.

Example

This example demonstrates first using metric.GetNames to get the names of the binder metrics, then using metric.GetBonus to get the bonus awarded by each metric.

metrx = metric.GetNames ()
print ( #metrx .. " binder metrics found" )

for ii = 1, #metrx do
   mbon = metric.GetBonus ( metrx [ ii ] )
   print ( "metric " .. ii .. " = " .. metrx [ ii ] .. ", bonus = " .. mbon )
end

The output might look like this:

3 binder metrics found
metric 1 = SASA Metric, bonus = 1000
metric 2 = DDG Metric, bonus = 1000
metric 3 = SC Metric, bonus = 1000