C_NeighborhoodInitiative

namespaceavailable in: camelot

Status in wowlua

20 functions: 0 implemented, 1 recorded, 19 guessed. 6 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`AddTrackedInitiativeTask`	Tracks a neighborhood initiative task. · by wowlua `(initiativeTaskID: number)`	guessed
`GetActiveNeighborhood`	Returns the GUID of the player's active neighborhood. · by wowlua `(): string`	guessed
`GetAvailableHouseXP`	Returns the house experience the player can still earn. · by wowlua `(): number`	guessed
`GetInitiativeActivityLogInfo`	Returns the activity log of the neighborhood initiative. · by wowlua `(): InitiativeActivityLogInfo?`	guessed
`GetInitiativeTaskChatLink`	Returns a chat link to a neighborhood initiative task. · by wowlua `(initiativeTaskID: number): string`	guessed
`GetInitiativeTaskInfo`	Returns information about a neighborhood initiative task. · by wowlua `(initiativeTaskID: number): InitiativeTaskInfo?`	guessed
`GetInitiativeTaskRewardScaling`	Returns the reward scaling of a neighborhood initiative task for a number of items. · by wowlua `(taskID: number, numItems: number): number`	guessed
`GetNeighborhoodInitiativeInfo`	Returns information about the neighborhood initiative. · by wowlua `(): NeighborhoodInitiativeInfo?`	guessed
`GetRequiredLevel`	Returns the player level the neighborhood initiative requires. · by wowlua `(): number`	guessed
`GetTrackedInitiativeTasks`	Returns the tracked neighborhood initiative tasks. · by wowlua `(): InitiativeTasksTracked`	recorded
`IsInitiativeEnabled`	Whether the neighborhood initiative is available. · by wowlua `(): boolean`	guessed
`IsPlayerInNeighborhoodGroup`	Whether the player is in a group with their neighborhood. · by wowlua `(): boolean`	guessed
`IsViewingActiveNeighborhood`	Whether the player is viewing their active neighborhood. · by wowlua `(): boolean`	guessed
`PlayerHasInitiativeAccess`	Whether the player has access to the neighborhood initiative. · by wowlua `(): boolean`	guessed
`PlayerMeetsRequiredLevel`	Whether the player has the level the neighborhood initiative requires. · by wowlua `(): boolean`	guessed
`RemoveTrackedInitiativeTask`	Stops tracking a neighborhood initiative task. · by wowlua `(initiativeTaskID: number)`	guessed
`RequestInitiativeActivityLog`	Asks the server for the neighborhood initiative's activity log. · by wowlua `()`	guessed
`RequestNeighborhoodInitiativeInfo`	Asks the server for the neighborhood initiative's information. · by wowlua `()`	guessed
`SetActiveNeighborhood`	Sets the player's active neighborhood. · by wowlua `(neighborhoodGUID: string)`	guessed
`SetViewingNeighborhood`	Sets the neighborhood the player is viewing. · by wowlua `(neighborhoodGUID: string)`	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
`INITIATIVE_ACTIVITY_LOG_UPDATED`	`no payload`	not implemented
`INITIATIVE_COMPLETED`	`initiativeTitle: string`	not implemented
`INITIATIVE_TASKS_TRACKED_LIST_CHANGED`	`initiativeTaskID: number, added: boolean`	not implemented
`INITIATIVE_TASKS_TRACKED_UPDATED`	`no payload`	not implemented
`INITIATIVE_TASK_COMPLETED`	`taskName: string`	not implemented
`NEIGHBORHOOD_INITIATIVE_UPDATED`	`no payload`	not implemented

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

Structures

InitiativeActivityLogEntry · taskID, playerName, taskName, completionTime, amount
InitiativeActivityLogInfo · isLoaded, neighborhoodGUID, nextUpdateTime, taskActivity
InitiativeMilestoneInfo · milestoneOrderIndex, requiredContributionAmount, rewards
InitiativeMilestoneRewardInfo · title, description, decorID, decorQuantity, favor, money, rewardQuestID
InitiativeTaskInfo · ID, taskName, description, progressContributionAmount, tracked, supersedes, timesCompleted, completed, inProgress, taskType, sortOrder, rewardQuestID, requirementsList, criteriaList
InitiativeTasksTracked · trackedIDs
NeighborhoodInitiativeInfo · isLoaded, neighborhoodGUID, initiativeID, currentCycleID, progressRequired, currentProgress, playerTotalContribution, duration, tasks, milestones, title, description

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (NeighborhoodInitiative system, camelot 1.60.1). Descriptions: written by wowlua where no documentation describes the entry.