Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Dependencies.ILocalEntities Interface Reference

Entity manager for local-side entities. This will work on client, or server, but will only have the capabilities to return things that said client or server know about The client only knows about the subset of total entities. Usually within the clients viewport More...

Public Member Functions

IEnumerable< T > GetKnownEntitiesOfType< T > ()
 Returns an enumerable of all entities the game knows about of a type More...
 
IEnumerable< T > GetKnownEntitiesNear< T > (Vector3d position, double dist)
 Returns enumerable of all known entities near a location More...
 
IEntity GetKnownEntity (uint id)
 Gets the entity object of a given entity 'id' More...
 
bool KnowsEntity (uint id)
 Returns true if a game knows about an entity with the given id More...
 

Properties

IEnumerable< IEntityKnownEntities [get]
 Returns an enumerable of all entities the game knows about More...
 

Detailed Description

Entity manager for local-side entities. This will work on client, or server, but will only have the capabilities to return things that said client or server know about The client only knows about the subset of total entities. Usually within the clients viewport

Attribute: Injectable

Member Function Documentation

IEnumerable<T> pluginbase.Dependencies.ILocalEntities.GetKnownEntitiesNear< T > ( Vector3d  position,
double  dist 
)

Returns enumerable of all known entities near a location

Returns
The known entities near.
Parameters
positionPosition.
distDist.
Template Parameters
TThe 1st type parameter.
Type Constraints
T :IPositionableEntity 
IEnumerable<T> pluginbase.Dependencies.ILocalEntities.GetKnownEntitiesOfType< T > ( )

Returns an enumerable of all entities the game knows about of a type

Returns
The known entities of type.
Template Parameters
TThe 1st type parameter.
Type Constraints
T :IEntity 
IEntity pluginbase.Dependencies.ILocalEntities.GetKnownEntity ( uint  id)

Gets the entity object of a given entity 'id'

Returns
The known entity.
Parameters
idIdentifier.
bool pluginbase.Dependencies.ILocalEntities.KnowsEntity ( uint  id)

Returns true if a game knows about an entity with the given id

Returns
true, if entity was knowsed, false otherwise.
Parameters
idIdentifier.

Property Documentation

IEnumerable<IEntity> pluginbase.Dependencies.ILocalEntities.KnownEntities
get

Returns an enumerable of all entities the game knows about

The known entities.


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