FrameworkZ API Documentation - FrameworkZ.Utilities

Home / FrameworkZ.Utilities Library

FrameworkZ.Utilities

library

Utility module for FrameworkZ. Contains utility functions and classes.

0
Functions
19
Methods
2
Fields

📋 On This Page

Fields

2
FrameworkZ.Utilities 📋 table
Utility module for FrameworkZ. Contains utility functions and classes.
Initial value: {}
FrameworkZ.Utilities.Directions 📋 table inferred
Initial value: { { dx = 1, dy = 0, wallFlag = IsoFlagType.collideW, doorFlag = IsoFlagType.doorW, windowFlag = IsoFlagType.windowW }, { dx = -1, dy = 0, wallFlag = IsoFlagType.collideW, doorFlag = IsoFlagType.doorW, windowFlag = IsoFlagType.windowW }, { dx = 0, dy = 1, wallFlag = IsoFlagType.collideN, doorFlag = IsoFlagType.doorN, windowFlag = IsoFlagType.windowN }, { dx = 0, dy = -1, wallFlag = IsoFlagType.collideN, doorFlag = IsoFlagType.doorN, windowFlag = IsoFlagType.windowN }, }

Methods

19

FrameworkZ.Utilities:CopyTable(originalTable, tableCopies, shouldCopyMetatable)

method
Copies a table.

Parameters

originalTable 📋 table
The table to copy.
tableCopies 📋 table
(Internal) The table of copies used internally by the function.

Returns

📋 table
The copied table.

FrameworkZ.Utilities:DumpTable(tbl)

method undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature

FrameworkZ.Utilities:GetPrettyDuration(timeInSeconds)

method undocumented
No documentation available

Parameters (inferred)

timeInSeconds ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Utilities:GetRandomNumber(min, max, keepLeadingZeros)

method undocumented
No documentation available

Parameters (inferred)

min ❓ unknown
Parameter inferred from function signature
max ❓ unknown
Parameter inferred from function signature
keepLeadingZeros ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Utilities:IsExterior(square)

method undocumented
No documentation available

Parameters (inferred)

square ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Utilities:IsSemiExterior(square)

method undocumented
No documentation available

Parameters (inferred)

square ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Utilities:IsTrulyInterior(square)

method undocumented
No documentation available

Parameters (inferred)

square ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Utilities:MergeTables(t1, t2, visited)

method undocumented
No documentation available

Parameters (inferred)

t1 ❓ unknown
Parameter inferred from function signature
t2 ❓ unknown
Parameter inferred from function signature
visited ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Utilities:OrderedNext(t, state)

method undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature
state ❓ unknown
Parameter inferred from function signature

FrameworkZ.Utilities:OrderedPairs(t)

method undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature

FrameworkZ.Utilities:Pack(...)

method undocumented
No documentation available

Parameters (inferred)

... ❓ unknown
Parameter inferred from function signature

FrameworkZ.Utilities:PrintTable(tbl)

method undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature

FrameworkZ.Utilities:RemoveContextDuplicates(worldObjects)

method undocumented
No documentation available

Parameters (inferred)

worldObjects ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Utilities:TableContainsKey(t, key)

method undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature
key ❓ unknown
Parameter inferred from function signature

FrameworkZ.Utilities:TableContainsValue(t, value)

method undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

FrameworkZ.Utilities:TableIsEmpty(t)

method undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Utilities:TrimString(str, maxLength, addEllipsis)

method
Trims a string to a maximum length, optionally adding ellipsis.

Parameters

str 📝 string
The string to trim.
maxLength 🏷️ int
The maximum allowed length.
addEllipsis ✅ boolean
(Optional) If true, appends "..." if trimmed.

Returns

📝 string
The trimmed string.

FrameworkZ.Utilities:Unpack(t)

method undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature

FrameworkZ.Utilities:WordWrapText(text, maxLength, eolDelimiter)

method
Word wraps text to a specified length.

Parameters

text 📝 string
The text to word wrap.
maxLength 🏷️ int
The maximum length of a line (default: 28).
eolDelimiter 📝 string
(Optional) The end of line delimiter. Returns a \table of lines if not supplied.

Returns

🏷️ mixed
The word wrapped text as a \string or a \table of lines of text if no eolDelimiter was supplied as an argument.