Click or drag to resize
MyEntity Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:VRage.Game.Entity.MyEntity"]

Inheritance Hierarchy
SystemObject
  VRage.Game.EntityMyEntity

Namespace: VRage.Game.Entity
Assembly: VRage.Game (in VRage.Game.dll) Version: 1.0.0.0
Syntax
C#
Copy
public class MyEntity : IMyEntity

The MyEntity type exposes the following members.

Constructors
  NameDescription
Public methodMyEntity
Initializes a new instance of the MyEntity class
Public methodMyEntity(Boolean)
Initializes a new instance of the MyEntity class.
Top
Properties
  NameDescription
Public propertyClosed
Public propertyComponents
Public propertyDisplayName
Public propertyDisplayNameText
Display Name for GUI etc. Override in descendant classes. Usually used to display in terminal or inventory controls.
Public propertyEntityId
Entity id, can be set by subclasses (for example when using pool...)
Public propertyFlags
Public propertyGameLogic
Public propertyHasInventory
Returns true if this entity has got at least one inventory. Note that one aggregate inventory can contain zero simple inventories => zero will be returned even if GetInventoryBase() != null.
Public propertyHierarchy
Public propertyInScene
Public propertyInvalidateOnMove
Public propertyInventoryCount
Iterate through inventories and return their count.
Public propertyIsCCDForProjectiles
Public propertyIsPreview
Public propertyIsVolumetric
Public propertyLocationForHudMarker
Public propertyMarkedForClose
Public propertyMaxGlassDistSq
Public propertyModel
Public propertyModelCollision
Public propertyNeedsUpdate
Public propertyParent
Gets or sets the parent.
Public propertyPhysics
Public propertyPositionComp
Public propertyRender
Public propertySave
Public propertySubparts
Public propertySyncFlag
Public propertySyncObject
Public propertyWorldMatrix
Top
Methods
  NameDescription
Public methodAddDebugRenderComponent
Public methodAddToGamePruningStructure
Public methodAfterPaste
Public methodBeforePaste
Public methodBeforeSave
Called before method GetObjectBuilder, when saving sector
Public methodClearDebugRenderComponents
Public methodClose
This method marks this entity for close which means, that Close will be called after all entities are updated
Public methodCreateSync
Public methodDebugDraw
Public methodDebugDrawInvalidTriangles
Public methodDebugDrawPhysics
Draw physical representation of entity
Public methodDelete
Every object must have this method, but not every phys object must necessarily have something to cleanup
Remarks
Public methodDoOverlapSphereTest
Public methodGetBaseEntity
Public methodGetDistanceBetweenCameraAndBoundingSphere
Public methodGetDistanceBetweenCameraAndPosition
Public methodGetDistanceBetweenPlayerPositionAndBoundingSphere
Public methodGetFriendlyName
Public methodGetHudParams
Public methodGetIntersectionWithLine(LineD, NullableMyIntersectionResultLineTriangleEx, IntersectionFlags)
Public methodGetIntersectionWithLine(LineD, NullableVector3D, Boolean, IntersectionFlags)
Public methodGetIntersectionWithLineAndBoundingSphere
Public methodGetIntersectionWithSphere
Public methodGetInventoryBase
Simply get the MyInventoryBase component stored in this entity.
Public methodGetInventoryBase(Int32)
Search for inventory component with maching index.
Public methodGetLargestDistanceBetweenCameraAndBoundingSphere
Public methodGetObjectBuilder
Gets object builder from object.
Public methodGetSmallestDistanceBetweenCameraAndBoundingSphere
Public methodGetSubpart
Public methodGetTopMostParent
Return top most parent of this entity
Public methodGetTrianglesIntersectingSphere
Public methodGetViewMatrix
Public methodInit(MyObjectBuilder_EntityBase)
Public methodInit(StringBuilder, String, MyEntity, NullableSingle, String)
Public methodOnAddedToScene
Called when [activated] which for entity means that was added to scene.
Public methodOnRemovedFromScene
Public methodPrepareForDraw
Method is called defacto from Update, preparation fo Draw
Public methodRaisePhysicsChanged
Public methodRefreshModels
Public methodRemoveFromGamePruningStructure
Public methodSetEmissiveParts
Public methodSetEmissivePartsForSubparts
Public methodSetSpeedsAccordingToServerValues
Public methodToString (Overrides ObjectToString.)
Public methodTryGetSubpart
Public methodUpdateAfterSimulation
Public methodUpdateAfterSimulation10
Public methodUpdateAfterSimulation100
Public methodUpdateBeforeSimulation
Public methodUpdateBeforeSimulation10
Called each 10th frame if registered for update10
Public methodUpdateBeforeSimulation100
Called each 100th frame if registered for update100
Public methodUpdateGamePruningStructure
Public methodUpdateOnceBeforeFrame
Public methodUpdatingStopped
Top
Events
  NameDescription
