Function reference

Built In helpers

The helpers the in-game Functions tab lists as Built In. Public ones are called by name; the others are bound as a dependency (choose the completion, or add it under Dependencies) and called by their qualified name.

31 of 240 helpers. Clear filters

`Functions.cache.getCached` public	Call an observation once per cache and exact argument tuple, including nil results.
`Functions.cache.getRetryCached` public	Cache an observation after it returns a non-nil value; retry observations whose entire return tuple is nil.
`Functions.collections.cleanArray` public	Remove entries in place, preserving only keys listed among except values by default.
`Functions.collections.compareArray` public	Visit entries in both tables and compare each value with the indexed value in the other table using Lua equality.
`Functions.collections.deepcopy` public	Create a shallow filtered copy despite the historical deepcopy name.
`Functions.collections.index` public	Return the first key whose value equals the supplied value during pairs traversal.
`Functions.collections.keys` public	Collect table keys and sort them by their associated values using Lua less-than comparison.
`Functions.collections.multiinsert` public	Insert each value visited by ipairs at its corresponding leading index in the destination array.
`Functions.collections.spairs` public	Create an iterator over a sorted snapshot of table keys.
`Functions.collections.tablelength` public	Count all entries visited by pairs, including false values and sparse numeric or nonnumeric keys.
`Functions.collections.tomap` public	Copy a table using tostring of each original key as the destination key.
`Functions.forecast.calculate` public	Calculate a checked health-history rate using an explicit finite window and clock.
`Functions.forecast.finite` dependency	Checks that a number used by Functions.forecast.calculate is readable and finite.
`Functions.forecast.readField` dependency	Reads object[key] for Functions.forecast.calculate without letting a restricted value, a non-table object or an index error escape.
`Functions.presentation.compareString` public	Format comparison wording with named Boolean alternatives when the operator has a negative form.
`Functions.presentation.nullable` public	Return a present value unchanged, or a red display placeholder for nil.
`Functions.presentation.nullable_value` public	Look up a table key for display, preserving non-nil results; invalid tables, missing keys and nil keys use nullable placeholder text.
`Functions.presentation.phrase` public	Create a transient named condition summary.
`Functions.presentation.playerize` public	Choose the supplied player value only for the literal player unit token; every other unit selects the nonplayer value.
`Functions.presentation.predicate` public	Create a typed comparison predicate for a named condition phrase.
`Functions.text.ends_with` public	Test a literal byte suffix using a Lua string slice.
`Functions.text.split` public	Split a string into nonempty runs between separator characters.
`Functions.text.starts_with` public	Test a literal byte prefix using a Lua string slice.
`Functions.text.trim` public	Remove leading and trailing Lua-pattern whitespace from a string.
`Functions.text.wrap` public	Wrap text at whitespace boundaries near a target column count.
`Functions.trends.calculate` public	Estimate signed health change from weighted damage and healing history.
`Functions.trends.calculateOld` public	Run the historical health-snapshot trend formula using the live profile history window, clock and legacy rounding service.
`Functions.values.compare` public	Compare two values using an RM operator identifier: LESSTHAN, LESSTHANOREQUALS, GREATERTHAN, GREATERTHANOREQUALS, EQUALS, NOTEQUALS or DIVISIBLE.
`Functions.values.isin` public	Check whether a table has a non-nil value at a key.
`Functions.values.isint` public	Apply the legacy integer or canonical numeric-string spelling test.
`Functions.values.round` public	Round with the existing floor(num * 10^places + 0.5) / 10^places formula.