VoK.Sdk
Doxygen generated documentation for the Dungeon Helper SDK
Plugin Messages

Classes

interface  IActiveEffect
 Represents an active effect on an Entity. More...
 
interface  IBank
 interface for defining a bank. ie, the shared bank, the character bank, etc More...
 
interface  IBankDataMessage
 definition for a bank data message More...
 
interface  IBankItem
 interface representing an item in the new banking system. More...
 
interface  IBankPage
 page of items in a bank More...
 
interface  IBankTab
 data about a bank tab. ingame, a tab is a user-defined organization mechanism to the right of the item listing. More...
 
interface  IBankTabDataMessage
 definition for a bank tab data message More...
 
interface  IConfirmResurrectionMessage
 
interface  IEffectAblativeUse
 data about ablative damage removed from an effect More...
 
interface  IEffectDialog
 Triggers when an effect requires a UI dialog. Most common usage: Greater Teleport. More...
 
interface  IEffectExpress
 data about an Effect applied to the current character. default effect properties are parsed for you. More...
 
interface  IEffectUpdateDuration
 data about an effects duration and paused state More...
 
interface  IEnhancementTree
 represents a selected enhancement tree in the enhancement UI. More...
 
interface  IPortalInfo
 information give in the quest dialog selection window (aka PortalActivate) More...
 

Functions

DateTime? IActiveEffect.CalculateExpiration ()
 calculates the expiration of the Effect. If the effect is indefinite, DateTime.MaxValue is returned. More...
 

Properties

int IActiveEffect.EffectDid [get]
 Did (0x70 id) of the Effect being applied. More...
 
int IActiveEffect.EffectId [get]
 ID of the effect used for later updates. Sourced from DdoProperty.Effect_ID in the Properties list. More...
 
int? IActiveEffect.StackSize [get]
 Number of stacks of the Effect. Sourced from DdoProperty.Effect_StackSize in the Properties list. More...
 
float? IActiveEffect.Duration [get]
 Duration, in seconds of the Effect. -1 if the effect is permanent. Sourced from DdoProperty.Effect_Duration in the Properties list. More...
 
int IActiveEffect.AblativeReduction [get]
 Ablative damage reduction remaining. Sourced from DdoProperty.Effect_AblativeDamageReductionRemaining in the Properties list. More...
 
int IActiveEffect.AblativeResistance [get]
 Ablative damage resistance remaining. Sourced from DdoProperty.Effect_AblativeDamageResistanceRemaining in the Properties list. More...
 
double? IActiveEffect.ApplicationTimestamp [get]
 When the effect was created, relative to the time the client was notified. When playing, this is always 0. Upon logging in, this is negative to represent time already ticked down from the initial duration. Sourced from DdoProperty.Effect_ApplicationTimestamp in the Properties list. More...
 
List< IPropertyIActiveEffect.Properties [get]
 full property list associated with this effect. More...
 
DateTime? IActiveEffect.TimerUpdatedDate [get, set]
 Last time the client received an update on the timer. These are not always, or even typically, present in an effect. More...
 
bool IActiveEffect.IsPaused [get, set]
 whether or not the Effect timer is Paused (ie, not counting down), if applicable. More...
 
BankType IBank.BankType [get]
 type of bank this is More...
 
IReadOnlyCollection< IBankTabIBank.Tabs [get]
 the collection of tabs in this bank More...
 
int IBankDataMessage.Capacity [get]
 capacity of the bank being messaged More...
 
int IBankDataMessage.ItemsInTab [get]
 how many items are in this tab More...
 
int IBankDataMessage.TabPages [get]
 how many pages of items there are in this tab More...
 
int IBankDataMessage.CurrentTabPage [get]
 current tab page More...
 
BankType IBankDataMessage.BankType [get]
 type of bank More...
 
int IBankDataMessage.TotalItems [get]
 number of items to expect More...
 
IReadOnlyCollection< IBankItemIBankDataMessage.Items [get]
 items in the message More...
 
int IBankItem.Index [get]
 index of the item in the tab list More...
 
ulong IBankItem.Id [get]
 Id of the item More...
 
ulong IBankItem.TabIid [get]
 when this is 0, it's in the main/default tab. when the MSB is 0x0C, it's the tab id. match this against IBankTab.Iid in the IBankTabDataMessage message More...
 
int IBankItem.Quantity [get]
 Quanity, if stacking. Will default to 1 if not present More...
 
int IBankItem.MinLevel [get]
 Minimum Level if known. Will default to 0 if not present. More...
 
DateTime? IBankItem.DateAdded [get]
 No clue on the timezone here. likely either UTC or local server time (SSG servers are in US-East, so UTC-4 or 5, depending on time of year) More...
 
IPropertyCollection IBankItem.Properties [get]
 properties of the item. warning, this will be fewer than standard items in inventory, so be careful. More...
 
IReadOnlyCollection< IBankItemIBankPage.Items [get]
 items on the page More...
 
int IBankTab.TabIndex [get]
 0-based index for a tab, but -1 for the "main" tab. More...
 
string IBankTab.Name [get]
 user-defined name for the tab More...
 
ulong IBankTab.Iid [get]
 each user-defined tab gets an ID, set here. the "main" tab is always 0. More...
 
