misc module

Miscellaneous control-stage functions that don't yet have a proper home.

Usage

local misc = require("__flib__.misc")

Functions

get_distance(pos1, pos2) Calculate the distance in tiles between two positions.
get_distance_squared(pos1, pos2) Calculate the squared distance in tiles between two positions.
ticks_to_timestring([tick=game.ticks_played][, include_leading_zeroes]) Convert given tick or game.tick into "[hh:]mm:ss" format.
delineate_number(number[, delimiter="]) Split numerical values by a delimiter.

Functions

# get_distance(pos1, pos2)

Calculate the distance in tiles between two positions.

Parameters: Returns:
# get_distance_squared(pos1, pos2)

Calculate the squared distance in tiles between two positions.

Parameters: Returns:
# ticks_to_timestring([tick=game.ticks_played][, include_leading_zeroes])

Convert given tick or game.tick into "[hh:]mm:ss" format.

Parameters:
  • tick : (number) (default: game.ticks_played)
  • include_leading_zeroes : (booelan) If true, leading zeroes will be included in single-digit minute and hour values. (optional)
Returns:
# delineate_number(number[, delimiter="])

Split numerical values by a delimiter.

Adapted from lua-users.org.

Parameters:
  • number : (number) The number to delineate.
  • delimiter : (string) (default: ")
Returns:
  • (string) The formatted number.