Space Engineers
Public Member Functions | Properties | Events | List of all members
VRage.ModAPI.IMyEntity Interface Reference
Inheritance diagram for VRage.ModAPI.IMyEntity:
VRage.Game.ModAPI.Ingame.IMyEntity Sandbox.ModAPI.IMyInventoryBag Sandbox.ModAPI.IMyMeteor Sandbox.ModAPI.Weapons.IMyAngleGrinder Sandbox.ModAPI.Weapons.IMyAutomaticRifleGun Sandbox.ModAPI.Weapons.IMyBlockPlacerBase Sandbox.ModAPI.Weapons.IMyEngineerToolBase Sandbox.ModAPI.Weapons.IMyHandDrill Sandbox.ModAPI.Weapons.IMyWelder VRage.Game.Entity.MyEntity VRage.Game.ModAPI.IMyCharacter VRage.Game.ModAPI.IMyCubeBlock VRage.Game.ModAPI.IMyCubeGrid VRage.Game.ModAPI.IMyFloatingObject VRage.ModAPI.IMyVoxelBase

Public Member Functions

string GetFriendlyName ()
 
void Close ()
 
void Delete ()
 
MyObjectBuilder_EntityBase GetObjectBuilder (bool copy=false)
 
void BeforeSave ()
 
IMyEntity GetTopMostParent (Type type=null)
 
void SetLocalMatrix (VRageMath.Matrix localMatrix, object source=null)
 
void GetChildren (List< IMyEntity > children, Func< IMyEntity, bool > collect=null)
 
MyEntitySubpart GetSubpart (string name)
 
bool TryGetSubpart (string name, out MyEntitySubpart subpart)
 
VRageMath.Vector3 GetDiffuseColor ()
 
bool IsVisible ()
 
void DebugDraw ()
 
void DebugDrawInvalidTriangles ()
 
void EnableColorMaskForSubparts (bool enable)
 
void SetColorMaskForSubparts (VRageMath.Vector3 colorMaskHsv)
 
void SetEmissiveParts (string emissiveName, Color emissivePartColor, float emissivity)
 Sets the emissive value of a specific emissive material on entity. More...
 
void SetEmissivePartsForSubparts (string emissiveName, Color emissivePartColor, float emissivity)
 Sets the emissive value of a specific emissive material on all entity subparts. More...
 
float GetDistanceBetweenCameraAndBoundingSphere ()
 
float GetDistanceBetweenCameraAndPosition ()
 
float GetLargestDistanceBetweenCameraAndBoundingSphere ()
 
float GetSmallestDistanceBetweenCameraAndBoundingSphere ()
 
void OnRemovedFromScene (object source)
 
void OnAddedToScene (object source)
 
MatrixD GetViewMatrix ()
 
MatrixD GetWorldMatrixNormalizedInv ()
 
void SetWorldMatrix (VRageMath.MatrixD worldMatrix, object source=null)
 
void SetPosition (VRageMath.Vector3D pos)
 
bool GetIntersectionWithLine (ref LineD line, out VRage.Game.Models.MyIntersectionResultLineTriangleEx?tri, IntersectionFlags flags)
 
Vector3 GetIntersectionWithLineAndBoundingSphere (ref LineD line, float boundingSphereRadiusMultiplier)
 
bool GetIntersectionWithSphere (ref BoundingSphereD sphere)
 
void GetTrianglesIntersectingSphere (ref BoundingSphereD sphere, Vector3?referenceNormalVector, float?maxAngle, System.Collections.Generic.List< MyTriangle_Vertex_Normals > retTriangles, int maxNeighbourTriangles)
 
bool DoOverlapSphereTest (float sphereRadius, Vector3D spherePos)
 
void AddToGamePruningStructure ()
 
void RemoveFromGamePruningStructure ()
 
void UpdateGamePruningStructure ()
 
- Public Member Functions inherited from VRage.Game.ModAPI.Ingame.IMyEntity
VRageMath.Vector3D GetPosition ()
 

Properties

MyEntityComponentContainer Components [get]
 
