Space Engineers
Public Member Functions | Public Attributes | Properties | List of all members
Sandbox.ModAPI.Ingame.MyDetectedEntityInfo Struct Reference

Public Member Functions

 MyDetectedEntityInfo (long entityId, string name, MyDetectedEntityType type, Vector3D?hitPosition, MatrixD orientation, Vector3 velocity, MyRelationsBetweenPlayerAndBlock relationship, BoundingBoxD boundingBox, long timeStamp)
 
bool IsEmpty ()
 Determines if this structure is empty; meaning it does not contain any meaningful data More...
 

Public Attributes

readonly long EntityId
 The entity's EntityId More...
 
readonly string Name
 The entity's display name if it is friendly, or a generic descriptor if it is not More...
 
readonly MyDetectedEntityType Type
 Enum describing the type of entity More...
 
readonly Vector3D HitPosition
 Position where the raycast hit the entity. (can be null if the sensor didn't use a raycast) More...
 
readonly MatrixD Orientation
 The entity's absolute orientation at the time it was detected More...
 
readonly Vector3 Velocity
 The entity's absolute velocity at the time it was detected More...
 
readonly MyRelationsBetweenPlayerAndBlock Relationship
 Relationship between the entity and the owner of the sensor More...
 
readonly BoundingBoxD BoundingBox
 The entity's world-aligned bounding box More...
 
readonly long TimeStamp
 Time when the entity was detected. This field counts milliseconds, compensated for simspeed More...
 

Properties

Vector3D Position [get]
 The entity's position (center of the Bounding Box) More...
 

Detailed Description

Definition at line 22 of file MyDetectedEntityInfo.cs.

Constructor & Destructor Documentation

Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.MyDetectedEntityInfo ( long  entityId,
string  name,
MyDetectedEntityType  type,
Vector3D hitPosition,
MatrixD  orientation,
Vector3  velocity,
MyRelationsBetweenPlayerAndBlock  relationship,
BoundingBoxD  boundingBox,
long  timeStamp 
)
inline

Definition at line 24 of file MyDetectedEntityInfo.cs.

Member Function Documentation

bool Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.IsEmpty ( )
inline

Determines if this structure is empty; meaning it does not contain any meaningful data

Returns

Definition at line 96 of file MyDetectedEntityInfo.cs.

Member Data Documentation

readonly BoundingBoxD Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.BoundingBox

The entity's world-aligned bounding box

Definition at line 77 of file MyDetectedEntityInfo.cs.

readonly long Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.EntityId

The entity's EntityId

Definition at line 42 of file MyDetectedEntityInfo.cs.

readonly Vector3D Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.HitPosition

Position where the raycast hit the entity. (can be null if the sensor didn't use a raycast)

Definition at line 57 of file MyDetectedEntityInfo.cs.

readonly string Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.Name

The entity's display name if it is friendly, or a generic descriptor if it is not

Definition at line 47 of file MyDetectedEntityInfo.cs.

readonly MatrixD Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.Orientation

The entity's absolute orientation at the time it was detected

Definition at line 62 of file MyDetectedEntityInfo.cs.

readonly MyRelationsBetweenPlayerAndBlock Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.Relationship

Relationship between the entity and the owner of the sensor

Definition at line 72 of file MyDetectedEntityInfo.cs.

readonly long Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.TimeStamp

Time when the entity was detected. This field counts milliseconds, compensated for simspeed

Definition at line 82 of file MyDetectedEntityInfo.cs.

readonly MyDetectedEntityType Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.Type

Enum describing the type of entity

Definition at line 52 of file MyDetectedEntityInfo.cs.

readonly Vector3 Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.Velocity

The entity's absolute velocity at the time it was detected

Definition at line 67 of file MyDetectedEntityInfo.cs.

Property Documentation

Vector3D Sandbox.ModAPI.Ingame.MyDetectedEntityInfo.Position
get

The entity's position (center of the Bounding Box)

Definition at line 88 of file MyDetectedEntityInfo.cs.


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