VoK.Sdk.Ddo.IDdoGameDataProvider Interface Reference
Interface that describes all the functionality exposed by the Dungeon Helper framework More...
Inherits VoK.Sdk.IGameDataProvider.
Public Member Functions | |
| IReadOnlyCollection< IDdoSocialEntity > | GetAllSocialEntities () |
| gets all players logged in (ie, the Who tab) provided the player has opened it at least once. More... | |
| IDdoSocialEntity | GetPlayerSocialEntity () |
| gets the public information about a player (according to the Who/LFM tabs). if the player has the anonymous flag enabled, this will return null; More... | |
| IDdoSocialEntity | GetSocialEntity (ulong playerId) |
| gets the public information (ie, the information on the Who/LFM tabs) about a player. if the player is anonymous or offline, this will return null. More... | |
| string | GetCharacterNameFromId (ulong characterId) |
| Get's the character's name from an id More... | |
| IReadOnlyList< IPartyMember > | GetPartyMembers () |
| gets the list of current party members More... | |
| void | SelectObject (ulong objectId) |
| selects an object by an id More... | |
| void | SendInput (uint command) |
| Attempts to send the specified input command to the game client. please note, some actions must also be released as they are a state toggle (like blocking). Consult InputActions and AltInputActions for possible values. More... | |
| void | ReleaseInput (uint command) |
| Attempts to send a release signal to the game client for the specified action. More... | |
| void | UseSelectedObject () |
| uses a currently selected object More... | |
| IReadOnlyCollection< IProperty > | GetServerProperties () |
| gets the current server properties. contains stuff like temporary xp boosts, etc. More... | |
| IReadOnlyCollection< IProperty > | GetSubscriptionProperties () |
| gets subscription-level properties. typically includes all store-purchased "account" level options such as shared storage, purchased content, etc. More... | |
| IReadOnlyCollection< ICharacter > | GetAllCharacters () |
| gets the character build data. this is sent down to the client on the character selection screen. if you launch the game with a direct-to-character shortcut, this data is not available until you log out and hit the character selection page. More... | |
| IEnhancementTree | GetEnhancementTree (uint enhancementTreeDid) |
| gets a particular enhancement tree. may be null if the character does not have the tree requested. More... | |
| IEnhancementTree | GetDestinyTree (uint enhancementTreeDid) |
| gets a particular epic destiny tree. may be null if the character does not have the tree requested. More... | |
| IEnhancementTree | GetReaperTree (uint enhancementTreeDid) |
| gets a particular reaper tree. may be null if the character does not have the tree requested. More... | |
| IPropertyCollection | GetCharacterBuildData (ulong characterId) |
| gets the character build data. this is sent down to the client on the character selection screen. if you launch the game with a direct-to-character shortcut, this data is not available until you log out and hit the character selection page. More... | |
| IHotbarSlot[] | GetHotbarMap () |
| gets the hotbar map for the current character. the returned array is indexed by (slot-1) + (bar-1) * 10. For example, bar 4 slot 8 will be index 37, as hotbars and arrays are both 0-indexed. bar 1 slot 1 is index 0. Typically, this array will have 200 items in it unless fetched too soon after login, in which case it could have fewer. If Dungeon Helper is restarted after login, it will usually be empty. More... | |
| UiEventResult | SendUiEvent (uint uiElementId, MouseEvent mouseEvent) |
| if the specified UiElement is open, it will attempt to send the mouse event to it at the specified UI element relative x/y coordinates. if another UI element is in the way, the window cannot be found, or there is no interactable component at those coordinates, no attempt will be made. More... | |
| IInventoryOptions | GetInventoryOptions () |
| Provides inventory information about current and max inventory slots. More... | |
| uint? | GetCurrentQuestDid () |
| gets the current quest data id. this will be a 0x70 ID that can be used to look up information in the game property master. returns null if there is no current quest, which is to be expected in public areas More... | |
 Public Member Functions inherited from VoK.Sdk.IGameDataProvider | |