MyPhysicsComponentBase Physics [get, set]
 
MyPositionComponentBase PositionComp [get, set]
 
MyRenderComponentBase Render [get, set]
 
MyEntityComponentBase GameLogic [get, set]
 
MyHierarchyComponentBase Hierarchy [get, set]
 
MySyncComponentBase SyncObject [get]
 
MyModStorageComponentBase Storage [get, set]
 Custom storage for mods. Shared with all mods. More...
 
EntityFlags Flags [get, set]
 
long EntityId [get, set]
 
string Name [get, set]
 
bool MarkedForClose [get]
 
bool Closed [get]
 
bool DebugAsyncLoading [get]
 
bool Save [get, set]
 
MyPersistentEntityFlags2 PersistentFlags [get, set]
 
MyEntityUpdateEnum NeedsUpdate [get, set]
 
IMyEntity Parent [get]
 
Matrix LocalMatrix [get, set]
 
bool NearFlag [get, set]
 
bool CastShadows [get, set]
 
bool FastCastShadowResolve [get, set]
 
bool NeedsResolveCastShadow [get, set]
 
float MaxGlassDistSq [get]
 
bool NeedsDraw [get, set]
 
bool NeedsDrawFromParent [get, set]
 
bool Transparent [get, set]
 
bool ShadowBoxLod [get, set]
 
bool SkipIfTooSmall [get, set]
 
bool Visible [get, set]
 
bool InScene [get, set]
 
bool InvalidateOnMove [get]
 
new VRageMath.MatrixD WorldMatrix [get, set]
 
VRageMath.MatrixD WorldMatrixInvScaled [get]
 
VRageMath.MatrixD WorldMatrixNormalizedInv [get]
 
bool IsVolumetric [get]
 
BoundingBox LocalAABB [get, set]
 
BoundingBox LocalAABBHr [get]
 
BoundingSphere LocalVolume [get, set]
 
Vector3 LocalVolumeOffset [get, set]
 
Vector3 LocationForHudMarker [get]
 
bool IsCCDForProjectiles [get]
 
string DisplayName [get, set]
 
- Properties inherited from VRage.Game.ModAPI.Ingame.IMyEntity
MyEntityComponentContainer Components [get]
 
long EntityId [get]
 
VRageMath.BoundingBoxD WorldAABB [get]
 
VRageMath.BoundingBoxD WorldAABBHr [get]
 
VRageMath.MatrixD WorldMatrix [get]
 
VRageMath.BoundingSphereD WorldVolume [get]
 
VRageMath.BoundingSphereD WorldVolumeHr [get]
 

Events

Action< IMyEntityOnClose
 
Action< IMyEntityOnClosing
 
Action< IMyEntityOnMarkForClose
 
Action< IMyEntityOnPhysicsChanged
 

Detailed Description

Definition at line 113 of file IMyEntity.cs.

Member Function Documentation

void VRage.ModAPI.IMyEntity.AddToGamePruningStructure ( )

Implemented in VRage.Game.Entity.MyEntity.

void VRage.ModAPI.IMyEntity.BeforeSave ( )

Implemented in VRage.Game.Entity.MyEntity.

void VRage.ModAPI.IMyEntity.Close ( )
void VRage.ModAPI.IMyEntity.DebugDraw ( )
void VRage.ModAPI.IMyEntity.DebugDrawInvalidTriangles ( )

Implemented in VRage.Game.Entity.MyEntity.

void VRage.ModAPI.IMyEntity.Delete ( )

Implemented in VRage.Game.Entity.MyEntity.

bool VRage.ModAPI.IMyEntity.DoOverlapSphereTest ( float  sphereRadius,
Vector3D  spherePos 
)
void VRage.ModAPI.IMyEntity.EnableColorMaskForSubparts ( bool  enable)
void VRage.ModAPI.IMyEntity.GetChildren ( List< IMyEntity children,
Func< IMyEntity, bool >  collect = null 
)
VRageMath.Vector3 VRage.ModAPI.IMyEntity.GetDiffuseColor ( )
float VRage.ModAPI.IMyEntity.GetDistanceBetweenCameraAndBoundingSphere ( )