Public eventOnClose
Public eventOnClosing
Public eventOnMarkForClose
This event may not be invoked at all, when calling MyEntities.CloseAll, marking is bypassed
Public eventOnPhysicsChanged
Top
Fields
Extension Methods
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate propertyIMyEntityCastShadows
Explicit interface implementationPrivate methodIMyEntityClose
Explicit interface implementationPrivate propertyIMyEntityClosed
Explicit interface implementationPrivate propertyIMyEntityDebugAsyncLoading
Explicit interface implementationPrivate methodIMyEntityDelete
Explicit interface implementationPrivate propertyIMyEntityDisplayName
Explicit interface implementationPrivate methodIMyEntityDoOverlapSphereTest
Explicit interface implementationPrivate methodIMyEntityEnableColorMaskForSubparts
Explicit interface implementationPrivate propertyIMyEntityEntityId
Explicit interface implementationPrivate propertyIMyEntityFastCastShadowResolve
Explicit interface implementationPrivate propertyIMyEntityGameLogic
Explicit interface implementationPrivate methodIMyEntityGetChildren
Explicit interface implementationPrivate methodIMyEntityGetDiffuseColor
Explicit interface implementationPrivate methodIMyEntityGetDistanceBetweenCameraAndBoundingSphere
Explicit interface implementationPrivate methodIMyEntityGetDistanceBetweenCameraAndPosition
Explicit interface implementationPrivate methodIMyEntityGetFriendlyName
Explicit interface implementationPrivate methodIMyEntityGetIntersectionWithLineAndBoundingSphere
Explicit interface implementationPrivate methodIMyEntityGetIntersectionWithSphere
Explicit interface implementationPrivate methodIMyEntityGetLargestDistanceBetweenCameraAndBoundingSphere
Explicit interface implementationPrivate methodIMyEntityGetObjectBuilder
Explicit interface implementationPrivate methodIMyEntityGetPosition
Explicit interface implementationPrivate methodIMyEntityGetSmallestDistanceBetweenCameraAndBoundingSphere
Explicit interface implementationPrivate methodIMyEntityGetTopMostParent
Explicit interface implementationPrivate methodIMyEntityGetTrianglesIntersectingSphere
Explicit interface implementationPrivate methodIMyEntityGetViewMatrix
Explicit interface implementationPrivate methodIMyEntityGetWorldMatrixNormalizedInv
Explicit interface implementationPrivate propertyIMyEntityHierarchy
Explicit interface implementationPrivate propertyIMyEntityInScene
Explicit interface implementationPrivate propertyIMyEntityInvalidateOnMove
Explicit interface implementationPrivate propertyIMyEntityIsCCDForProjectiles
Explicit interface implementationPrivate methodIMyEntityIsVisible
Explicit interface implementationPrivate propertyIMyEntityIsVolumetric
Explicit interface implementationPrivate propertyIMyEntityLocalAABB
Explicit interface implementationPrivate propertyIMyEntityLocalAABBHr
Explicit interface implementationPrivate propertyIMyEntityLocalMatrix
Explicit interface implementationPrivate propertyIMyEntityLocalVolume
Explicit interface implementationPrivate propertyIMyEntityLocalVolumeOffset
Explicit interface implementationPrivate propertyIMyEntityLocationForHudMarker
Explicit interface implementationPrivate propertyIMyEntityMarkedForClose
Explicit interface implementationPrivate propertyIMyEntityMaxGlassDistSq
Explicit interface implementationPrivate propertyIMyEntityName
Explicit interface implementationPrivate propertyIMyEntityNearFlag
Explicit interface implementationPrivate propertyIMyEntityNeedsDraw
Explicit interface implementationPrivate propertyIMyEntityNeedsDrawFromParent
Explicit interface implementationPrivate propertyIMyEntityNeedsResolveCastShadow
Explicit interface implementationPrivate propertyIMyEntityNeedsUpdate
Explicit interface implementationPrivate eventIMyEntityOnClose
Explicit interface implementationPrivate eventIMyEntityOnClosing
Explicit interface implementationPrivate eventIMyEntityOnMarkForClose
Explicit interface implementationPrivate eventIMyEntityOnPhysicsChanged
Explicit interface implementationPrivate propertyIMyEntityParent
Explicit interface implementationPrivate propertyIMyEntityPersistentFlags
Explicit interface implementationPrivate propertyIMyEntityPhysics
Explicit interface implementationPrivate propertyIMyEntitySave
Explicit interface implementationPrivate methodIMyEntitySetColorMaskForSubparts
Explicit interface implementationPrivate methodIMyEntitySetEmissiveParts
Sets the emissive value of a specific emissive material on entity.
Explicit interface implementationPrivate methodIMyEntitySetEmissivePartsForSubparts
Sets the emissive value of a specific emissive material on all entity subparts.
Explicit interface implementationPrivate methodIMyEntitySetLocalMatrix
Explicit interface implementationPrivate methodIMyEntitySetPosition
Explicit interface implementationPrivate methodIMyEntitySetWorldMatrix
Explicit interface implementationPrivate propertyIMyEntityShadowBoxLod
Explicit interface implementationPrivate propertyIMyEntitySkipIfTooSmall
Explicit interface implementationPrivate propertyIMyEntityTransparent
Explicit interface implementationPrivate propertyIMyEntityVisible
Explicit interface implementationPrivate propertyIMyEntityWorldAABB
Explicit interface implementationPrivate propertyIMyEntityWorldAABBHr
Explicit interface implementationPrivate propertyIMyEntityWorldMatrix
Explicit interface implementationPrivate propertyIMyEntityWorldMatrixInvScaled
Explicit interface implementationPrivate propertyIMyEntityWorldMatrixNormalizedInv
Explicit interface implementationPrivate propertyIMyEntityWorldVolume
Explicit interface implementationPrivate propertyIMyEntityWorldVolumeHr
Top
See Also