C_Soulbinds

namespaceavailable in: camelot

Status in wowlua

39 functions: 1 implemented, 0 recorded, 38 guessed. 13 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`ActivateSoulbind`	Activates the given soulbind. · by wowlua `(soulbindID: number)`	guessed
`CanActivateSoulbind`	Whether the given soulbind can be activated, and an error message when it cannot. · by wowlua `(soulbindID: number): (boolean, string?)`	guessed
`CanModifySoulbind`	Whether the player can change their soulbind's conduits and traits now. · by wowlua `(): boolean`	guessed
`CanResetConduitsInSoulbind`	Whether the conduits of the given soulbind can be reset, and an error message when they cannot. · by wowlua `(soulbindID: number): (boolean, string?)`	guessed
`CanSwitchActiveSoulbindTreeBranch`	Whether the player can switch the selected branch of the active soulbind's tree. · by wowlua `(): boolean`	guessed
`CloseUI`	Closes the soulbinds interface. · by wowlua `()`	guessed
`CommitPendingConduitsInSoulbind`	Installs the pending conduit changes in the given soulbind. · by wowlua `(soulbindID: number)`	guessed
`FindNodeIDActuallyInstalled`	Returns the ID of the node in the given soulbind where the conduit is installed. · by wowlua `(soulbindID: number, conduitID: number): number`	guessed
`FindNodeIDAppearingInstalled`	Returns the ID of the node in the given soulbind where the conduit appears installed, pending changes included. · by wowlua `(soulbindID: number, conduitID: number): number`	guessed
`FindNodeIDPendingInstall`	Returns the ID of the node in the given soulbind where the conduit is pending installation. · by wowlua `(soulbindID: number, conduitID: number): number`	guessed
`FindNodeIDPendingUninstall`	Returns the ID of the node in the given soulbind where the conduit is pending removal. · by wowlua `(soulbindID: number, conduitID: number): number`	guessed
`GetActiveSoulbindID`	Returns the ID of the player's active soulbind. · by wowlua `(): number`	guessed
`GetConduitCollection`	Returns the player's collected conduits of the given type. · by wowlua `(conduitType: SoulbindConduitType): ConduitCollectionData[]`	guessed
`GetConduitCollectionCount`	Returns the number of conduits the player has collected. · by wowlua `(): number`	guessed
`GetConduitCollectionData`	Returns the collection data of the given conduit. · by wowlua `(conduitID: number): ConduitCollectionData?`	guessed
`GetConduitCollectionDataAtCursor`	Returns the collection data of the conduit on the cursor. · by wowlua `(): ConduitCollectionData?`	guessed
`GetConduitCollectionDataByVirtualID`	Returns the collection data of a conduit by its virtual ID. · by wowlua `(virtualID: number): ConduitCollectionData?`	guessed
`GetConduitDisplayed`	Returns the ID of the conduit shown in the given node. · by wowlua `(nodeID: number): number`	guessed
`GetConduitHyperlink`	Returns a chat link for the given conduit at the given rank. · by wowlua `(conduitID: number, rank: number): string`	guessed
`GetConduitIDPendingInstall`	Returns the ID of the conduit pending installation in the given node. · by wowlua `(nodeID: number): number`	guessed
`GetConduitQuality`	Returns the item quality of the given conduit at the given rank. · by wowlua `(conduitID: number, rank: number): number`	guessed
`GetConduitRank`	Returns the rank of the given conduit. · by wowlua `(conduitID: number): number`	guessed
`GetConduitSpellID`	Returns the ID of the spell the given conduit grants at the given rank. · by wowlua `(conduitID: number, conduitRank: number): number`	guessed
`GetInstalledConduitID`	Returns the ID of the conduit installed in the given node. · by wowlua `(nodeID: number): number`	guessed
`GetNode`	Returns the data of a soulbind tree node. · by wowlua `(nodeID: number): SoulbindNode`	guessed
`GetSoulbindData`	Returns the data of the given soulbind. · by wowlua `(soulbindID: number): SoulbindData`	guessed
`GetSpecsAssignedToSoulbind`	Returns the IDs of the specializations assigned to the given soulbind. · by wowlua `(soulbindID: number): number[]`	guessed
`GetTree`	Returns the data of a soulbind tree. · by wowlua `(treeID: number): SoulbindTree`	guessed
`HasAnyInstalledConduitInSoulbind`	Whether the given soulbind has any conduit installed. · by wowlua `(soulbindID: number): boolean`	guessed
`HasAnyPendingConduits`	Whether any soulbind has pending conduit changes. · by wowlua `(): boolean`	guessed
`HasPendingConduitsInSoulbind`	Whether the given soulbind has pending conduit changes. · by wowlua `(soulbindID: number): boolean`	guessed
`IsConduitInstalled`	Whether a conduit is installed in the given node. · by wowlua `(nodeID: number): boolean`	guessed
`IsConduitInstalledInSoulbind`	Whether the given conduit is installed in the given soulbind. · by wowlua `(soulbindID: number, conduitID: number): boolean`	guessed
`IsItemConduitByItemInfo`	Whether the given item is a conduit. · by wowlua `(itemInfo: ItemInfo): boolean`	implemented
`IsNodePendingModify`	Whether the given node has a pending conduit change. · by wowlua `(nodeID: number): boolean`	guessed
`IsUnselectedConduitPendingInSoulbind`	Whether the given soulbind has a pending conduit in a node that is not selected. · by wowlua `(soulbindID: number): boolean`	guessed
`ModifyNode`	Queues a conduit change for the given node. · by wowlua `(nodeID: number, conduitID: number, type: SoulbindConduitTransactionType)`	guessed
`SelectNode`	Selects the given node in the active soulbind's tree. · by wowlua `(nodeID: number)`	guessed
`UnmodifyNode`	Cancels the pending conduit change of the given node. · by wowlua `(nodeID: number)`	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
`SOULBIND_ACTIVATED`	`soulbindID: number`	not implemented
`SOULBIND_CONDUIT_COLLECTION_CLEARED`	`no payload`	not implemented
`SOULBIND_CONDUIT_COLLECTION_REMOVED`	`conduitID: number`	not implemented
`SOULBIND_CONDUIT_COLLECTION_UPDATED`	`collectionData: ConduitCollectionData`	not implemented
`SOULBIND_CONDUIT_INSTALLED`	`nodeID: number, data: SoulbindConduitData`	not implemented
`SOULBIND_CONDUIT_UNINSTALLED`	`nodeID: number, data: SoulbindConduitData`	not implemented
`SOULBIND_FORGE_INTERACTION_ENDED`	`no payload`	not implemented
`SOULBIND_FORGE_INTERACTION_STARTED`	`no payload`	not implemented
`SOULBIND_NODE_LEARNED`	`nodeID: number`	not implemented
`SOULBIND_NODE_UNLEARNED`	`nodeID: number`	not implemented
`SOULBIND_NODE_UPDATED`	`nodeID: number`	not implemented
`SOULBIND_PATH_CHANGED`	`no payload`	not implemented
`SOULBIND_PENDING_CONDUIT_CHANGED`	`nodeID: number, conduitID: number`	not implemented

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

Structures

ConduitCollectionData · conduitID, conduitRank, conduitItemLevel, conduitType, conduitSpecSetID, conduitSpecIDs, conduitSpecName?, covenantID?, conduitItemID
SoulbindConduitData · conduitID, conduitRank
SoulbindData · ID, covenantID, name, description, textureKit, unlocked, cvarIndex, tree, modelSceneData, activationSoundKitID, playerConditionReason?
SoulbindModelSceneData · creatureDisplayInfoID, modelSceneActorID
SoulbindNode · ID, row, column, icon, spellID, playerConditionReason?, conduitID, conduitRank, state, conduitType?, parentNodeIDs, failureRenownRequirement?, socketEnhanced?
SoulbindTree · editable, nodes

sources

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