Implemented in VRage.Game.Entity.MyEntity.

float VRage.ModAPI.IMyEntity.GetDistanceBetweenCameraAndPosition ( )

Implemented in VRage.Game.Entity.MyEntity.

string VRage.ModAPI.IMyEntity.GetFriendlyName ( )
bool VRage.ModAPI.IMyEntity.GetIntersectionWithLine ( ref LineD  line,
out VRage.Game.Models.MyIntersectionResultLineTriangleEx tri,
IntersectionFlags  flags 
)
Vector3 VRage.ModAPI.IMyEntity.GetIntersectionWithLineAndBoundingSphere ( ref LineD  line,
float  boundingSphereRadiusMultiplier 
)

Implemented in VRage.Game.Entity.MyEntity.

bool VRage.ModAPI.IMyEntity.GetIntersectionWithSphere ( ref BoundingSphereD  sphere)
float VRage.ModAPI.IMyEntity.GetLargestDistanceBetweenCameraAndBoundingSphere ( )

Implemented in VRage.Game.Entity.MyEntity.

MyObjectBuilder_EntityBase VRage.ModAPI.IMyEntity.GetObjectBuilder ( bool  copy = false)
float VRage.ModAPI.IMyEntity.GetSmallestDistanceBetweenCameraAndBoundingSphere ( )

Implemented in VRage.Game.Entity.MyEntity.

MyEntitySubpart VRage.ModAPI.IMyEntity.GetSubpart ( string  name)

Implemented in VRage.Game.Entity.MyEntity.

IMyEntity VRage.ModAPI.IMyEntity.GetTopMostParent ( Type  type = null)

Implemented in VRage.Game.Entity.MyEntity.

void VRage.ModAPI.IMyEntity.GetTrianglesIntersectingSphere ( ref BoundingSphereD  sphere,
Vector3 referenceNormalVector,
float?  maxAngle,
System.Collections.Generic.List< MyTriangle_Vertex_Normals retTriangles,
int  maxNeighbourTriangles 
)
MatrixD VRage.ModAPI.IMyEntity.GetViewMatrix ( )
MatrixD VRage.ModAPI.IMyEntity.GetWorldMatrixNormalizedInv ( )
bool VRage.ModAPI.IMyEntity.IsVisible ( )
void VRage.ModAPI.IMyEntity.OnAddedToScene ( object  source)

Implemented in Sandbox.Game.Entities.Character.MyCharacter, Sandbox.Game.Entities.MyCubeGrid, Sandbox.Game.Entities.Cube.MyShipConnector, VRage.Game.Entity.MyEntity, Sandbox.Game.Entities.Blocks.MyProgrammableBlock, Sandbox.Game.Entities.MyRemoteControl, Sandbox.Game.Entities.MyCockpit, Sandbox.Game.Entities.Blocks.MySensorBlock, Sandbox.Game.Entities.MyConveyorSorter, Sandbox.Game.Entities.MyFracturedPiece, Sandbox.Game.Entities.MyCubeBlock, Sandbox.Game.Entities.MyPlanet, SpaceEngineers.Game.Entities.Blocks.MyLandingGear, Sandbox.Game.Entities.Cube.MyLaserAntenna, Sandbox.Game.Entities.Blocks.MyTextPanel, Sandbox.Game.Entities.MyJumpDrive, SpaceEngineers.Game.Entities.Blocks.MyAirVent, Sandbox.Game.Entities.Cube.MyWarhead, SpaceEngineers.Game.Entities.Blocks.MyTimerBlock, Sandbox.Game.Weapons.MySmallMissileLauncher, Sandbox.Game.Entities.Blocks.MyGasGenerator, Sandbox.Game.Weapons.MyShipToolBase, Sandbox.Game.Entities.Blocks.MyGasTank, Sandbox.Game.Entities.MyCameraBlock, Sandbox.Game.Weapons.MyEngineerToolBase, Sandbox.Game.Entities.Cube.MyBeacon, Sandbox.Game.Entities.MyBatteryBlock, Sandbox.Game.Entities.Cube.MyRadioAntenna, Sandbox.Game.Entities.Blocks.MyProjectorBase, Sandbox.Game.Entities.MyAirtightDoorGeneric, Sandbox.Game.Entities.MyFloatingObject, Sandbox.Game.Entities.Blocks.MyPistonBase, Sandbox.Game.Entities.MyCompoundCubeBlock, SpaceEngineers.Game.Entities.Blocks.MySpaceBall, Sandbox.Game.Entities.MyReactor, SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorBase, SpaceEngineers.Game.Entities.Blocks.MyShipMergeBlock, SpaceEngineers.Game.Entities.Blocks.MyVirtualMass, and Sandbox.Game.Entities.MyConveyorConnector.