BankType IBankTabDataMessage.BankType [get]
 type of the bank More...
 
int IBankTabDataMessage.TabCount [get]
 how many tabs this bank has More...
 
IReadOnlyCollection< IBankTabIBankTabDataMessage.Tabs [get]
 collection of tabs in this bank More...
 
string IConfirmResurrectionMessage.FullMessage [get]
 full message in the UI box More...
 
string IConfirmResurrectionMessage.Spell [get]
 name of the spell or effect being used to resurrect you, as it appears in the UI More...
 
string IConfirmResurrectionMessage.Caster [get]
 name of the person attempting to resurrect you, as it appears in the UI More...
 
int IEffectAblativeUse.EffectId [get]
 
int IEffectAblativeUse.DamageAmount [get]
 
int IEffectDialog.EffectDid [get]
 Did (0x70 id) of the effect being applied. More...
 
ulong IEffectDialog.EffectSource [get]
 Id of the object (usually another character) triggering or casting the effect. Sourced from DdoProperty.Effect_Source in the properties list. In the event that the effect was cast from an item or scroll, it is the ID of that item/scroll. More...
 
ulong IEffectDialog.EffectOriginator [get]
 Id of the object (usually another character) from which the effect originated. Sourced from DdoProperty.Effect_Originator in the properties list. More...
 
int IEffectDialog.EffectSpellDid [get]
 Did (0x70 id) of the spell, if applicable. Sourced from DdoProperty.Effect_SpellDID in the Properties list. More...
 
int IEffectDialog.EffectId [get]
 ID of the effect used for later updates. Sourced from DdoProperty.Effect_ID in the Properties list. More...
 
float? IEffectDialog.Duration [get]
 Duration, in seconds of the Effect. -1 if the effect is permanent. Sourced from DdoProperty.Effect_Duration in the Properties list. More...
 
double? IEffectDialog.ApplicationTimestamp [get]
 Server timestamp, in theory. Almost always 0 in practice. Sourced from DdoProperty.Effect_ApplicationTimestamp in the Properties list. More...
 
List< IPropertyIEffectDialog.Properties [get]
 full property list associated with this effect. More...
 
int IEffectExpress.EffectDid [get]
 Did (0x70 id) of the effect being applied. More...
 
int? IEffectExpress.EffectId [get]
 ID of the effect used for later updates. Sourced from DdoProperty.Effect_ID in the Properties list. More...
 
int? IEffectExpress.StackSize [get]
 Number of stacks of the Effect. Sourced from DdoProperty.Effect_StackSize in the Properties list. More...
 
float? IEffectExpress.Duration [get]
 Duration, in seconds of the Effect. -1 if the effect is permanent. Sourced from DdoProperty.Effect_Duration in the Properties list. More...
 
int? IEffectExpress.AblativeReduction [get]
 Ablative damage reduction remaining. Sourced from DdoProperty.Effect_AblativeDamageReductionRemaining in the Properties list. More...
 
int? IEffectExpress.AblativeResistance [get]
 Ablative damage resistance remaining. Sourced from DdoProperty.Effect_AblativeDamageResistanceRemaining in the Properties list. More...
 
double? IEffectExpress.ApplicationTimestamp [get]
 Server timestamp, in theory. Almost always 0 in practice. Sourced from DdoProperty.Effect_ApplicationTimestamp in the Properties list. More...
 
List< IPropertyIEffectExpress.Properties [get]
 full property list associated with this effect. More...
 
float IEffectUpdateDuration.OriginalDuration [get]
 the original duration of the effect More...
 
int IEffectUpdateDuration.RemainingSeconds [get]
 number of seconds remaining of the effect More...
 
bool IEffectUpdateDuration.IsPaused [get]
 whether or not the timer is paused More...
 
int IEffectUpdateDuration.EffectId [get]
 ID of the effect to which this update applies More...
 
string IEnhancementTree.Name [get]
 name of the tree, as it appears in the Enhancement panel UI. this will not correspond to common wiki values. for example: "Enlightened Spirit (Wlk)" and "Arcanotechnician (Art)" More...
 
uint IEnhancementTree.Did [get]
 Data ID for the enhancement tree. You can load the tree's master property file through IPropertyMaster More...
 
int IEnhancementTree.ActionPointSpend [get]
 how many points are currently spent in this tree More...
 
IPropertyCollection IEnhancementTree.Properties [get]
 usually empty, but properties are allowed here so we're exposing them More...
 
IReadOnlyCollection< uint > IEnhancementTree.SelectedEnhancements [get]
 these are the selected enhancements in a tree, in order. Please note, enhancements with 3 levels are really 3 different enhancements, so this list should not contain duplicates. you can load the enhancement data through IPropertyMaster. More...
 
ulong? IPortalInfo.OpenDuration [get]
 timer for how long the quest has been open. seems to be milliseconds, but not committing to that. More...
 
uint? IPortalInfo.ActiveInstanceDid [get]
 Did of the instance that is active More...
 
uint? IPortalInfo.QuestGenericDifficulty [get]
 Property Id corresponding to the difficulty of the open quest More...
 
List< uint > IPortalInfo.AvailableQuests [get]
 Dids of the quests that are available inside this portal More...
 

Detailed Description