VoK.Sdk
Doxygen generated documentation for the Dungeon Helper SDK
Generic Components

Classes

class  VoK.Sdk.Ddo.NameGenerator
 Class that attempts to generate names for objects found in client_gamelogic.dat More...
 
class  VoK.Sdk.Ddo.SetBonus
 bonus that's part of a set More...
 
class  VoK.Sdk.Ddo.SetMaster
 object used to retrieve set information from the dats More...
 
class  VoK.Sdk.Exporters.ExporterFactory
 factory for getting exporter objects More...
 
interface  VoK.Sdk.Exporters.IImageExporter
 class to read client_surface.dat. does not load images from client_highres.dat More...
 
interface  VoK.Sdk.Exporters.ISoundExporter
 Used to export sounds from client_sound/client_general More...
 
interface  VoK.Sdk.Properties.IPropertyMaster
 a generic-free interface over PropertyMaster to allow for common code usage More...
 
class  VoK.Sdk.Properties.PropertyMasterFactory
 factory object for reading Property data from client_gamelogic More...
 

Enumerations

enum  VoK.Sdk.Exporters.ImageFormat {
  VoK.Sdk.Exporters.ImageFormat.Unknown = 0x00000000 ,
  VoK.Sdk.Exporters.ImageFormat.R8G8B8 = 0x00000014 ,
  VoK.Sdk.Exporters.ImageFormat.R8G8B8A8 = 0x00000015 ,
  VoK.Sdk.Exporters.ImageFormat.A8 = 0x0000001C ,
  VoK.Sdk.Exporters.ImageFormat.Jpeg = 0x000001F4 ,
  VoK.Sdk.Exporters.ImageFormat.DDS = 0x20534444 ,
  VoK.Sdk.Exporters.ImageFormat.Dxt1 = 0x31545844 ,
  VoK.Sdk.Exporters.ImageFormat.Dxt2 = 0x32545844 ,
  VoK.Sdk.Exporters.ImageFormat.Dxt3 = 0x33545844 ,
  VoK.Sdk.Exporters.ImageFormat.Dxt4 = 0x34545844 ,
  VoK.Sdk.Exporters.ImageFormat.Dxt5 = 0x35545844
}
 

Functions

static string VoK.Sdk.Ddo.NameGenerator.GetName (IPropertyMaster exporter, IPropertyCollection item, IPropertyCollection owner)
 
static string VoK.Sdk.Ddo.NameGenerator.GetEffectName (IPropertyMaster exporter, IPropertyCollection parent, IPropertyCollection effect)
 
static string VoK.Sdk.Ddo.NameGenerator.GetEffectDescription (IPropertyMaster exporter, IPropertyCollection parent, IPropertyCollection effect)
 
static string VoK.Sdk.Ddo.NameGenerator.ScrubString (string text, bool consolidateMultipleSpaces=false)
 
static SetMaster VoK.Sdk.Ddo.SetMaster.CreateSetMaster (IPropertyMaster propertyMaster)
 
static IImageExporter VoK.Sdk.Exporters.ExporterFactory.GetImageExporter (string datFolder)
 gets an instance of an image exporter More...
 
static ISoundExporter VoK.Sdk.Exporters.ExporterFactory.GetSoundExporter (string datFolder)
 gets an instance of a sound exporter More...
 
byte[] VoK.Sdk.Exporters.IImageExporter.GetImage (IDatFile datFile, uint imageId, out string fileExtension, out ImageFormat imageFormat)
 gets the raw binary of an image and provides the image format and normalized file extension. remember, some images live in the localized dat file (local_Englash.dat) More...
 
byte[] VoK.Sdk.Exporters.IImageExporter.GetImage (uint imageId, out string fileExtension, out ImageFormat imageFormat)
 gets the raw binary of an image and provides the image format and normalized file extension. will automatically check the localized file if not found in client_surface. More...
 
byte[] VoK.Sdk.Exporters.IImageExporter.GetPngImageBytes (uint imageId)
 gets the image of the associated file id and converts it to a PNG More...
 
Image VoK.Sdk.Exporters.IImageExporter.GetPngImage (uint imageId)
 gets the image of the associated file id and converts it to a PNG More...
 
string VoK.Sdk.Exporters.IImageExporter.GetPngSource (uint imageId)
 
byte[] VoK.Sdk.Exporters.IImageExporter.GetPngImageBytes (IDatFile datFile, uint imageId)
 gets the image of the associated file in the specified dat file and converts it to a PNG. if the file is not in the dat, returns null. More...
 