void VRage.ModAPI.IMyEntity.OnRemovedFromScene ( object  source)
void VRage.ModAPI.IMyEntity.RemoveFromGamePruningStructure ( )

Implemented in VRage.Game.Entity.MyEntity.

void VRage.ModAPI.IMyEntity.SetColorMaskForSubparts ( VRageMath.Vector3  colorMaskHsv)
void VRage.ModAPI.IMyEntity.SetEmissiveParts ( string  emissiveName,
Color  emissivePartColor,
float  emissivity 
)

Sets the emissive value of a specific emissive material on entity.

Parameters
emissiveNameThe name of the emissive material (ie. "Emissive0")
emissivityLevel of emissivity (0 is off, 1 is full brightness)
emissivePartColorColor to emit

Implemented in VRage.Game.Entity.MyEntity.

void VRage.ModAPI.IMyEntity.SetEmissivePartsForSubparts ( string  emissiveName,
Color  emissivePartColor,
float  emissivity 
)

Sets the emissive value of a specific emissive material on all entity subparts.

Parameters
emissiveNameThe name of the emissive material (ie. "Emissive0")
emissivityLevel of emissivity (0 is off, 1 is full brightness).
emissivePartColorColor to emit

Implemented in VRage.Game.Entity.MyEntity.

void VRage.ModAPI.IMyEntity.SetLocalMatrix ( VRageMath.Matrix  localMatrix,
object  source = null 
)
void VRage.ModAPI.IMyEntity.SetPosition ( VRageMath.Vector3D  pos)
void VRage.ModAPI.IMyEntity.SetWorldMatrix ( VRageMath.MatrixD  worldMatrix,
object  source = null 
)
bool VRage.ModAPI.IMyEntity.TryGetSubpart ( string  name,
out MyEntitySubpart  subpart 
)

Implemented in VRage.Game.Entity.MyEntity.

void VRage.ModAPI.IMyEntity.UpdateGamePruningStructure ( )

Implemented in VRage.Game.Entity.MyEntity.

Property Documentation

bool VRage.ModAPI.IMyEntity.CastShadows
getset

Definition at line 166 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.Closed
get

Definition at line 140 of file IMyEntity.cs.

MyEntityComponentContainer VRage.ModAPI.IMyEntity.Components
get

Definition at line 116 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.DebugAsyncLoading
get

Definition at line 141 of file IMyEntity.cs.

string VRage.ModAPI.IMyEntity.DisplayName
getset

Definition at line 242 of file IMyEntity.cs.

long VRage.ModAPI.IMyEntity.EntityId
getset

Definition at line 134 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.FastCastShadowResolve
getset

Definition at line 167 of file IMyEntity.cs.

EntityFlags VRage.ModAPI.IMyEntity.Flags
getset

Definition at line 133 of file IMyEntity.cs.

MyEntityComponentBase VRage.ModAPI.IMyEntity.GameLogic
getset

Definition at line 120 of file IMyEntity.cs.

MyHierarchyComponentBase VRage.ModAPI.IMyEntity.Hierarchy
getset

Definition at line 121 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.InScene
getset

Definition at line 205 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.InvalidateOnMove
get

Definition at line 208 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.IsCCDForProjectiles
get

Definition at line 238 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.IsVolumetric
get

