C_Garrison

namespaceavailable in: camelot

Status in wowlua

227 functions: 2 implemented, 0 recorded, 225 guessed. 65 events, 3 of them fired by the emulator on its own.

Functions

function	what it does	status
`AddFollowerToMission`	Adds a follower to a mission and returns whether it was added. · by wowlua `(missionID: number, followerID: GarrisonFollower, boardIndex: number?): boolean`	guessed
`AllowMissionStartAboveSoftCap`	Returns whether missions of a follower type can be started while the player has more followers than the soft cap. The mission page refuses to start a mission when this is false and `C_Garrison.IsAboveFollowerSoftCap` is true. · by wowlua `not in Blizzard's documentation`	guessed
`AreMissionFollowerRequirementsMet`	Returns whether the followers assigned to a mission meet its follower requirements. The mission page checks it before starting the mission. · by wowlua `not in Blizzard's documentation`	guessed
`AssignFollowerToBuilding`	Assigns a follower to work in the building on a garrison plot. Blizzard's building UI passes the plot ID and the follower's ID. · by wowlua `not in Blizzard's documentation`	guessed
`CanGenerateRecruits`	Returns whether the garrison recruiter can offer a new set of followers to recruit. · by wowlua `not in Blizzard's documentation`	guessed
`CanOpenMissionChest`	Returns whether the reward chest of a completed mission can be opened. · by wowlua `not in Blizzard's documentation`	guessed
`CanSetRecruitmentPreference`	Returns whether the player can choose an ability or trait preference at the garrison recruiter. · by wowlua `not in Blizzard's documentation`	guessed
`CanSpellTargetFollowerIDWithAddAbility`	Returns whether the spell waiting for a target can give a temporary ability to the given follower. · by wowlua `not in Blizzard's documentation`	guessed
`CanUpgradeGarrison`	Returns whether the player's garrison can be upgraded to its next level. · by wowlua `not in Blizzard's documentation`	guessed
`CancelConstruction`	Cancels the building under construction on a garrison plot. · by wowlua `not in Blizzard's documentation`	guessed
`CastItemSpellOnFollowerAbility`	Casts the targeting item spell on one ability of a follower. Blizzard's UI passes the follower's ID and the ability ID. · by wowlua `not in Blizzard's documentation`	guessed
`CastSpellOnFollower`	Casts the spell waiting for a target on a follower. · by wowlua `not in Blizzard's documentation`	guessed
`CastSpellOnFollowerAbility`	Casts the spell waiting for a target on one ability of a follower. Blizzard's UI passes the follower's ID and the ability ID. · by wowlua `not in Blizzard's documentation`	guessed
`CastSpellOnMission`	Casts the spell waiting for a target on a mission and returns whether it was cast. · by wowlua `not in Blizzard's documentation`	guessed
`ClearCompleteTalent`	Clears the notice of a finished talent research for a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`CloseArchitect`	Closes the interaction with the garrison architect table. · by wowlua `not in Blizzard's documentation`	guessed
`CloseGarrisonTradeskillNPC`	Closes the interaction with a garrison profession NPC. · by wowlua `not in Blizzard's documentation`	guessed
`CloseMissionNPC`	Closes the interaction with the mission table. · by wowlua `not in Blizzard's documentation`	guessed
`CloseRecruitmentNPC`	Closes the interaction with the garrison recruiter. · by wowlua `not in Blizzard's documentation`	guessed
`CloseTalentNPC`	Closes the interaction with the NPC that researches garrison talents. · by wowlua `not in Blizzard's documentation`	guessed
`CloseTradeskillCrafter`	Closes the interaction with a work order NPC. · by wowlua `not in Blizzard's documentation`	guessed
`GenerateRecruits`	Asks the garrison recruiter for new followers to recruit, favouring an ability and a trait. Blizzard's UI passes 0 for both to get random recruits. · by wowlua `not in Blizzard's documentation`	guessed
`GetAllBonusAbilityEffects`	Returns the bonus ability effects active for a follower type. The shipyard uses it for ships. · by wowlua `not in Blizzard's documentation`	guessed
`GetAllEncounterThreats`	Returns the mechanics that mission enemies of a follower type can have. · by wowlua `not in Blizzard's documentation`	guessed
`GetAutoCombatDamageClassValues`	Returns the damage classes of adventure combat spells. · by wowlua `(): AutoCombatDamageClassString[]`	guessed
`GetAutoMissionBoardState`	Returns the targeting state of every position on an adventure's board. · by wowlua `(missionID: number): AutoMissionTargetingInfo[]`	guessed
`GetAutoMissionEnvironmentEffect`	Returns an adventure's environment effect, or nothing. · by wowlua `(missionID: number): AutoMissionEnvironmentEffect?`	guessed
`GetAutoMissionTargetingInfo`	Returns the targets a follower's abilities hit from a position on an adventure's board. · by wowlua `(missionID: number, followerID: GarrisonFollower, casterBoardIndex: number): AutoMissionTargetingInfo[]`	guessed
`GetAutoMissionTargetingInfoForSpell`	Returns the targets an adventure combat spell hits from a position on the board. · by wowlua `(missionID: number, autoCombatSpellID: number, casterBoardIndex: number): AutoMissionTargetingInfo[]`	guessed
`GetAutoTroops`	Returns the troops available for adventures. · by wowlua `(followerType: number): AutoCombatTroopInfo[]`	guessed
`GetAvailableMissions`	Returns a list of available follower missions. `not in Blizzard's documentation`	guessed
`GetAvailableRecruits`	Returns the followers the garrison recruiter currently offers. · by wowlua `not in Blizzard's documentation`	guessed
`GetBasicMissionInfo`	Returns a table containing information on the requested mission. `not in Blizzard's documentation`	guessed
`GetBuffedFollowersForMission`	Returns which followers counter the mechanics of a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetBuildingInfo`	Returns garrison building info. `not in Blizzard's documentation`	guessed
`GetBuildingLockInfo`	No description yet. `not in Blizzard's documentation`	guessed
`GetBuildingSizes`	Returns the garrison building size tabs shown in the architect table. · by wowlua `not in Blizzard's documentation`	guessed
`GetBuildingSpecInfo`	Returns the name, tooltip text and icon of a building specialization. · by wowlua `not in Blizzard's documentation`	guessed
`GetBuildingTimeRemaining`	Returns how long a building's construction has left, as a number and as text. · by wowlua `not in Blizzard's documentation`	guessed
`GetBuildingTooltip`	Returns the tooltip text and costs of a garrison building: the text, the cost, the gold, the currency ID, the build time and whether it needs a plan. · by wowlua `not in Blizzard's documentation`	guessed
`GetBuildingUpgradeInfo`	Returns information about a garrison building's next upgrade, among it its name, icon, rank, costs and build time. · by wowlua `not in Blizzard's documentation`	guessed
`GetBuildings`	Returns the buildings the player owns in a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`GetBuildingsForPlot`	Returns the buildings that can be placed on a garrison plot. · by wowlua `not in Blizzard's documentation`	guessed
`GetBuildingsForSize`	Returns the buildings of one size category in a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`GetClassSpecCategoryInfo`	Returns the follower class spec categories of a follower type. Pairs with `C_Garrison.RequestClassSpecCategoryInfo`. · by wowlua `not in Blizzard's documentation`	guessed
`GetCombatAllyMission`	Returns the combat ally mission of a follower type. · by wowlua `not in Blizzard's documentation`	guessed
`GetCombatLogSpellInfo`	Returns information about an adventure combat spell, or nothing. · by wowlua `(autoCombatSpellID: number): AutoCombatSpellInfo?`	guessed
`GetCompleteMissions`	Returns the missions of a follower type that have finished but are not yet collected. · by wowlua `not in Blizzard's documentation`	guessed
`GetCompleteTalent`	Returns the ID of the talent whose research just finished for a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`GetCurrencyTypes`	Returns the primary and secondary currency IDs of a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`GetCurrentCypherEquipmentLevel`	Returns the player's current Cypher of the First Ones equipment level. · by wowlua `(): number`	guessed
`GetCurrentGarrTalentTreeFriendshipFactionID`	Returns the friendship faction ID of the open talent tree, or nothing. · by wowlua `(): number?`	guessed
`GetCurrentGarrTalentTreeID`	Returns the ID of the open talent tree, or nothing. · by wowlua `(): number?`	guessed
`GetCyphersToNextEquipmentLevel`	Returns the number of Cyphers of the First Ones needed for the next equipment level, or nothing. · by wowlua `(): number?`	guessed
`GetFollowerAbilities`	Returns the abilities of a garrison follower. `not in Blizzard's documentation`	guessed
`GetFollowerAbilityAtIndex`	Returns an ability for the follower. `not in Blizzard's documentation`	guessed
`GetFollowerAbilityAtIndexByID`	Returns the ability at an index in the list of a follower, looked up by its `garrFollowerID`. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAbilityCounterMechanicInfo`	Returns the mechanic a follower ability counters: its ID, name and icon, and the counter factor. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAbilityCountersForMechanicTypes`	Returns which follower abilities counter each mechanic type, for a follower type. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAbilityDescription`	Returns the description of a follower ability. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAbilityIcon`	Returns the icon of a follower ability. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAbilityInfo`	Returns a table of information about a follower ability. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAbilityIsTrait`	Returns whether a follower ability is a trait. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAbilityLink`	Returns a chat link for a follower ability. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAbilityName`	Returns the name of a follower ability. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerActivationCost`	Returns the gold, in copper, it costs to activate an inactive follower. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerAutoCombatSpells`	Returns a follower's adventure combat abilities and its auto attack. · by wowlua `(garrFollowerID: GarrisonFollower, followerLevel: number): (AutoCombatSpellInfo[]?, AutoCombatSpellInfo?)`	guessed
`GetFollowerAutoCombatStats`	Returns a follower's adventure combat stats, or nothing. · by wowlua `(garrFollowerID: GarrisonFollower): FollowerAutoCombatStatsInfo?`	guessed
`GetFollowerBiasForMission`	Returns how a follower's level suits a mission. Blizzard's UI treats a value below 0 as the follower being under the mission's level. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerClassSpec`	Returns the class spec of a follower. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerClassSpecAtlas`	Returns the atlas for a follower class spec. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerClassSpecByID`	Returns the class spec of a follower, looked up by its `garrFollowerID`. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerClassSpecName`	Returns the name of a follower's class spec. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerDisplayID`	Returns the display ID of a follower's model. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerInfo`	Returns information about a follower. `not in Blizzard's documentation`	guessed
`GetFollowerInfoForBuilding`	Returns the follower working in the building on a plot: its name, level, quality, follower ID, `garrFollowerID`, status and portrait icon. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerIsTroop`	Returns whether a follower is a troop. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerItemLevelAverage`	Returns the average item level of a follower. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerItems`	Return information about a follower weapon and armor. `not in Blizzard's documentation`	guessed
`GetFollowerLevel`	Returns the level of a follower. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerLevelXP`	Returns the experience a follower needs for its next level. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerLink`	Returns a chat link for one of the player's followers. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerLinkByID`	Returns a chat link for a follower, looked up by its `garrFollowerID`. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerMissionCompleteInfo`	Returns a follower's information for the mission complete screen. · by wowlua `(followerID: GarrisonFollower): FollowerMissionCompleteInfo`	guessed
`GetFollowerMissionTimeLeft`	Returns, as text, how long the mission a follower is on has left. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerMissionTimeLeftSeconds`	Returns, in seconds, how long the mission a follower is on has left. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerModelItems`	Returns the items a follower's model shows. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerName`	Returns the name of one of the player's followers. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerNameByID`	Returns the name of a follower, looked up by its `garrFollowerID`. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerPortraitIconID`	Returns the portrait icon of one of the player's followers. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerPortraitIconIDByID`	Returns the portrait icon of a follower, looked up by its `garrFollowerID`. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerQuality`	Returns the quality of a follower. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerQualityTable`	Returns the follower quality table of a follower type. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerRecentlyGainedAbilityIDs`	Returns the abilities a follower gained recently. Blizzard's UI uses them to mark new abilities. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerRecentlyGainedTraitIDs`	Returns the traits a follower gained recently. Blizzard's UI uses them to mark new traits. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerShipments`	Returns the follower shipments of a garrison type, shown on the landing page. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerSoftCap`	Returns the soft cap on the number of active followers of a follower type. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerSourceTextByID`	Returns the text that says where a follower can be found, looked up by its `garrFollowerID`. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerSpecializationAtIndex`	Returns the specialization at an index for one of the player's followers. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerStatus`	Returns the status of a follower, such as being on a mission or in the party, or nil when it has none. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerTraitAtIndex`	Returns the trait at an index for one of the player's followers. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerTraitAtIndexByID`	Returns the trait at an index for a follower, looked up by its `garrFollowerID`. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerTypeByID`	Returns the follower type of a follower, looked up by its `garrFollowerID`. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerTypeByMissionID`	Returns the follower type a mission is for. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerUnderBiasReason`	Returns why a follower is too weak for a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerXP`	Returns the experience a follower has toward its next level. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerXPTable`	Returns the follower experience table of a follower type. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowerZoneSupportAbilities`	Returns the spell IDs of a follower's combat ally (zone support) abilities. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowers`	Returns a list of garrison tech followers. `not in Blizzard's documentation`	guessed
`GetFollowersSpellsForMission`	Returns the spells of the followers on a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetFollowersTraitsForMission`	Returns the traits of the followers on a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetGarrisonInfo`	Returns information for your character's garrison. `not in Blizzard's documentation`	guessed
`GetGarrisonPlotsInstancesForMap`	Returns the garrison building plots on a map. · by wowlua `(uiMapID: number): GarrisonPlotInstanceMapInfo[]`	implemented
`GetGarrisonTalentTreeCurrencyTypes`	Returns the currency ID a talent tree's talents cost, or nothing. · by wowlua `(garrTalentTreeID: number): number?`	guessed
`GetGarrisonTalentTreeType`	Returns the type of a talent tree. · by wowlua `(garrTalentTreeID: number): number`	guessed
`GetGarrisonUpgradeCost`	Returns the material and gold cost of the garrison's next upgrade. · by wowlua `not in Blizzard's documentation`	guessed
`GetInProgressMissions`	Returns a list of active follower missions. `not in Blizzard's documentation`	guessed
`GetLandingPageGarrisonType`	Returns the garrison type the landing page (minimap button report) shows. · by wowlua `not in Blizzard's documentation`	guessed
`GetLandingPageItems`	Returns the missions shown on the landing page for a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`GetLandingPageShipmentCount`	Returns the number of shipments shown on the garrison landing page. · by wowlua `not in Blizzard's documentation`	guessed
`GetLandingPageShipmentInfo`	<!-- or , , , , --> Retrieves information about work orders for specified building. `not in Blizzard's documentation`	guessed
`GetLandingPageShipmentInfoByContainerID`	Returns information on Garrison/Class Hall/other shipment in progress. `not in Blizzard's documentation`	guessed
`GetLooseShipments`	Returns Garrison shipments in progress. `not in Blizzard's documentation`	guessed
`GetMaxCypherEquipmentLevel`	Returns the highest Cypher of the First Ones equipment level. · by wowlua `(): number`	guessed
`GetMissionBonusAbilityEffects`	Returns the bonus ability effects that apply to a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionCompleteEncounters`	Returns the enemy encounters of a completed mission. · by wowlua `(missionID: number): GarrisonEnemyEncounterInfo[]`	guessed
`GetMissionCost`	Returns the base cost and the actual cost of starting a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionDeploymentInfo`	Returns the information shown when deploying followers to a mission. · by wowlua `(missionID: number): MissionDeploymentInfo`	guessed
`GetMissionDisplayIDs`	Returns the model display IDs of a mission's followers and of its enemies. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionEncounterIconInfo`	Returns the icon information of a mission's encounter. · by wowlua `(missionID: number): MissionEncounterIconInfo`	guessed
`GetMissionLink`	Returns a chat link for a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionMaxFollowers`	Returns the number of followers a mission takes. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionName`	Returns the name of a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionRewardInfo`	Returns the rewards of a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionSuccessChance`	Returns a mission's chance of success as a percentage. It can go above 100, which the order hall UI shows as a bonus chance. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionTexture`	Returns the texture kit and map position of a mission texture on the shipyard map. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionTimes`	Returns timing information for a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetMissionUncounteredMechanics`	Returns the mechanics of a mission that its assigned followers do not counter. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumActiveFollowers`	Returns the number of active followers of a follower type. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumFollowerActivationsRemaining`	Returns how many more followers can be activated today for a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumFollowerDailyActivations`	Returns how many followers can be activated per day. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumFollowers`	Returns the number of followers the player has of a follower type. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumFollowersForMechanic`	Returns how many followers of a follower type counter a mechanic. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumFollowersOnMission`	Returns the number of followers assigned to a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumPendingShipments`	Returns the number of pending work orders at the open work order NPC. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumShipmentCurrencies`	Returns the number of currencies the open work order costs. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumShipmentReagents`	Returns the number of reagents the open work order needs. · by wowlua `not in Blizzard's documentation`	guessed
`GetOwnedBuildingInfo`	Returns detailed information about a building the player owns on a plot, among it its name, rank, costs, upgrades, specializations and whether it is under construction. · by wowlua `not in Blizzard's documentation`	guessed
`GetOwnedBuildingInfoAbbrev`	Returns basic information on garrison buildings. `not in Blizzard's documentation`	guessed
`GetPartyBuffs`	Returns the buffs the followers on a mission give. · by wowlua `not in Blizzard's documentation`	guessed
`GetPartyMentorLevels`	Returns the mentor level and mentor item level of the followers on a mission. · by wowlua `not in Blizzard's documentation`	guessed
`GetPartyMissionInfo`	Returns information about the party assigned to a mission, among it its success chance, mission effects and currency and gold multipliers. · by wowlua `not in Blizzard's documentation`	guessed
`GetPendingShipmentInfo`	Returns information about a pending work order by index, among it the time it has left. · by wowlua `not in Blizzard's documentation`	guessed
`GetPlots`	Returns the plots of the player's garrison. · by wowlua `not in Blizzard's documentation`	guessed
`GetPlotsForBuilding`	Returns the plots a garrison building can be placed on. · by wowlua `not in Blizzard's documentation`	guessed
`GetPossibleFollowersForBuilding`	Returns the followers that can be assigned to the building on a plot. · by wowlua `not in Blizzard's documentation`	guessed
`GetRecruitAbilities`	Returns the abilities of a follower offered by the garrison recruiter, by index. · by wowlua `not in Blizzard's documentation`	guessed
`GetRecruiterAbilityCategories`	Returns the ability categories the garrison recruiter offers. · by wowlua `not in Blizzard's documentation`	guessed
`GetRecruiterAbilityList`	Fills a table with the abilities or traits the player can pick at the garrison recruiter. Blizzard's UI passes whether it wants traits and the table to fill. · by wowlua `not in Blizzard's documentation`	guessed
`GetRecruitmentPreferences`	Returns the ability or trait the player chose at the garrison recruiter, with its name, description, icon and ID. · by wowlua `not in Blizzard's documentation`	guessed
`GetShipDeathAnimInfo`	Returns the animations and sounds the shipyard plays when a ship is destroyed, survives or is saved. · by wowlua `not in Blizzard's documentation`	guessed
`GetShipmentContainerInfo`	Returns the pending text and description of the open work order NPC. · by wowlua `not in Blizzard's documentation`	guessed
`GetShipmentItemInfo`	Returns what the open work order makes: its name, texture, quality, item ID, follower ID and duration. · by wowlua `not in Blizzard's documentation`	guessed
`GetShipmentReagentCurrencyInfo`	Returns the ID and amount of a currency the open work order costs, by index. · by wowlua `not in Blizzard's documentation`	guessed
`GetShipmentReagentInfo`	Returns a reagent the open work order needs, by index: its name, texture, quality, amount needed, amount owned and item ID. · by wowlua `not in Blizzard's documentation`	guessed
`GetShipmentReagentItemLink`	Returns an item link for a reagent of the open work order, by index. · by wowlua `not in Blizzard's documentation`	guessed
`GetSpecChangeCost`	Returns the currency and cost of changing a building's specialization. · by wowlua `not in Blizzard's documentation`	guessed
`GetTabForPlot`	Returns the building size category of a garrison plot. · by wowlua `not in Blizzard's documentation`	guessed
`GetTalentInfo`	Returns information about a garrison talent. · by wowlua `(talentID: number): GarrisonTalentInfo`	guessed
`GetTalentPointsSpentInTalentTree`	Returns the number of talent points spent in a talent tree. · by wowlua `(garrTalentTreeID: number): number`	guessed
`GetTalentTreeIDsByClassID`	Returns the IDs of the talent trees of a garrison type for a class, or nothing. · by wowlua `(garrType: number, classID: number): number[]?`	guessed
`GetTalentTreeInfo`	Returns information about a garrison talent tree. · by wowlua `(treeID: number): GarrisonTalentTreeInfo`	guessed
`GetTalentTreeResetInfo`	Returns the money and currency costs of resetting a talent tree. · by wowlua `(garrTalentTreeID: number): (number, GarrisonTalentCurrencyCostInfo[])`	guessed
`GetTalentTreeTalentPointResearchInfo`	Returns the money cost, currency costs and duration of researching a talent point in a talent tree. · by wowlua `(garrTalentID: number, researchRank: number, garrTalentTreeID: number, talentPointIndex: number, isRespec: boolean): (number, GarrisonTalentCurrencyCostInfo[], number)`	guessed
`GetTalentUnlockWorldQuest`	Returns the ID of the world quest that unlocks a garrison talent, or nothing. · by wowlua `(talentID: number): number?`	guessed
`HasAdventures`	Whether the player has access to adventures. · by wowlua `(): boolean`	guessed
`HasGarrison`	Returns whether the player has a garrison of a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`HasShipyard`	Returns true if you have a shipyard. `not in Blizzard's documentation`	guessed
`IsAboveFollowerSoftCap`	Returns whether the player has more active followers of a follower type than the soft cap. · by wowlua `not in Blizzard's documentation`	guessed
`IsAtGarrisonMissionNPC`	Whether the player is interacting with a mission table. · by wowlua `(): boolean`	guessed
`IsEnvironmentCountered`	Whether the mission's environment effect is countered by the assigned followers. · by wowlua `(missionID: number): boolean`	guessed
`IsFollowerCollected`	Returns whether the player has collected a follower. · by wowlua `not in Blizzard's documentation`	guessed
`IsFollowerOnCompletedMission`	Whether the follower is on a mission that has completed. · by wowlua `(followerID: GarrisonFollower): boolean`	guessed
`IsInvasionAvailable`	Returns whether a garrison invasion is available. · by wowlua `not in Blizzard's documentation`	guessed
`IsLandingPageMinimapButtonVisible`	Whether the minimap button of a garrison type's landing page is shown. · by wowlua `(garrType: number): boolean`	guessed
`IsMechanicFullyCountered`	Returns whether a follower's ability fully counters a mechanic on a mission. · by wowlua `not in Blizzard's documentation`	guessed
`IsOnGarrisonMap`	Returns whether the player is on a garrison map. · by wowlua `not in Blizzard's documentation`	implemented
`IsOnShipmentQuestForNPC`	Returns whether the player is on the quest for the open work order NPC. · by wowlua `not in Blizzard's documentation`	guessed
`IsOnShipyardMap`	Returns whether the player is on the shipyard map. · by wowlua `not in Blizzard's documentation`	guessed
`IsPlayerInGarrison`	Returns whether the player is in their garrison of a garrison type. · by wowlua `not in Blizzard's documentation`	guessed
`IsTalentConditionMet`	Whether the garrison talent's condition is met, and the reason when it is not. · by wowlua `(talentID: number): (boolean, string?)`	guessed
`IsUsingPartyGarrison`	Returns whether your are viewing your party leader's Garrison. `not in Blizzard's documentation`	guessed
`IsVisitGarrisonAvailable`	Returns whether the player can visit another player's garrison. Blizzard's unit menu offers it only outside cross-faction groups. · by wowlua `not in Blizzard's documentation`	guessed
`MarkMissionComplete`	Acknowledges mission completion. `not in Blizzard's documentation`	guessed
`MissionBonusRoll`	Receives mission loot. `not in Blizzard's documentation`	guessed
`PlaceBuilding`	Places a garrison building on a plot. Blizzard's UI passes the plot ID and the building ID. · by wowlua `not in Blizzard's documentation`	guessed
`RecruitFollower`	Recruits a follower the garrison recruiter offers. · by wowlua `not in Blizzard's documentation`	guessed
`RegenerateCombatLog`	Rebuilds the combat log of an adventure and returns whether it succeeded. · by wowlua `(missionID: number): boolean`	guessed
`RemoveFollower`	Removes one of the player's followers. The shipyard uses it to decommission a ship. · by wowlua `not in Blizzard's documentation`	guessed
`RemoveFollowerFromBuilding`	Removes the follower working in the building on a plot. · by wowlua `not in Blizzard's documentation`	guessed
`RemoveFollowerFromMission`	Removes a follower from a mission. · by wowlua `(missionID: number, followerID: GarrisonFollower, boardIndex: number?)`	guessed
`RenameFollower`	Renames a follower. The shipyard uses it to rename ships; an empty name resets it to the default. · by wowlua `not in Blizzard's documentation`	guessed
`RequestClassSpecCategoryInfo`	Asks the server for the follower class spec categories of a follower type, read with `C_Garrison.GetClassSpecCategoryInfo`. · by wowlua `not in Blizzard's documentation`	guessed
`RequestGarrisonUpgradeable`	Asks the server whether the garrison can be upgraded. · by wowlua `not in Blizzard's documentation`	guessed
`RequestLandingPageShipmentInfo`	Asks the server for the shipment information shown on the garrison landing page. · by wowlua `not in Blizzard's documentation`	guessed
`RequestShipmentCreation`	Starts work orders at the open work order NPC. Blizzard's UI passes how many to start. · by wowlua `not in Blizzard's documentation`	guessed
`RequestShipmentInfo`	Asks the server for the information of the open work order NPC. · by wowlua `not in Blizzard's documentation`	guessed
`ResearchTalent`	Starts researching a garrison talent. Blizzard's UI passes the talent ID and the rank to research. · by wowlua `not in Blizzard's documentation`	guessed
`RushHealAllFollowers`	Heals all followers of a follower type immediately. · by wowlua `(followerType: number)`	guessed
`RushHealFollower`	Heals a follower immediately. · by wowlua `(garrFollowerID: GarrisonFollower)`	guessed
`SearchForFollower`	Returns whether a follower matches a search text. · by wowlua `not in Blizzard's documentation`	guessed
`SetAutoCombatSpellFastForward`	Sets whether adventure combat playback is fast-forwarded. · by wowlua `(state: boolean)`	guessed
`SetBuildingActive`	Activates a garrison building on a plot. · by wowlua `not in Blizzard's documentation`	guessed
`SetBuildingSpecialization`	Sets the specialization of the building on a plot. · by wowlua `not in Blizzard's documentation`	guessed
`SetFollowerFavorite`	Sets whether a follower is marked as a favorite. · by wowlua `not in Blizzard's documentation`	guessed
`SetFollowerInactive`	Sets whether a follower is inactive. Reactivating one costs gold and counts against the daily activations. · by wowlua `not in Blizzard's documentation`	guessed
`SetRecruitmentPreferences`	Sets the ability and trait the garrison recruiter should favour; 0 means none. · by wowlua `not in Blizzard's documentation`	guessed
`SetUsingPartyGarrison`	Switches between viewing your party leader's Garrison or your own. `not in Blizzard's documentation`	guessed
`ShouldShowMapTab`	Returns whether the mission UI of a garrison type should show its map tab. · by wowlua `not in Blizzard's documentation`	guessed
`ShowFollowerNameInErrorMessage`	Returns whether a mission requires exactly one specific follower, and that follower's ID, for the mission page's error message. · by wowlua `not in Blizzard's documentation`	guessed
`StartMission`	Starts a mission. `not in Blizzard's documentation`	guessed
`SwapBuildings`	Swaps the buildings on two garrison plots. · by wowlua `not in Blizzard's documentation`	guessed
`TargetSpellHasFollowerItemLevelUpgrade`	Returns whether the spell waiting for a target raises a follower's item level. · by wowlua `not in Blizzard's documentation`	guessed
`TargetSpellHasFollowerReroll`	Returns whether the spell waiting for a target rerolls a follower, and whether it rerolls abilities and traits. · by wowlua `not in Blizzard's documentation`	guessed
`TargetSpellHasFollowerTemporaryAbility`	Returns whether the spell waiting for a target gives a follower a temporary ability. · by wowlua `not in Blizzard's documentation`	guessed
`UpgradeBuilding`	Upgrades the building on a plot. · by wowlua `not in Blizzard's documentation`	guessed
`UpgradeGarrison`	Upgrades the player's garrison to its next level. · by wowlua `not in Blizzard's documentation`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`GARRISON_ARCHITECT_CLOSED`	`no payload`	not implemented
`GARRISON_ARCHITECT_OPENED`	`followerTypeID: number`	not implemented
`GARRISON_BUILDING_ACTIVATABLE`	`buildingName: string, garrisonType: number`	not implemented
`GARRISON_BUILDING_ACTIVATED`	`garrisonPlotInstanceID: number, garrisonBuildingID: number`	not implemented
`GARRISON_BUILDING_ERROR`	`no payload`	not implemented
`GARRISON_BUILDING_LIST_UPDATE`	`categoryID: number`	not implemented
`GARRISON_BUILDING_PLACED`	`garrisonPlotInstanceID: number, newPlacement: boolean`	not implemented
`GARRISON_BUILDING_REMOVED`	`garrPlotInstanceID: number, garrBuildingID: number`	not implemented
`GARRISON_BUILDING_UPDATE`	`garrisonBuildingID: number, garrPlotInstanceID: number?`	not implemented
`GARRISON_FOLLOWER_ADDED`	`followerDbID: GarrisonFollower, followerName: string, followerClassName: string, followerLevel: number, followerQuality: number, isUpgraded: boolean, textureKit: string, followerTypeID: number`	not implemented
`GARRISON_FOLLOWER_CATEGORIES_UPDATED`	`no payload`	not implemented
`GARRISON_FOLLOWER_DURABILITY_CHANGED`	`garrFollowerTypeID: number, followerDbID: GarrisonFollower, followerDurability: number`	not implemented
`GARRISON_FOLLOWER_HEALED`	`followerID: GarrisonFollower`	not implemented
`GARRISON_FOLLOWER_LIST_UPDATE`	`followerTypeID: number`	not implemented
`GARRISON_FOLLOWER_REMOVED`	`followerTypeID: number`	not implemented
`GARRISON_FOLLOWER_UPGRADED`	`followerDbID: GarrisonFollower`	not implemented
`GARRISON_FOLLOWER_XP_CHANGED`	`garrFollowerTypeID: number, followerDbID: GarrisonFollower, xpChange: number, oldFollowerXp: number, oldFollowerLevel: number, oldFollowerQuality: number`	not implemented
`GARRISON_HIDE_LANDING_PAGE`	`no payload`	implemented
`GARRISON_INVASION_AVAILABLE`	`no payload`	not implemented
`GARRISON_INVASION_UNAVAILABLE`	`no payload`	not implemented
`GARRISON_LANDINGPAGE_SHIPMENTS`	`no payload`	implemented
`GARRISON_MISSION_AREA_BONUS_ADDED`	`garrisonMissonBonusAbilityID: number`	not implemented
`GARRISON_MISSION_BONUS_ROLL_COMPLETE`	`missionID: number, success: boolean`	not implemented
`GARRISON_MISSION_COMPLETE_RESPONSE`	`missionID: number, canComplete: boolean, success: boolean, bonusRollSuccess: boolean, followerDeaths: GarrisonFollowerDeathInfo[], autoCombatResult: AutoCombatResult?`	not implemented
`GARRISON_MISSION_FINISHED`	`followerTypeID: number, missionID: number`	not implemented
`GARRISON_MISSION_LIST_UPDATE`	`garrFollowerTypeID: number`	not implemented
`GARRISON_MISSION_NPC_CLOSED`	`no payload`	not implemented
`GARRISON_MISSION_NPC_OPENED`	`followerTypeID: number`	not implemented
`GARRISON_MISSION_REWARD_INFO`	`missionID: number, followerDbID: GarrisonFollower`	not implemented
`GARRISON_MISSION_STARTED`	`garrFollowerTypeID: number, missionID: number`	not implemented
`GARRISON_MONUMENT_CLOSE_UI`	`no payload`	not implemented
`GARRISON_MONUMENT_LIST_LOADED`	`success: boolean`	not implemented
`GARRISON_MONUMENT_REPLACED`	`success: boolean`	not implemented
`GARRISON_MONUMENT_SELECTED_TROPHY_ID_LOADED`	`success: boolean`	not implemented
`GARRISON_MONUMENT_SHOW_UI`	`no payload`	not implemented
`GARRISON_RANDOM_MISSION_ADDED`	`followerTypeID: number, missionID: number`	not implemented
`GARRISON_RECALL_PORTAL_LAST_USED_TIME`	`success: boolean, recallPortalLastUsedTime: number`	not implemented
`GARRISON_RECALL_PORTAL_USED`	`success: boolean`	not implemented
`GARRISON_RECRUITMENT_FOLLOWERS_GENERATED`	`no payload`	not implemented
`GARRISON_RECRUITMENT_NPC_CLOSED`	`no payload`	not implemented
`GARRISON_RECRUITMENT_NPC_OPENED`	`followerTypeID: number`	not implemented
`GARRISON_RECRUITMENT_READY`	`no payload`	not implemented
`GARRISON_RECRUIT_FOLLOWER_RESULT`	`no payload`	not implemented
`GARRISON_SHIPMENT_RECEIVED`	`no payload`	not implemented
`GARRISON_SHIPYARD_NPC_CLOSED`	`no payload`	not implemented
`GARRISON_SHIPYARD_NPC_OPENED`	`followerTypeID: number`	not implemented
`GARRISON_SHOW_LANDING_PAGE`	`no payload`	not implemented
`GARRISON_SPEC_GROUPS_CLEARED`	`garrTypeID: number`	not implemented
`GARRISON_SPEC_GROUP_UPDATED`	`garrTypeID: number, specID: number`	not implemented
`GARRISON_TALENT_COMPLETE`	`garrTypeID: number, doAlert: boolean`	not implemented
`GARRISON_TALENT_EVENT_UPDATE`	`eventType: number, eventID: number`	not implemented
`GARRISON_TALENT_NPC_CLOSED`	`no payload`	not implemented
`GARRISON_TALENT_NPC_OPENED`	`garrisonTypeID: number, garrisonTalentTreeID: number`	not implemented
`GARRISON_TALENT_RESEARCH_STARTED`	`garrTypeID: number, garrisonTalentTreeID: number, garrTalentID: number`	not implemented
`GARRISON_TALENT_UNLOCKS_RESULT`	`no payload`	not implemented
`GARRISON_TALENT_UPDATE`	`garrTypeID: number`	not implemented
`GARRISON_TRADESKILL_NPC_CLOSED`	`no payload`	not implemented
`GARRISON_UPDATE`	`no payload`	implemented
`GARRISON_UPGRADEABLE_RESULT`	`garrisonUpgradeable: boolean`	not implemented
`GARRISON_USE_PARTY_GARRISON_CHANGED`	`no payload`	not implemented
`SHIPMENT_CRAFTER_CLOSED`	`no payload`	not implemented
`SHIPMENT_CRAFTER_INFO`	`success: number, shipmentCount: number, maxShipments: number, ownedShipments: number, plotInstanceID: number`	not implemented
`SHIPMENT_CRAFTER_OPENED`	`charShipmentContainerID: number`	not implemented
`SHIPMENT_CRAFTER_REAGENT_UPDATE`	`no payload`	not implemented
`SHIPMENT_UPDATE`	`shipmentStarted: boolean?, hasAttachedFollower: boolean?`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("GARRISON_ARCHITECT_CLOSED").

Structures

AutoCombatDamageClassString · damageClassValue, locString
AutoCombatResult · winner, combatLog
AutoCombatSpellInfo · autoCombatSpellID, name, description, cooldown, duration, schoolMask, previewMask, icon, spellTutorialFlag, hasThornsEffect
AutoCombatTroopInfo · name, followerID, garrFollowerID, followerTypeID, displayIDs, level, quality, levelXP, maxXP, height, scale, displayScale?, displayHeight?, classSpec?, className?, flavorText?, classAtlas, portraitIconID, textureKit, isTroop, raceID, health, maxHealth, role, isAutoTroop, isSoulbind, isCollected, autoCombatStats
AutoMissionCombatEventInfo · boardIndex, oldHealth, newHealth, maxHealth, points?
AutoMissionEnvironmentEffect · name, autoCombatSpellInfo
AutoMissionEvent · type, spellID, schoolMask, effectIndex, casterBoardIndex, auraType, targetInfo
AutoMissionRound · events
AutoMissionTargetingInfo · targetIndex, previewType, spellID, effectIndex
FollowerAutoCombatStatsInfo · currentHealth, maxHealth, attack, healingTimestamp, healCost, minutesHealingRemaining
FollowerDisplayID · id, followerPageScale, showWeapon
FollowerMissionCompleteInfo · name, displayIDs, level, quality, currentXP, maxXP, height, scale, movementType?, impactDelay?, castID?, castSoundID?, impactID?, impactSoundID?, targetImpactID?, targetImpactSoundID?, className?, classAtlas, portraitIconID, textureKit, isTroop, boardIndex, health, maxHealth, role
GarrisonAbilityCounterInfo · id, icon, name, factor, description
GarrisonAbilityInfo · id, name, description, icon, isTrait, isSpecialization, temporary, category?, counters, isEmptySlot
GarrisonEnemyEncounterInfo · name, displayID, portraitFileDataID, textureKit, scale, height, mechanics, autoCombatSpells, autoCombatAutoAttack?, role, health, maxHealth, attack, boardIndex, isElite
GarrisonFollowerDeathInfo · followerID, state
GarrisonMechanicInfo · mechanicTypeID, icon, name, factor, description, ability?
GarrisonPlotInstanceMapInfo · buildingPlotInstanceID, position, name, atlasName
MissionDeploymentInfo · location, xp, environment?, environmentDesc?, environmentTexture, locTextureKit, isExhausting, enemies
MissionEncounterIconInfo · portraitFileDataID, missionScalar, isElite, isRare

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (GarrisonInfo system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.