C_ContributionCollector

namespaceavailable in: camelot

Status in wowlua

18 functions: 1 implemented, 0 recorded, 17 guessed. 4 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`Close`	Closes the contribution collector API state. `()`	guessed
`Contribute`	Contributes resources to a building. `(contributionID: number)`	guessed
`GetActive`	Returns the currently active buildings. `(): number`	guessed
`GetAtlases`	Returns a table listing the possible states for a building. `(contributionID: number): string[]`	guessed
`GetBuffs`	Returns the buffs provided by a building (e.g. in a Warfront). `(contributionID: number): number`	guessed
`GetContributionAppearance`	Returns contribution appearance info. `(contributionID: number, contributionState: ContributionState): ContributionAppearance?`	guessed
`GetContributionCollectorsForMap`	Returns contribution buildings on a map. `(uiMapID: number): ContributionMapInfo[]`	implemented
`GetContributionResult`	Returns a value indicating the result of a contribution. `(contributionID: number): ContributionResult`	guessed
`GetDescription`	Returns the description of a building. `(contributionID: number): string`	guessed
`GetManagedContributionsForCreatureID`	Returns contributions for a creature. `(creatureID: number): number`	guessed
`GetName`	Returns the name of a building. `(contributionID: number): string`	guessed
`GetOrderIndex`	Returns the order in which buildings are displayed. `(contributionID: number): number`	guessed
`GetRequiredContributionCurrency`	Returns the currencyID and amount needed to contribute to a building. `(contributionID: number): (number?, number?)`	guessed
`GetRequiredContributionItem`	Returns the itemID and amount needed to contribute to a building. `(contributionID: number): (number?, number?)`	guessed
`GetRewardQuestID`	Returns the hidden quest that is flagged completed when a contribution is made. `(contributionID: number): number`	guessed
`GetState`	Returns the current state of a building, its completion percentage, and time until next state change. `(contributionID: number): (ContributionState, number, number?, number)`	guessed
`HasPendingContribution`	Returns whether there is a pending contribution. `(contributionID: number): boolean`	guessed
`IsAwaitingRewardQuestData`	Returns true if the client is waiting for quest reward data. `(contributionID: number): boolean`	guessed

Events

event	payload	fired by the emulator
`CONTRIBUTION_CHANGED`	`state: ContributionState, result: ContributionResult, name: string, contributionID: number`	not implemented
`CONTRIBUTION_COLLECTOR_PENDING`	`contributionID: number, isPending: boolean, result: number`	not implemented
`CONTRIBUTION_COLLECTOR_UPDATE`	`no payload`	not implemented
`CONTRIBUTION_COLLECTOR_UPDATE_SINGLE`	`contributionID: number`	not implemented

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

Structures

ContributionAppearance · stateName, stateColor, tooltipLine, tooltipUseTimeRemaining, statusBarAtlas, borderAtlas, bannerAtlas
ContributionMapInfo · areaPoiID, position, name, atlasName, collectorCreatureID

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (ContributionCollector system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗.