First commit, step 4 completed

This commit is contained in:
bepis
2026-10-15 14:27:00 +11:00
commit 9a30efa170
5378 changed files with 1136719 additions and 0 deletions
@@ -0,0 +1,12 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_AbbreviateConfig)
---@class AbbreviateConfig
local AbbreviateConfig = {}
---[Documentation](https://warcraft.wiki.gg/wiki/API_AbbreviateConfig_GetAbbreviateNumberData)
---@return NumberAbbreviationBreakpoint[] data
function AbbreviateConfig:GetAbbreviateNumberData() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_AbbreviateConfig_SetAbbreviateNumberData)
---@param data NumberAbbreviationBreakpoint[]
function AbbreviateConfig:SetAbbreviateNumberData(data) end
@@ -0,0 +1,79 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_ColorCurveObject)
---@class ColorCurveObject : CurveObjectBase
local ColorCurveObject = {}
---Adds a single point to the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_AddPoint)
---@param x number
---@param y colorRGBA
function ColorCurveObject:AddPoint(x, y) end
---Removes all points from the curve. Evaluating an empty curve always yields a zero value.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_ClearPoints)
function ColorCurveObject:ClearPoints() end
---Returns a new copy of this curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_Copy)
---@return ColorCurveObject curve
function ColorCurveObject:Copy() end
---Returns a calculated color value from the configured curve points.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_Evaluate)
---@param x number
---@return colorRGBA y
function ColorCurveObject:Evaluate(x) end
---Returns an unpacked calculated color value from the configured curve points.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_EvaluateUnpacked)
---@param x number
---@return number yR
---@return number yG
---@return number yB
---@return number yA
function ColorCurveObject:EvaluateUnpacked(x) end
---Returns the vector for an individual point index on the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_GetPoint)
---@param index number
---@return LuaColorCurvePoint? point
function ColorCurveObject:GetPoint(index) end
---Returns the total number of points on the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_GetPointCount)
---@return size count
function ColorCurveObject:GetPointCount() end
---Returns the vectors for all points on the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_GetPoints)
---@return LuaColorCurvePoint[] point
function ColorCurveObject:GetPoints() end
---Removes a single point from the curve. Raises an error if the supplied point index is out of range.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_RemovePoint)
---@param index number
function ColorCurveObject:RemovePoint(index) end
---Replaces all points on the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_SetPoints)
---@param point LuaColorCurvePoint[]
function ColorCurveObject:SetPoints(point) end
---Resets all state on the curve, and clears the secret values flag.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_SetToDefaults)
function ColorCurveObject:SetToDefaults() end
---@class LuaColorCurvePoint
---@field x number
---@field y colorRGBA
@@ -0,0 +1,65 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_CurveObject)
---@class CurveObject : CurveObjectBase
local CurveObject = {}
---Adds a single point to the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_AddPoint)
---@param pointX number
---@param pointY number
function CurveObject:AddPoint(pointX, pointY) end
---Removes all points from the curve. Evaluating an empty curve always yields a zero value.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_ClearPoints)
function CurveObject:ClearPoints() end
---Returns a new copy of this curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_Copy)
---@return CurveObject curve
function CurveObject:Copy() end
---Returns a calculated 'y' value from the configured curve points.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_Evaluate)
---@param x number
---@return number y
function CurveObject:Evaluate(x) end
---Returns the vector for an individual point index on the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_GetPoint)
---@param index number
---@return vector2? point
function CurveObject:GetPoint(index) end
---Returns the total number of points on the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_GetPointCount)
---@return size count
function CurveObject:GetPointCount() end
---Returns the vectors for all points on the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_GetPoints)
---@return vector2[] point
function CurveObject:GetPoints() end
---Removes a single point from the curve. Raises an error if the supplied point index is out of range.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_RemovePoint)
---@param index number
function CurveObject:RemovePoint(index) end
---Replaces all points on the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_SetPoints)
---@param point vector2[]
function CurveObject:SetPoints(point) end
---Resets all state on the curve, and clears the secret values flag.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_SetToDefaults)
function CurveObject:SetToDefaults() end
@@ -0,0 +1,22 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_CurveObjectBase)
---@class CurveObjectBase
local CurveObjectBase = {}
---Returns the configured type of the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObjectBase_GetType)
---@return Enum.LuaCurveType curveType
function CurveObjectBase:GetType() end
---Returns true if the curve has been configured with any secret values. Curves with secret values always produce secret results when evaluated.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObjectBase_HasSecretValues)
---@return boolean hasSecretValues
function CurveObjectBase:HasSecretValues() end
---Changes the evaluation type of the curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObjectBase_SetType)
---@param type Enum.LuaCurveType
function CurveObjectBase:SetType(type) end
@@ -0,0 +1,154 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_DurationObject)
---@class DurationObject
local DurationObject = {}
---Copies another duration object and assigns it to this one.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_Assign)
---@param other DurationObject
function DurationObject:Assign(other) end
---Returns a copy of this duration object.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_Copy)
---@return DurationObject copy
function DurationObject:Copy() end
---Calculates the elapsed duration in seconds and evaluates it against a supplied curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_EvaluateElapsedDuration)
---@param curve CurveObjectBase
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return LuaCurveEvaluatedResult result
function DurationObject:EvaluateElapsedDuration(curve, modifier) end
---Calculates the elapsed duration as a percentage value and evaluates it against a supplied curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_EvaluateElapsedPercent)
---@param curve CurveObjectBase
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return LuaCurveEvaluatedResult result
function DurationObject:EvaluateElapsedPercent(curve, modifier) end
---Calculates the remaining duration in seconds and evaluates it against a supplied curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_EvaluateRemainingDuration)
---@param curve CurveObjectBase
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return LuaCurveEvaluatedResult result
function DurationObject:EvaluateRemainingDuration(curve, modifier) end
---Calculates the remaining duration as a percentage value and evaluates it against a supplied curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_EvaluateRemainingPercent)
---@param curve CurveObjectBase
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return LuaCurveEvaluatedResult result
function DurationObject:EvaluateRemainingPercent(curve, modifier) end
---Returns the current time of the clock source used by this object.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetClockTime)
---@return FrameTime clockTime
function DurationObject:GetClockTime() end
---Calculates the elapsed duration of the stored time span.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetElapsedDuration)
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return DurationSeconds elapsedDuration
function DurationObject:GetElapsedDuration(modifier) end
---Calculates the elapsed duration as a percentage value.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetElapsedPercent)
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return number elapsedPercent
function DurationObject:GetElapsedPercent(modifier) end
---Calculates the end time of the stored time span.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetEndTime)
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return FrameTime endTime
function DurationObject:GetEndTime(modifier) end
---Returns the divisor used to convert a duration from real time to base time.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetModRate)
---@return number modRate
function DurationObject:GetModRate() end
---Calculates the remaining duration of the stored time span.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetRemainingDuration)
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return DurationSeconds remainingDuration
function DurationObject:GetRemainingDuration(modifier) end
---Calculates the remaining duration as a percentage value.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetRemainingPercent)
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return number remainingPercent
function DurationObject:GetRemainingPercent(modifier) end
---Calculates the start time of the stored time span.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetStartTime)
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return FrameTime startTime
function DurationObject:GetStartTime(modifier) end
---Calculates the total duration of the stored time span.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetTotalDuration)
---@param modifier? Enum.DurationTimeModifier Default = RealTime
---@return DurationSeconds totalDuration
function DurationObject:GetTotalDuration(modifier) end
---Returns true if the duration has been configured with any secret values.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_HasSecretValues)
---@return boolean hasSecretValues
function DurationObject:HasSecretValues() end
---Returns true if the duration object is measuring a zero duration time span.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_IsZero)
---@return boolean isZero
function DurationObject:IsZero() end
---Resets the duration object to represent a zero duration time span.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_Reset)
function DurationObject:Reset() end
---Configures the duration object to represent an end time and a duration.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_SetTimeFromEnd)
---@param endTime FrameTime
---@param duration DurationSeconds
---@param modRate? number Default = 1
function DurationObject:SetTimeFromEnd(endTime, duration, modRate) end
---Configures the duration object to represent a start time and a duration.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_SetTimeFromStart)
---@param startTime FrameTime
---@param duration DurationSeconds
---@param modRate? number Default = 1
function DurationObject:SetTimeFromStart(startTime, duration, modRate) end
---Configures the duration object to represent a fixed start and end time span. If the end time is earlier than the start time, the duration will clamp to zero.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_SetTimeSpan)
---@param startTime FrameTime
---@param endTime FrameTime
function DurationObject:SetTimeSpan(startTime, endTime) end
---Resets all state on the duration, and clears the secret values flag.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_SetToDefaults)
function DurationObject:SetToDefaults() end
@@ -0,0 +1,227 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_HousingCatalogSearcher)
---@class HousingCatalogSearcher
local HousingCatalogSearcher = {}
---Returns all catalog entries being searched (note these are NOT search results, this is the source collection of what's being searched)
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetAllSearchItems)
---@return HousingCatalogEntryID[] matchingEntryIDs
function HousingCatalogSearcher:GetAllSearchItems() end
---Returns the most recent search result entries
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetCatalogSearchResults)
---@return HousingCatalogEntryID[] matchingEntryIDs
function HousingCatalogSearcher:GetCatalogSearchResults() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetEditorModeContext)
---@return Enum.HouseEditorMode? editorModeContext
function HousingCatalogSearcher:GetEditorModeContext() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetFilterTagStatus)
---@param groupID number
---@param tagID number
---@return boolean active
function HousingCatalogSearcher:GetFilterTagStatus(groupID, tagID) end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetFilteredCategoryID)
---@return number? categoryID
function HousingCatalogSearcher:GetFilteredCategoryID() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetFilteredSubcategoryID)
---@return number? subcategoryID
function HousingCatalogSearcher:GetFilteredSubcategoryID() end
---Returns the total number of entries being searched through
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetNumSearchItems)
---@return number numSearchItems
function HousingCatalogSearcher:GetNumSearchItems() end
---Returns the total number of owned instances across all most recent search result entries
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetSearchCount)
---@return number searchCount
function HousingCatalogSearcher:GetSearchCount() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetSearchText)
---@return string? searchText
function HousingCatalogSearcher:GetSearchText() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetSortType)
---@return Enum.HousingCatalogSortType sortType
function HousingCatalogSearcher:GetSortType() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsAllowedIndoorsActive)
---@return boolean isActive
function HousingCatalogSearcher:IsAllowedIndoorsActive() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsAllowedOutdoorsActive)
---@return boolean isActive
function HousingCatalogSearcher:IsAllowedOutdoorsActive() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsCollectedActive)
---@return boolean isActive
function HousingCatalogSearcher:IsCollectedActive() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsCustomizableOnlyActive)
---@return boolean isActive
function HousingCatalogSearcher:IsCustomizableOnlyActive() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsDistinctPerRecordIDActive)
---@return boolean isActive
function HousingCatalogSearcher:IsDistinctPerRecordIDActive() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsFirstAcquisitionBonusOnlyActive)
---@return boolean isActive
function HousingCatalogSearcher:IsFirstAcquisitionBonusOnlyActive() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsOwnedOnlyActive)
---@return boolean isActive
function HousingCatalogSearcher:IsOwnedOnlyActive() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsSearchInProgress)
---@return boolean isSearchInProgress
function HousingCatalogSearcher:IsSearchInProgress() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsUncollectedActive)
---@return boolean isActive
function HousingCatalogSearcher:IsUncollectedActive() end
---Run search with all current param values
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_RunSearch)
function HousingCatalogSearcher:RunSearch() end
---Set the toggle state of all filter tags within a specific group; If active, only entries that match Any of the tags in the group will be included in search results
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetAllInFilterTagGroup)
---@param groupID number
---@param active boolean
function HousingCatalogSearcher:SetAllInFilterTagGroup(groupID, active) end
---Search parameter; If true, entries that can be placed in house interiors will be included in the search; Note many decor objects can be placed both indoors and outdoors, so having only this toggled on may still include decor that can also be placed outdoors
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetAllowedIndoors)
---@param isActive boolean
function HousingCatalogSearcher:SetAllowedIndoors(isActive) end
---Search parameter; If true, entries that can be placed outside in plots will be included in the search; Note many decor objects can be placed both indoors and outdoors, so having only this toggled on may still include decor that can also be placed indoors
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetAllowedOutdoors)
---@param isActive boolean
function HousingCatalogSearcher:SetAllowedOutdoors(isActive) end
---If true, searcher automatically updates results whenever search param values are changed
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetAutoUpdateOnParamChanges)
---@param autoUpdateActive boolean
function HousingCatalogSearcher:SetAutoUpdateOnParamChanges(autoUpdateActive) end
---Search parameter; If true, includes all owned entries, including those that are in storage OR placed in an owned house or plot; See IsOwnedOnlyActive for a more exclusive toggle
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetCollected)
---@param isActive boolean
function HousingCatalogSearcher:SetCollected(isActive) end
---Search parameter; If true, catalog entries that cannot be customized (ie dyed) will be excluded from the search
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetCustomizableOnly)
---@param isActive boolean
function HousingCatalogSearcher:SetCustomizableOnly(isActive) end
---Search parameter; If true, only the first entry per recordID will be included
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetDistinctPerRecordID)
---@param isActive boolean
function HousingCatalogSearcher:SetDistinctPerRecordID(isActive) end
---Search parameter; If set, limits search results to only entries that are used/valid in the specified editor mode
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetEditorModeContext)
---@param editorModeContext? Enum.HouseEditorMode
function HousingCatalogSearcher:SetEditorModeContext(editorModeContext) end
---Set the toggle state of a single filter tag within a specific group
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetFilterTagStatus)
---@param groupID number
---@param tagID number
---@param active boolean
function HousingCatalogSearcher:SetFilterTagStatus(groupID, tagID, active) end
---Search parameter; If set, limits search results to only those within the specified category
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetFilteredCategoryID)
---@param categoryID? number
function HousingCatalogSearcher:SetFilteredCategoryID(categoryID) end
---Search parameter; If set, limits search results to only those within the specified subcategory
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetFilteredSubcategoryID)
---@param subcategoryID? number
function HousingCatalogSearcher:SetFilteredSubcategoryID(subcategoryID) end
---Search parameter; If true, excludes any entries that do not reward house xp when acquired for the first time
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetFirstAcquisitionBonusOnly)
---@param isActive boolean
function HousingCatalogSearcher:SetFirstAcquisitionBonusOnly(isActive) end
---Search parameter; If true, only entries that you own, and have instances of available in storage, will be included; This does not include entries that you own but have all been placed in a house; See IsCollectedActive for param that includes placed entries
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetOwnedOnly)
---@param isActive boolean
function HousingCatalogSearcher:SetOwnedOnly(isActive) end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetResultsUpdatedCallback)
---@param callback HousingCatalogSearchResultsUpdatedCallback
function HousingCatalogSearcher:SetResultsUpdatedCallback(callback) end
---Search parameter; If set, multiple text fields are checked for instances of the text, including name, category, subcategory, and data tags
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetSearchText)
---@param searchText? string
function HousingCatalogSearcher:SetSearchText(searchText) end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetSortType)
---@param sortType Enum.HousingCatalogSortType
function HousingCatalogSearcher:SetSortType(sortType) end
---Search parameter; If true, includes entries that are not owned, meaning not available in storage nor placed in any owned houses or plots
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetUncollected)
---@param isActive boolean
function HousingCatalogSearcher:SetUncollected(isActive) end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleAllowedIndoors)
function HousingCatalogSearcher:ToggleAllowedIndoors() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleAllowedOutdoors)
function HousingCatalogSearcher:ToggleAllowedOutdoors() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleCollected)
function HousingCatalogSearcher:ToggleCollected() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleCustomizableOnly)
function HousingCatalogSearcher:ToggleCustomizableOnly() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleDistinctPerRecordID)
function HousingCatalogSearcher:ToggleDistinctPerRecordID() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleFilterTag)
---@param groupID number
---@param tagID number
function HousingCatalogSearcher:ToggleFilterTag(groupID, tagID) end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleFirstAcquisitionBonusOnly)
function HousingCatalogSearcher:ToggleFirstAcquisitionBonusOnly() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleOwnedOnly)
function HousingCatalogSearcher:ToggleOwnedOnly() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleUncollected)
function HousingCatalogSearcher:ToggleUncollected() end
---@alias HousingCatalogSearchResultsUpdatedCallback FunctionContainer|fun()
@@ -0,0 +1,25 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_HousingFixturePointFrame)
---@class HousingFixturePointFrame
local HousingFixturePointFrame = {}
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_HasAttachedFixture)
---@return boolean hasAttachedFixture
function HousingFixturePointFrame:HasAttachedFixture() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_IsSelected)
---@return boolean isSelected
function HousingFixturePointFrame:IsSelected() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_IsValid)
---@return boolean isValid
function HousingFixturePointFrame:IsValid() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_Select)
function HousingFixturePointFrame:Select() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_SetUpdateCallback)
---@param cb FixturePointUpdatedCallback
function HousingFixturePointFrame:SetUpdateCallback(cb) end
---@alias FixturePointUpdatedCallback FunctionContainer|fun()
@@ -0,0 +1,69 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_HousingLayoutPinFrame)
---@class HousingLayoutPinFrame
local HousingLayoutPinFrame = {}
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_CanMove)
---@return Enum.HousingLayoutRestriction moveRestriction
function HousingLayoutPinFrame:CanMove() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_CanRemove)
---@return Enum.HousingLayoutRestriction removalRestriction
function HousingLayoutPinFrame:CanRemove() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_CanRotate)
---@return Enum.HousingLayoutRestriction rotateRestriction
function HousingLayoutPinFrame:CanRotate() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_Drag)
---@param isAccessible boolean
function HousingLayoutPinFrame:Drag(isAccessible) end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_GetDoorConnectionInfo)
---@return DoorConnectionInfo? connectionInfo
function HousingLayoutPinFrame:GetDoorConnectionInfo() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_GetPinType)
---@return Enum.HousingLayoutPinType type
function HousingLayoutPinFrame:GetPinType() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_GetRoomGUID)
---@return WOWGUID roomGUID
function HousingLayoutPinFrame:GetRoomGUID() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_GetRoomName)
---@return string? name
function HousingLayoutPinFrame:GetRoomName() end
---Returns true if this pin's associated room, or anything attached to it, is selected. Ex: If pin is for a door, returns true if its room, or any other doors on that room, are selected
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsAnyPartOfRoomSelected)
---@return boolean isSelected
function HousingLayoutPinFrame:IsAnyPartOfRoomSelected() end
---Will be nil if pin is not a Door
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsOccupiedDoor)
---@return boolean? isOccupied
function HousingLayoutPinFrame:IsOccupiedDoor() end
---Returns true if this pin's object is itself selected; See IsAnyPartOfRoomSelected for a broader Selected check
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsSelected)
---@return boolean isSelected
function HousingLayoutPinFrame:IsSelected() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsValid)
---@return boolean isValid
function HousingLayoutPinFrame:IsValid() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsValidForSelectedFloorplan)
---@return boolean isValid
function HousingLayoutPinFrame:IsValidForSelectedFloorplan() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_Select)
function HousingLayoutPinFrame:Select() end
---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_SetUpdateCallback)
---@param cb PinUpdatedCallback
function HousingLayoutPinFrame:SetUpdateCallback(cb) end
@@ -0,0 +1,218 @@
---@meta _
---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_UnitHealPredictionCalculator)
---@class UnitHealPredictionCalculator
local UnitHealPredictionCalculator = {}
---Calculates the percentage of current unit health and evaluates it against the supplied curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_EvaluateCurrentHealthPercent)
---@param curve LuaCurveObjectBase
---@return LuaCurveEvaluatedResult result
function UnitHealPredictionCalculator:EvaluateCurrentHealthPercent(curve) end
---Calculates the percentage of missing unit health and evaluates it against the supplied curve.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_EvaluateMissingHealthPercent)
---@param curve LuaCurveObjectBase
---@return LuaCurveEvaluatedResult result
function UnitHealPredictionCalculator:EvaluateMissingHealthPercent(curve) end
---Returns the base amount of unit health.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetCurrentHealth)
---@return number currentHealth
function UnitHealPredictionCalculator:GetCurrentHealth() end
---Returns the percentage of current unit health.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetCurrentHealthPercent)
---@return number currentHealthPercent
function UnitHealPredictionCalculator:GetCurrentHealthPercent() end
---Returns the configured damage absorb clamping mode.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetDamageAbsorbClampMode)
---@return Enum.UnitDamageAbsorbClampMode damageAbsorbClampMode
function UnitHealPredictionCalculator:GetDamageAbsorbClampMode() end
---Calculates damage absorb values and clamping according to the configured options.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetDamageAbsorbs)
---@return number amount
---@return boolean clamped
function UnitHealPredictionCalculator:GetDamageAbsorbs() end
---Returns the configured heal absorb clamping mode.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetHealAbsorbClampMode)
---@return Enum.UnitHealAbsorbClampMode healAbsorbClampMode
function UnitHealPredictionCalculator:GetHealAbsorbClampMode() end
---Returns the configured heal absorb processing mode.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetHealAbsorbMode)
---@return Enum.UnitHealAbsorbMode healAbsorbMode
function UnitHealPredictionCalculator:GetHealAbsorbMode() end
---Calculates heal absorb values and clamping according to the configured options.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetHealAbsorbs)
---@return number amount
---@return boolean clamped
function UnitHealPredictionCalculator:GetHealAbsorbs() end
---Returns the configured incoming heal clamping mode.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetIncomingHealClampMode)
---@return Enum.UnitIncomingHealClampMode incomingHealClampMode
function UnitHealPredictionCalculator:GetIncomingHealClampMode() end
---Returns the configured incoming heal maximum overflow percentage.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetIncomingHealOverflowPercent)
---@return number incomingHealOverflowPercent
function UnitHealPredictionCalculator:GetIncomingHealOverflowPercent() end
---Calculates incoming heal values and clamping according to the configured options.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetIncomingHeals)
---@return number amount
---@return number amountFromHealer
---@return number amountFromOthers
---@return boolean clamped
function UnitHealPredictionCalculator:GetIncomingHeals() end
---Returns the maximum clamping amount for damage absorbs.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumDamageAbsorbs)
---@return number maximumDamageAbsorbs
function UnitHealPredictionCalculator:GetMaximumDamageAbsorbs() end
---Returns the maximum clamping amount for heal absorbs.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumHealAbsorbs)
---@return number maximumHealAbsorbs
function UnitHealPredictionCalculator:GetMaximumHealAbsorbs() end
---Returns the base amount of maximum unit health.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumHealth)
---@return number maximumHealth
function UnitHealPredictionCalculator:GetMaximumHealth() end
---Returns the configured maximum health mode.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumHealthMode)
---@return Enum.UnitMaximumHealthMode maximumHealthMode
function UnitHealPredictionCalculator:GetMaximumHealthMode() end
---Returns the maximum clamping amount for incoming heals.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumIncomingHeals)
---@return number maximumIncomingHeals
function UnitHealPredictionCalculator:GetMaximumIncomingHeals() end
---Returns the base amount of missing unit health.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMissingHealth)
---@return number missingHealth
function UnitHealPredictionCalculator:GetMissingHealth() end
---Returns the percentage of missing unit health.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMissingHealthPercent)
---@return number missingHealthPercent
function UnitHealPredictionCalculator:GetMissingHealthPercent() end
---Returns the raw total figures used for data calculations.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetPredictedValues)
---@return UnitHealPredictionValues predictedValues
function UnitHealPredictionCalculator:GetPredictedValues() end
---Returns the base total amount of all applied damage absorb shields.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetTotalDamageAbsorbs)
---@return number totalDamageAbsorbs
function UnitHealPredictionCalculator:GetTotalDamageAbsorbs() end
---Returns the base total amount of all applied heal absorption effects.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetTotalHealAbsorbs)
---@return number totalHealAbsorbs
function UnitHealPredictionCalculator:GetTotalHealAbsorbs() end
---Returns the base total amount of all incoming heals.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetTotalIncomingHeals)
---@return number totalIncomingHeals
function UnitHealPredictionCalculator:GetTotalIncomingHeals() end
---Returns the base total amount of all incoming heals from the healer unit, if any.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetTotalIncomingHealsFromHealer)
---@return number totalIncomingHealsFromHealer
function UnitHealPredictionCalculator:GetTotalIncomingHealsFromHealer() end
---Returns true if the object has been configured with any secret values.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_HasSecretValues)
---@return boolean hasSecretValues
function UnitHealPredictionCalculator:HasSecretValues() end
---Resets all stored state on the object.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_Reset)
function UnitHealPredictionCalculator:Reset() end
---Resets all stored healing values used for calculations.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_ResetPredictedValues)
function UnitHealPredictionCalculator:ResetPredictedValues() end
---Changes the clamping mode used when calculating damage absorb amounts.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetDamageAbsorbClampMode)
---@param damageAbsorbClampMode Enum.UnitDamageAbsorbClampMode
function UnitHealPredictionCalculator:SetDamageAbsorbClampMode(damageAbsorbClampMode) end
---Changes the clamping mode used when calculating heal absorb amounts.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetHealAbsorbClampMode)
---@param healAbsorbClampMode Enum.UnitHealAbsorbClampMode
function UnitHealPredictionCalculator:SetHealAbsorbClampMode(healAbsorbClampMode) end
---Changes the processing mode used when calculating both heal absorb and incoming heal amounts.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetHealAbsorbMode)
---@param healAbsorbMode Enum.UnitHealAbsorbMode
function UnitHealPredictionCalculator:SetHealAbsorbMode(healAbsorbMode) end
---Changes the clamping mode used when calculating incoming heal amounts.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetIncomingHealClampMode)
---@param incomingHealClampMode Enum.UnitIncomingHealClampMode
function UnitHealPredictionCalculator:SetIncomingHealClampMode(incomingHealClampMode) end
---Changes the maximum overflow percentage for incoming heals. Increasing this to a value over 1.0 will mean that incoming heals can extend beyond maximum health.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetIncomingHealOverflowPercent)
---@param incomingHealOverflowPercent number
function UnitHealPredictionCalculator:SetIncomingHealOverflowPercent(incomingHealOverflowPercent) end
---Changes the calculation mode for maximum health values used for clamping.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetMaximumHealthMode)
---@param maximumHealthMode Enum.UnitMaximumHealthMode
function UnitHealPredictionCalculator:SetMaximumHealthMode(maximumHealthMode) end
---Sets the healing values used for all calculations.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetPredictedValues)
---@param predictedValues UnitHealPredictionValues
function UnitHealPredictionCalculator:SetPredictedValues(predictedValues) end
---Resets all state on the object, and clears the secret values flag.
---
---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetToDefaults)
function UnitHealPredictionCalculator:SetToDefaults() end