VoK.Sdk
Doxygen generated documentation for the Dungeon Helper SDK
VoK.Sdk.Plugins.IPlugin Interface Reference

wireframe for a plugin in Dungeon Helper. Please note that implementations must have an empty constructor in order for the Dungeon Helper engine to instantiate it. This empty constructor should not assume any other data points or dependencies are available (aside from your own) when invoked. Please note - instances of your plugin will persist as long as a client is open. players may log in an out and your plugin instance will remain the same. If Dungeon Helper is stopped and restarted, plugins will stop and restart as well. More...

Inherited by VoK.Sdk.Ddo.IDdoPlugin, and VoK.Sdk.Lotro.ILotroPlugin.

Public Member Functions

IPluginUI GetPluginUI ()
 fetched when the user clicks your icon in the toolbar. it will be rendered inside the Dungeon Helper ingame UI. More...
 
void Terminate ()
 your chance to close up connections or shared resources before your plugin is cleaned up. called after Dungeon Helper has detected the game client to be closed. any saved references to the gameDataProvider are no longer valid. More...
 

Properties

Guid PluginId [get]
 PluginId Assigned to you from Morrikan. More...
 
GameId Game [get]
 probably DDO More...
 
string PluginKey [get]
 private encryption key assigned to you from Morrikan More...
 
string Name [get]
 Name of the plugin that appears in Dungeon Helper More...
 
string Description [get]
 Description that appears in Dungeon Helper More...
 
string Author [get]
 your chance to get recoginized More...
 
Version Version [get]
 probably best to just map this to your assembly data, but up to you. More...
 

Detailed Description

wireframe for a plugin in Dungeon Helper. Please note that implementations must have an empty constructor in order for the Dungeon Helper engine to instantiate it. This empty constructor should not assume any other data points or dependencies are available (aside from your own) when invoked. Please note - instances of your plugin will persist as long as a client is open. players may log in an out and your plugin instance will remain the same. If Dungeon Helper is stopped and restarted, plugins will stop and restart as well.


The documentation for this interface was generated from the following file: