函式參考

內建輔助函式

遊戲中「函式」分頁列為內建的輔助函式。公用輔助函式直接以名稱呼叫；其他輔助函式需繫結為相依項目（選擇自動完成項目，或在「相依項目」中新增），再以其完整名稱呼叫。

240 個輔助函式中的 31 個。清除篩選

`Functions.cache.getCached` 公用	對每個快取與完全相同的參數元組只呼叫一次觀測，包括 nil 結果。傳入評估快取可在一個建議週期內共用觀測；快取為 nil 時直接呼叫。
`Functions.cache.getRetryCached` 公用	在觀測傳回非 nil 值後將其快取；對整個傳回元組都為 nil 的觀測會重試。使用與 getCached 完全相同的參數鍵。
`Functions.collections.cleanArray` 公用	原地移除項目，預設只保留 except 值中列出的鍵。invert 為 true 時，移除列出的鍵並保留未列出的鍵。沒有例外清單時，預設會移除所有項目，而 invert 為 true 時會保留所有項目。輸入為 nil 時不執行任何操作。
`Functions.collections.compareArray` 公用	走訪兩個表格中的項目，並使用 Lua 相等比較將每個值與另一個表格中相應索引的值進行比較。一般的索引與相等中繼方法都會生效；巢狀內容不會被遞迴比較。
`Functions.collections.deepcopy` 公用	儘管歷史上名為 deepcopy，它建立的是一個經過篩選的淺層複本。巢狀的值保留其原始身分，且不會複製來源表格的中繼表格。預設排除 except 值中列出的鍵；invert 為 true 時只包含列出的鍵。輸入為 nil 時傳回 nil。
`Functions.collections.index` 公用	在 pairs 走訪過程中傳回第一個值等於所提供值的鍵。輸入表格為 nil 或 false 以及值不存在時傳回 nil。有多個相符的鍵時，選擇順序不確定。
`Functions.collections.keys` 公用	收集表格的鍵，並使用 Lua 的小於比較依其對應的值排序。這是依值排序而不是依鍵名排序；值相等時鍵的順序不確定。
`Functions.collections.multiinsert` 公用	將 ipairs 走訪到的每個值插入到目標陣列中對應的開頭索引處。現有項目會移到插入的前綴之後；走訪在第一個缺少的來源索引處停止。
`Functions.collections.spairs` 公用	建立一個走訪表格鍵排序快照的迭代器。預設依鍵排序；自訂排序回呼會收到原始表格與兩個鍵。每次產出一個鍵時，值從原始表格中讀取。當下一個擷取的鍵為 nil 或 false 時，舊版迭代器結束。
`Functions.collections.tablelength` 公用	統計 pairs 走訪到的所有項目，包括 false 值以及稀疏的數字鍵或非數字鍵。nil 表格的長度為零。
`Functions.collections.tomap` 公用	複製一個表格，以每個原始鍵的 tostring 結果作為目標鍵。值保留其原始身分。字串化後相互衝突的鍵會依未指定的 pairs 走訪順序相互覆蓋。
`Functions.forecast.calculate` 公用	使用明確的有限時間區間與時鐘，計算經過檢查的生命力歷史速率。保留有序加權、逐列即時標準捨入、被略過的資料流、陣列空洞、小數鍵以及最終存取時的時長。固定的 4096 單位預算涵蓋兩個資料流中被存取的列與累加區間；超出預算或無效的已消耗運算會傳回無法使用，絕不傳回部分估算或截斷值。這個新 API 有其自己的原始碼身分；歷史趨勢函式保持不變。
`Functions.forecast.finite` 相依項目	Checks that a number used by Functions.forecast.calculate is readable and finite.
`Functions.forecast.readField` 相依項目	Reads object[key] for Functions.forecast.calculate without letting a restricted value, a non-table object or an index error escape.
`Functions.presentation.compareString` 公用	當運算子有否定形式時，使用命名布林備選項格式化比較措辭。primary 標記會將肯定形式標為主要措辭。肯定運算子標籤使用擷取的運算子對應；否定標籤與可為空分派保留其即時的插件 API。
`Functions.presentation.nullable` 公用	原樣傳回存在的值；為 nil 時傳回紅色的顯示預留位置。用於可讀的條件標籤，而不是作為布林值的備用。
`Functions.presentation.nullable_value` 公用	查詢表格中的鍵用於顯示，保留非 nil 的結果；無效的表格、缺少的鍵與 nil 鍵會使用可為空預留位置文字。
`Functions.presentation.phrase` 公用	建立一個暫時的具名條件摘要。純量值使用 {name}，判斷的正反兩種措辭使用 {{positive\|negative}}；在主要措辭前加上 !
`Functions.presentation.playerize` 公用	僅當單位代碼為字面上的 player 時才選擇所提供的玩家值；其他所有單位都會選擇非玩家值。選中的 false 與 nil 值會被保留。
`Functions.presentation.predicate` 公用	為具名條件短語建立一個具型別的比較判斷。肯定措辭使用原先擷取的運算子對應，否定措辭使用目前反轉後的運算子對應。主要判斷優先於限定詞；只有第一個符合條件的判斷會被反轉。未知運算子使用現有的運算子預留位置。這只格式化措辭，不比較值也不評估條件。
`Functions.text.ends_with` 公用	使用 Lua 字串切片測試字面的位元組後綴。空後綴視為相符；模式字元沒有特殊含義，並區分大小寫。
`Functions.text.split` 公用	將字串分割為分隔字元之間的非空片段。分隔符會被插入到 Lua 模式的字元類別中；它不是字面意義上的多字元分隔符。空欄位會被省略。
`Functions.text.starts_with` 公用	使用 Lua 字串切片測試字面的位元組前綴。空前綴視為相符；模式字元沒有特殊含義，並區分大小寫。
`Functions.text.trim` 公用	移除字串開頭與結尾符合 Lua 模式的空白字元。
`Functions.text.wrap` 公用	在接近目標欄數的空白邊界處對文字換行。長單字會保持完整。
`Functions.trends.calculate` 公用	根據加權的傷害與治療歷史估算帶正負號的生命力變化。傷害貢獻負速率，治療貢獻正速率。未提供時間區間時讀取即時設定檔中的時間區間，使用即時時鐘與舊版捨入服務，並保留現有的加權與捨入後時長計算。此輔助函式不會驗證或清理歷史，不會截斷時間戳記，也不保證結果有限。
`Functions.trends.calculateOld` 公用	使用即時設定檔的歷史時間區間、時鐘與舊版捨入服務，執行歷史生命力快照的趨勢公式。保留其最大生命力的過渡、在滿血或零血時提前停止、加權、錯誤與傳回值數量。空陣列或未記錄任何加權變化的快照只傳回零，而不是 0/0 的結果；這是舊版演算法，而不是經過驗證的預測。
`Functions.values.compare` 公用	使用 RM 運算子識別碼比較兩個值：LESSTHAN、LESSTHANOREQUALS、GREATERTHAN、GREATERTHANOREQUALS、EQUALS、NOTEQUALS 或 DIVISIBLE。無效的運算子會發出警告並傳回 nil；運算元必須支援所選的 Lua 運算。
`Functions.values.isin` 公用	檢查表格中某個鍵是否有非 nil 的值。儲存的 false 值仍算作存在；這不會掃描表格中的值。
`Functions.values.isint` 公用	執行舊版的整數或標準數字字串拼寫測試。數字使用無條件捨去後的相等比較；字串必須等於經數字轉換並無條件捨去後得到的拼寫。其他型別傳回 false。這不是有限數字的驗證器。
`Functions.values.round` 公用	使用現有的 floor(num * 10^places + 0.5) / 10^places 公式進行捨入。places 預設為零，可以為負。處於一半的負值會向正無窮方向捨入；不會新增有限數字驗證或其他捨入政策。