an object that exists ingame. could be an inventory item, a door to open, an NPC, a non-interactable decoration, just about anything. More...

Public Member Functions
IProperty	GetProperty (uint propertyId)
	gets the current value of the property being requested. will use instance properties, detailed properties, then weenie properties to find the property in question. More...

string	Serialize ()
	Serializes this instance into useful json with all the appropriate converters. More...

Properties
ulong	InstanceId `[get]`
	every entity has a 64-bit identifier More...

bool	IsDeleted `[get]`
	whether or not this entity has been deleted by the client. Due to the nature of .Net, plugins may have old references to entities that are no longer held by the client. when the client deletes an entity, Dungeon Helper will set the IsDeleted flag to true. More...

IPropertyCollection	InstanceProperties `[get]`
	property values associated directly to the entity. using this accessor creates a point-in-time reference to the objects properties. updates will not be automatic. More...

byte	MostSignificantByte `[get]`
	the most significant byte of the Id - often tells you a lot about the item itself. 0x02 is a player. 0x03 is an NPC, etc. More...

string	Name `[get]`
	best guess at a name for this item. for things that players do not interact with, this is often null. More...

ulong?	OwnerId `[get]`
	Id of the container of this object. will be null for objects that just exist in the world (like players and NPCs), but have a value if it's an item in inventory or in a bag, etc. More...

uint?	WeenieId `[get]`
	the template id of this item. More...

IPropertyCollection	WeeniePropertyCollection `[get]`
	any relevant properties of the weenie that have been loaded.using this accessor creates a point-in-time reference to the objects properties. updates will not be automatic. More...

IPropertyCollection	PropertyCollection `[get]`
	all the current properties of this entity, merged with the weenie properties. using this accessor creates a point-in-time reference to the objects properties. updates will not be automatic. More...

IPropertyCollection	DetailedProperties `[get]`
	properties that come after examining an object in the UI. no data will be available prior to that. using this accessor creates a point-in-time reference to the objects properties. updates will not be automatic. More...

ILocation	Location `[get]`
	one stop shop for all the location data, rather than piecemeal position/velocity/etc. More...

Vector3?	Position `[get]`
	location of the entity, if available. this is re-fetched from the client every time it is accessed. More...

Vector3?	Velocity `[get]`
	velocity of the entity, if available. this is re-fetched from the client every time it is accessed. More...

double?	Heading `[get]`
	compass heading that the entity is facing, if it was found and could be determined. this is re-fetched from the client every time it is accessed. 360 = 0 = north, 90 = east, 180 = south, 270 = west. More...

Quaternion?	RawHeading `[get]`
	Heading is really stored as a quaternion. this is the raw value present in the client and is re-fetched from the client every time it is accessed. More...

int?	HitPoints_Current `[get]`
	current hit points More...

int?	HitPoints_Max `[get]`
	maximum hit points More...

int?	HitPoints_Temp `[get]`
	current temporary hit points More...

int?	SpellPoints_Current `[get]`
	current spell points More...

int?	SpellPoints_Max `[get]`
	maximum spell points More...

int?	SpellPoints_Temp `[get]`
	current temporary spell points More...

int?	Ki_Current `[get]`
	Current Ki More...

int?	Ki_Max `[get]`
	Maximum Ki More...

LifeState?	LifeState `[get]`
	current life state, if known. dead/alive/incap More...

Detailed Description

an object that exists ingame. could be an inventory item, a door to open, an NPC, a non-interactable decoration, just about anything.

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

src/VoK.Sdk/IEntity.cs

Public Member Functions

Properties

Detailed Description