| void | SendKey (HotKeyEventArgs key) |
| sends a keypress More... | |
| void | MouseEvent (MouseEvent mouseEvent) |
| sends a mouse event to the client at the specified coords. Note: does not actually manipulate the mouse, it just tells the client to interpret it as such. to be transparent, you could do this really easily if you knew how. we're just exposing a method to make it easy. More... | |
| IEntity | GetEntity (ulong instanceId) |
| gets the entity instance of the requested id More... | |
| IEntity | GetCurrentCharacter () |
| gets the current character entity. shorthand for calling GetEntity(GetCurrentCharacterId()). More... | |
| List< IEntity > | GetEntityByName (string name) |
| Warning: Not Implemented yet. retreieves an list entities by name or returns an empty list if not found More... | |
| IReadOnlyCollection< ulong > | GetAllEntityIds () |
| gets the instance IDs all objects currently known. More... | |
| IReadOnlyCollection< IEntity > | GetEntities () |
| gets the instances of all objects currently known. More... | |
| ulong? | GetCurrentCharacterId () |
| gets the current character id. null or 0 both indicate no character is currently logged in (ie, on the character selection page) More... | |
| ulong? | GetSelectedObjectId () |
| gets the id of the currently selected object. null or 0 both indicate nothing is currently selected by the player. More... | |
| IEntity | GetSelectedObject () |
| gets the entity record of the currently selected object. More... | |
| string | GetCurrentCharacterName () |
| gets the name of the current character. this is just a shortcut for getting the current character id, then iterating over the properties to find the name. More... | |
| IProperty | GetEntityProperty (ulong entityId, uint propertyId) |
| pulls the property requested. may look in weenie properties if there is no instance property found More... | |
| string | GetServerName () |
| gets the name of the server the client is connected to More... | |
| string | GetSubscriptionKeyHash (Plugins.IPlugin plugin) |
| gets a unique hash that identifies the account logged in. characters with the same value here belong to the same account. this applies across servers as well. More... | |
| double | GetServerTimestamp () |
| Total seconds of server uptime as defined by SSG. This timer started in Feb 2006, but stops/pauses for all server offline/down time. If you subtract it from the current date, you will get ~ April 16, 2006. This will slide forward every time the servers are offline for a patch or update. More... | |
| IPropertyCollection | GetWeenieProperties (uint weenieId) |
| gets the templated/default properties of the specified object. this ID, when viewed in hex, should be of the format 0x790##### or 0x780#####. if the Id provided starts as 0x700, it will be replaced with the 0x790 equivalent. More... | |
| bool | SetCharacterHeading (Quaternion quaternion) |
| sets the character heading to the supplied quaternion. note, if this is "off" that's generally OK. the client will make corrections to this value. if you have a quaternion, use it. More... | |
| bool | SetCharacterHeading (double radians) |
| converts the supplied heading to a quaternion and sets the heading. 2*Pi = 0 = north, Pi/2 = east, Pi = south, 3Pi/2 = west. More... | |
| ILocation | GetEntityLocation (ulong instanceId) |
| gets the location of the entity, if it could be found More... | |
| IMapInfo | GetMapInfo () |
| gets the current IMapInfo data More... | |
| bool | SetWindowResolution (int width, int height) |
| Warning: Not Implemented yet. Changes the resolution of the game client window More... | |
| bool | SetWindowLocation (int x, int y) |
| Warning: Not Implemented yet. Sets the location/position of the top left corner of the game client window More... | |
| RECT? | GetUiElementLocation (uint uiElementId) |
| Gets the location of the requested uiElementId, if it is open. If it is closed or otherwise cannot be located, null is returned. See Ddo.Enums.UIElementID for DDO values. More... | |
| IntPtr | GetGameWindowHandle () |
| Used primarily by Windows APIs. More... | |
Properties | |
| bool | RunningForward [get, set] |
| whether or not the current charcter is running forward. mutually exclusive with walking and backwards motions. More... | |
| bool | WalkingForward [get, set] |
| whether or not the current charcter is walking forward. mutually exclusive with running and backwards motions. More... | |
| bool | RunningBackward [get, set] |
| whether or not the current charcter is running backwards. mutually exclusive with walking and forward motions. More... | |
| bool | WalkingBackward [get, set] |
| whether or not the current charcter is walking backwards. mutually exclusive with running and forward motions. More... | |
| bool | TurnRight [get, set] |
| whether or not the current charcter is turning right. mutually exclusive with turning left. More... | |
| bool | TurnLeft [get, set] |
| whether or not the current charcter is turning left. mutually exclusive with turning right. More... | |
| bool | StrafeRight [get, set] |
| whether or not the current charcter is strafing right. mutually exclusive with strafing left. More... | |
| bool | StrafeLeft [get, set] |
| whether or not the current charcter is strafing left. mutually exclusive with strafing right. More... | |
| IReadOnlyCollection< IEnhancementTree > | Enhancements [get] |
| gets the enhancements of the current (or last) character. More... | |
| IReadOnlyCollection< IEnhancementTree > | DestinyTrees [get] |
| gets the destiny trees of the current (or last) character. More... | |
| IReadOnlyCollection< IEnhancementTree > | ReaperTrees [get] |
| gets the reaper enhancements of the current (or last) character. More... | |
| IDdoEventProvider | EventProvider [get] |
| gets the event provider More... | |
| Properties inherited from VoK.Sdk.IGameDataProvider | |
| string | ClientVersion [get] |
| returns the version that you'll see in file properties when examining the Exe in a file explorer window More... | |
| string | ClientFolder [get] |
| root folder of the game client where the dat files are located. More... | |
| IKeymap | Keymap [get] |
| gets the keymapping for the currently running client. More... | |
| bool | HotKeysEnabled [get] |
| whether or not hotkeys are enabled in Dungeon Helper. More... | |
| IPropertyMaster | PropertyMaster [get] |
| gets the current / valid instance of the property master used for fetching objects from client_gamelogic.dat More... | |
| IImageExporter | ImageExporter [get] |
| gets an image exporter instance (useful for pulling icons, skins, etc) More... | |
| Process | GameProcess [get] |
| .net wrapper for the windows process of the game client More... | |
| float | CameraPitchDegrees [get, set] |
| valid values: -90 (straight down) to 90 (straight up) More... | |
Detailed Description
Interface that describes all the functionality exposed by the Dungeon Helper framework
The documentation for this interface was generated from the following file:
- src/VoK.Sdk/Ddo/IDdoGameDataProvider.cs