Image VoK.Sdk.Exporters.IImageExporter.GetPngImage (IDatFile datFile, uint imageId)
 gets the image of the associated file in the specified dat file and converts it to a PNG. if the file is not in the dat, returns null. More...
 
string VoK.Sdk.Exporters.IImageExporter.GetHtmlSource (uint imageId)
 gets the html source for a PNG image of the associated file id, in the format: "data:image/png;charset=utf-8;base64, {base64}" More...
 
string VoK.Sdk.Exporters.IImageExporter.GetHtmlSource (IDatFile datFile, uint imageId)
 
string VoK.Sdk.Exporters.IImageExporter.GetHtmlSource (byte[] pngData)
 
string VoK.Sdk.Exporters.IImageExporter.GetHtmlSource (Image image)
 
void VoK.Sdk.Exporters.IImageExporter.Overlay (Image under, Image over)
 
void VoK.Sdk.Exporters.IImageExporter.Dispose ()
 
void VoK.Sdk.Exporters.ISoundExporter.ExportById (uint fileId, string outputFolder)
 
byte[] VoK.Sdk.Exporters.ISoundExporter.GetSoundData (uint fileId, out string fileExtension)
 
string VoK.Sdk.Exporters.ISoundExporter.GetFileExtension (uint soundInfoId)
 
string VoK.Sdk.Exporters.ISoundExporter.GetHtmlSource (uint fileId)
 gets the audio embed source for the clip in the format "data:audio/{type};base64, {base64}" More...
 
string VoK.Sdk.Properties.IPropertyMaster.GetString (uint stringId, uint stringTableFileId)
 loads a strint table entry. resulting string is not formatted with placeholder replacements. More...
 
IStringEntry VoK.Sdk.Properties.IPropertyMaster.GetStringEntry (uint stringId, uint stringTableFileId)
 if this is a LiteralString, it will return null. otherwise, it goes to the string table data and returns the StringEntry object More...
 
IPropertyDefinition VoK.Sdk.Properties.IPropertyMaster.GetPropertyDefinition (uint propertyId)
 gets the property definition for the specified property, if it can be found. More...
 
string VoK.Sdk.Properties.IPropertyMaster.GetSafePropertyName (uint propertyId)
 attempts to fetch the property name of the specified property. More...
 
IPropertyCollection VoK.Sdk.Properties.IPropertyMaster.GetPropertyCollection (uint fileId)
 attempts to load the specified DID's property collection. if a 0x70 ID is provided, it will automatically attempt to load the associated 0x79 file. More...
 
IPropertyCollection VoK.Sdk.Properties.IPropertyMaster.CreatePropertyCollection (IEnumerable< IProperty > properties)
 creates a wrapped property collection around the provided list of properties More...
 
Type VoK.Sdk.Properties.IPropertyMaster.GetEnumType (uint propertyId)
 returns a typedef for the enum binding of the specified property, if applicable. More...
 
static IPropertyMaster VoK.Sdk.Properties.PropertyMasterFactory.GetPropertyMaster (GameId game, string installationFolder)
 gets a property master of the specified game and installation folder. does not check to validate the game specified matches the game in the installation folder, so use with caution. More...
 
static IPropertyMaster VoK.Sdk.Properties.PropertyMasterFactory.GetPropertyMaster (string installationFolder)
 Creates a property master from the specified installation folder. Expects client_gamelogic.dat to be in this folder. More...
 
static bool VoK.Sdk.Properties.PropertyMasterFactory.Dispose ()
 

Properties

uint VoK.Sdk.Ddo.SetBonus.SetBonusId [get, set]
 
string VoK.Sdk.Ddo.SetBonus.Name [get, set]
 
List< string > VoK.Sdk.Ddo.SetBonus.Buffs [get, set]
 
Dictionary< uint, SetBonusVoK.Sdk.Ddo.SetMaster.Sets = new Dictionary<uint, SetBonus>() [get]
 
IReadOnlyCollection< uint > VoK.Sdk.Exporters.ISoundExporter.SoundFileIds [get]
 
static IPropertyMaster VoK.Sdk.Properties.PropertyMasterFactory.DdoPropertyMaster [get]
 static reference to the DDO property master. This will be null until one has been loaded with GetPropertyMaster of a DDO installation More...
 
static IPropertyMaster VoK.Sdk.Properties.PropertyMasterFactory.LotroPropertyMaster [get]
 static reference to the LOTRO property master. This will be null until one has been loaded with GetPropertyMaster of a LOTRO installation More...
 

Detailed Description