Definition at line 225 of file IMyEntity.cs.

BoundingBox VRage.ModAPI.IMyEntity.LocalAABB
getset

Definition at line 226 of file IMyEntity.cs.

BoundingBox VRage.ModAPI.IMyEntity.LocalAABBHr
get

Definition at line 227 of file IMyEntity.cs.

Matrix VRage.ModAPI.IMyEntity.LocalMatrix
getset

Definition at line 157 of file IMyEntity.cs.

BoundingSphere VRage.ModAPI.IMyEntity.LocalVolume
getset

Definition at line 228 of file IMyEntity.cs.

Vector3 VRage.ModAPI.IMyEntity.LocalVolumeOffset
getset

Definition at line 229 of file IMyEntity.cs.

Vector3 VRage.ModAPI.IMyEntity.LocationForHudMarker
get

Definition at line 237 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.MarkedForClose
get

Definition at line 138 of file IMyEntity.cs.

float VRage.ModAPI.IMyEntity.MaxGlassDistSq
get

Definition at line 170 of file IMyEntity.cs.

string VRage.ModAPI.IMyEntity.Name
getset

Definition at line 135 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.NearFlag
getset

Definition at line 165 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.NeedsDraw
getset

Definition at line 171 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.NeedsDrawFromParent
getset

Definition at line 172 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.NeedsResolveCastShadow
getset

Definition at line 168 of file IMyEntity.cs.

MyEntityUpdateEnum VRage.ModAPI.IMyEntity.NeedsUpdate
getset

Definition at line 152 of file IMyEntity.cs.

IMyEntity VRage.ModAPI.IMyEntity.Parent
get

Definition at line 156 of file IMyEntity.cs.

MyPersistentEntityFlags2 VRage.ModAPI.IMyEntity.PersistentFlags
getset

Definition at line 144 of file IMyEntity.cs.

MyPhysicsComponentBase VRage.ModAPI.IMyEntity.Physics
getset

Definition at line 117 of file IMyEntity.cs.

MyPositionComponentBase VRage.ModAPI.IMyEntity.PositionComp
getset

Definition at line 118 of file IMyEntity.cs.

MyRenderComponentBase VRage.ModAPI.IMyEntity.Render
getset

Definition at line 119 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.Save
getset

Definition at line 143 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.ShadowBoxLod
getset

Definition at line 174 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.SkipIfTooSmall
getset

Definition at line 175 of file IMyEntity.cs.

MyModStorageComponentBase VRage.ModAPI.IMyEntity.Storage
getset

Custom storage for mods. Shared with all mods.

Not synced, but saved with blueprints. Only use set accessor if value is null.

Definition at line 130 of file IMyEntity.cs.

MySyncComponentBase VRage.ModAPI.IMyEntity.SyncObject
get

Definition at line 122 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.Transparent
getset

Definition at line 173 of file IMyEntity.cs.

bool VRage.ModAPI.IMyEntity.Visible
getset

Definition at line 176 of file IMyEntity.cs.

new VRageMath.MatrixD VRage.ModAPI.IMyEntity.WorldMatrix
getset

Definition at line 212 of file IMyEntity.cs.

VRageMath.MatrixD VRage.ModAPI.IMyEntity.WorldMatrixInvScaled
get

Definition at line 213 of file IMyEntity.cs.

VRageMath.MatrixD VRage.ModAPI.IMyEntity.WorldMatrixNormalizedInv
get

Definition at line 214 of file IMyEntity.cs.

Event Documentation

Action<IMyEntity> VRage.ModAPI.IMyEntity.OnClose

Definition at line 145 of file IMyEntity.cs.

Action<IMyEntity> VRage.ModAPI.IMyEntity.OnClosing

Definition at line 146 of file IMyEntity.cs.

Action<IMyEntity> VRage.ModAPI.IMyEntity.OnMarkForClose

Definition at line 147 of file IMyEntity.cs.

Action<IMyEntity> VRage.ModAPI.IMyEntity.OnPhysicsChanged

Definition at line 233 of file IMyEntity.cs.


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