Space Engineers
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
Sandbox.Game.Entities.MyAreaMarker Class Reference
Inheritance diagram for Sandbox.Game.Entities.MyAreaMarker:
VRage.Game.Entity.MyEntity VRage.Game.Entity.UseObject.IMyUseObject VRage.ModAPI.IMyEntity VRage.Game.ModAPI.Ingame.IMyEntity

Public Member Functions

 MyAreaMarker ()
 
 MyAreaMarker (MyPositionAndOrientation positionAndOrientation, MyAreaMarkerDefinition definition)
 
override void Init (MyObjectBuilder_EntityBase objectBuilder)
 
override MyObjectBuilder_EntityBase GetObjectBuilder (bool copy=false)
 Gets object builder from object. More...
 
virtual void AddHudMarker ()
 
void SetRenderID (uint id)
 
void SetInstanceID (int id)
 
virtual void Use (UseActionEnum actionEnum, IMyEntity user)
 Uses object by specified action Caller calls this method only on supported actions More...
 
virtual MyActionDescription GetActionInfo (UseActionEnum actionEnum)
 Gets action text Caller calls this method only on supported actions More...
 
bool HandleInput ()
 
void OnSelectionLost ()
 
- Public Member Functions inherited from VRage.Game.Entity.MyEntity
void DebugDraw ()
 
void DebugDrawInvalidTriangles ()
 
void AddDebugRenderComponent (MyDebugRenderComponentBase render)
 
void ClearDebugRenderComponents ()
 
MyEntity GetTopMostParent (Type type=null)
 Return top most parent of this entity More...
 
virtual List< MyHudEntityParamsGetHudParams (bool allowBlink)
 
 MyEntity ()
 
 MyEntity (bool initComponents=true)
 Initializes a new instance of the MyEntity class. More...
 
void CreateSync ()
 
MyEntitySubpart GetSubpart (string name)
 
bool TryGetSubpart (string name, out MyEntitySubpart subpart)
 
virtual void UpdateOnceBeforeFrame ()
 
virtual void UpdateBeforeSimulation ()
 
virtual void UpdateAfterSimulation ()
 
virtual void UpdatingStopped ()
 
virtual void UpdateBeforeSimulation10 ()
 Called each 10th frame if registered for update10 More...
 
virtual void UpdateAfterSimulation10 ()
 
virtual void UpdateBeforeSimulation100 ()
 Called each 100th frame if registered for update100 More...
 
virtual void UpdateAfterSimulation100 ()
 
virtual string GetFriendlyName ()
 
virtual MatrixD GetViewMatrix ()
 
void SetSpeedsAccordingToServerValues ()
 
virtual void SetWorldMatrix (MatrixD worldMatrix, bool forceUpdate=false, bool updateChildren=true)
 
virtual void DebugDrawPhysics ()
 Draw physical representation of entity More...
 
virtual bool GetIntersectionWithLine (ref LineD line, out Vector3D?v, bool useCollisionModel=true, IntersectionFlags flags=IntersectionFlags.ALL_TRIANGLES)
 
virtual bool GetIntersectionWithLine (ref LineD line, out VRage.Game.Models.MyIntersectionResultLineTriangleEx?t, IntersectionFlags flags=IntersectionFlags.ALL_TRIANGLES)
 
virtual Vector3D GetIntersectionWithLineAndBoundingSphere (ref LineD line, float boundingSphereRadiusMultiplier)
 
virtual bool GetIntersectionWithSphere (ref BoundingSphereD sphere)
 
void GetTrianglesIntersectingSphere (ref BoundingSphereD sphere, Vector3?referenceNormalVector, float?maxAngle, List< MyTriangle_Vertex_Normals > retTriangles, int maxNeighbourTriangles)
 
virtual bool DoOverlapSphereTest (float sphereRadius, Vector3D spherePos)
 
double GetSmallestDistanceBetweenCameraAndBoundingSphere ()
 
double GetLargestDistanceBetweenCameraAndBoundingSphere ()
 
double GetDistanceBetweenCameraAndBoundingSphere ()
 
double GetDistanceBetweenPlayerPositionAndBoundingSphere ()
 
double GetDistanceBetweenCameraAndPosition ()
 
virtual MyEntity GetBaseEntity ()
 
virtual void OnAddedToScene (object source)
 Called when [activated] which for entity means that was added to scene. More...
 
virtual void OnRemovedFromScene (object source)
 
void AddToGamePruningStructure ()
 
void RemoveFromGamePruningStructure ()
 
void UpdateGamePruningStructure ()
 
void RaisePhysicsChanged ()
 
void HackyComponentInitByMiroPleaseDontUseEver (MyDefinitionId id)
 DONT USE THIS METHOD, EVER! More...
 
virtual void Init (StringBuilder displayName, string model, MyEntity parentObject, float?scale, string modelCollision=null)
 
virtual void RefreshModels (string model, string modelCollision)
 
void Delete ()
 Every object must have this method, but not every phys object must necessarily have something to cleanup More...
 
void Close ()
 This method marks this entity for close which means, that Close will be called after all entities are updated More...
 
virtual void BeforeSave ()
 Called before method GetObjectBuilder, when saving sector More...
 
virtual void PrepareForDraw ()
 Method is called defacto from Update, preparation fo Draw More...
 
virtual void BeforePaste ()
 
virtual void AfterPaste ()
 
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...
 
override string ToString ()
 
virtual MyInventoryBase GetInventoryBase (int index)
 Search for inventory component with maching index. More...
 
MyInventoryBase GetInventoryBase ()
 Simply get the MyInventoryBase component stored in this entity. More...
 
delegate MyObjectBuilder_EntityBase MyEntityFactoryCreateObjectBuilderDelegate (MyEntity entity)
 
delegate MySyncComponentBase CreateDefaultSyncEntityDelegate (MyEntity thisEntity)
 
delegate bool MyWeldingGroupsGroupExistsDelegate (MyEntity entity)
 
virtual void SerializeControls (BitStream stream)
 
virtual void DeserializeControls (BitStream stream, bool outOfOrder)
 
virtual void ApplyLastControls ()
 
- Public Member Functions inherited from VRage.ModAPI.IMyEntity
bool GetIntersectionWithLine (ref LineD line, out VRage.Game.Models.MyIntersectionResultLineTriangleEx?tri, IntersectionFlags flags)
 
void GetTrianglesIntersectingSphere (ref BoundingSphereD sphere, Vector3?referenceNormalVector, float?maxAngle, System.Collections.Generic.List< MyTriangle_Vertex_Normals > retTriangles, int maxNeighbourTriangles)
 

Protected Member Functions

override void Closing ()
 
- Protected Member Functions inherited from VRage.Game.Entity.MyEntity
virtual bool CanBeAddedToRender ()
 
virtual MySyncComponentBase OnCreateSync ()
 
virtual void ClampToWorld ()
 
virtual void BeforeDelete ()
 
virtual void OnInventoryComponentAdded (MyInventoryBase inventory)
 
virtual void OnInventoryComponentRemoved (MyInventoryBase inventory)
 

Protected Attributes

MyAreaMarkerDefinition m_definition
 
- Protected Attributes inherited from VRage.Game.Entity.MyEntity
List< MyHudEntityParamsm_hudParams
 
MyModel m_modelCollision
 

Properties

MyAreaMarkerDefinition Definition [get]
 
override Vector3D LocationForHudMarker [get]
 
float InteractiveDistance [get]
 
MatrixD ActivationMatrix [get]
 
int RenderObjectID [get]
 
int InstanceID [get]
 
bool ShowOverlay [get]
 
UseActionEnum SupportedActions [get]
 
bool ContinuousUsage [get]
 
- Properties inherited from VRage.Game.Entity.MyEntity
MyEntityComponentContainer Components [get]
 
MyPositionComponentBase PositionComp [get, set]
 
MyRenderComponentBase Render [get, set]
 
MyGameLogicComponent GameLogic [get, set]
 
long EntityId [get, set]
 Entity id, can be set by subclasses (for example when using pool...) More...
 
MySyncComponentBase SyncObject [get, protected set]
 
MyModStorageComponentBase Storage [get, set]
 
bool Closed [get, protected set]
 
bool MarkedForClose [get, protected set]
 
virtual float MaxGlassDistSq [get]
 
bool Save [get, set]
 
bool IsPreview [get, set]
 
bool IsReadyForReplication [get, set]
 
MyEntityUpdateEnum NeedsUpdate [get, set]
 
MatrixD WorldMatrix [get, set]
 
MyEntity Parent [get]
 Gets or sets the parent. More...
 
MyHierarchyComponent< MyEntityHierarchy [get, set]
 
MyPhysicsComponentBase Physics [get, set]
 Gets the physic component of the entity. More...
 
bool InvalidateOnMove [get, set]
 
bool SyncFlag [get, set]
 
bool InScene [get, set]
 
virtual bool IsVolumetric [get]
 
virtual Vector3D LocationForHudMarker [get]
 
MyModel Model [get]
 
MyModel ModelCollision [get]
 
string DisplayName [get, set]
 
string DebugName [get]
 
Dictionary< string, MyEntitySubpartSubparts [get]
 
virtual bool IsCCDForProjectiles [get]
 
int InventoryCount [get]
 Iterate through inventories and return their count. More...
 
bool HasInventory [get]
 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. More...
 
virtual String DisplayNameText [get, set]
 Display Name for GUI etc. Override in descendant classes. Usually used to display in terminal or inventory controls. More...
 
EntityFlags Flags [get, set]
 
- Properties inherited from VRage.ModAPI.IMyEntity
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]
 
- Properties inherited from VRage.Game.Entity.UseObject.IMyUseObject
IMyEntity Owner [get]
 
MyModelDummy Dummy [get]
 
float InteractiveDistance [get]
 Consider object as being in interactive range only if distance from character is smaller or equal to this value More...
 
MatrixD ActivationMatrix [get]
 Matrix of object, scale represents size of object More...
 
MatrixD WorldMatrix [get]
 Matrix of object, scale represents size of object More...
 
int RenderObjectID [get]
 Render ID of objects More...
 
int InstanceID [get]
 Instance ID of objects (this should mostly be unused More...
 
bool ShowOverlay [get]
 Show overlay (semitransparent bounding box) More...
 
UseActionEnum SupportedActions [get]
 Returns supported actions More...
 
bool ContinuousUsage [get]
 When true, use will be called every frame More...
 
bool PlayIndicatorSound [get]
 

Additional Inherited Members

- Public Attributes inherited from VRage.Game.Entity.MyEntity
MyDefinitionId DefinitionId = null
 
string Name
 
bool DebugAsyncLoading
 
DebugCreatedBy DebugCreatedBy
 
float m_massChangeForCollisions = 1f
 
Vector3D m_serverPosition = new Vector3D()
 
Quaternion m_serverOrientation = new Quaternion()
 
MatrixD m_serverWorldMatrix = new MatrixD()
 
Vector3 m_serverLinearVelocity
 
Vector3 m_serverAngularVelocity
 
bool m_positionResetFromServer
 
bool SentFromServer
 
int GamePruningProxyId = MyVRageConstants.PRUNING_PROXY_ID_UNITIALIZED
 
int TopMostPruningProxyId = MyVRageConstants.PRUNING_PROXY_ID_UNITIALIZED
 
bool StaticForPruningStructure = false
 
int TargetPruningProxyId = MyVRageConstants.PRUNING_PROXY_ID_UNITIALIZED
 
Dictionary< IMyReplicable, Action > ReadyForReplicationAction = new Dictionary<IMyReplicable, Action>()
 
- Static Public Attributes inherited from VRage.Game.Entity.MyEntity
static Action< MyEntityAddToGamePruningStructureExtCallBack = null
 
static Action< MyEntityRemoveFromGamePruningStructureExtCallBack = null
 
static Action< MyEntityUpdateGamePruningStructureExtCallBack = null
 
static MyEntityFactoryCreateObjectBuilderDelegate MyEntityFactoryCreateObjectBuilderExtCallback = null
 
static CreateDefaultSyncEntityDelegate CreateDefaultSyncEntityExtCallback
 
static Action< MyEntityMyWeldingGroupsAddNodeExtCallback = null
 
static Action< MyEntityMyWeldingGroupsRemoveNodeExtCallback = null
 
static Action< MyEntity, List< MyEntity > > MyWeldingGroupsGetGroupNodesExtCallback = null
 
static MyWeldingGroupsGroupExistsDelegate MyWeldingGroupsGroupExistsExtCallback = null
 
static Action< MyEntityMyProceduralWorldGeneratorTrackEntityExtCallback = null
 
static Action< MyEntityCreateStandardRenderComponentsExtCallback = null
 
static Action< MyComponentContainer, MyObjectBuilderType, MyStringHash, MyObjectBuilder_ComponentContainerInitComponentsExtCallback = null
 
static Func< MyObjectBuilder_EntityBase, bool, MyEntityMyEntitiesCreateFromObjectBuilderExtCallback = null
 
- Static Protected Member Functions inherited from VRage.Game.Entity.MyEntity
static void UpdateNamedEmissiveParts (uint renderObjectId, string emissiveName, Color emissivePartColor, float emissivity)
 
- Events inherited from VRage.Game.Entity.MyEntity
Action< MyEntityOnMarkForClose
 This event may not be invoked at all, when calling MyEntities.CloseAll, marking is bypassed More...
 
Action< MyEntityOnClose
 
Action< MyEntityOnClosing
 
Action< MyEntityOnPhysicsChanged
 
- Events inherited from VRage.ModAPI.IMyEntity
Action< IMyEntityOnClose
 
Action< IMyEntityOnClosing
 
Action< IMyEntityOnMarkForClose
 
Action< IMyEntityOnPhysicsChanged
 

Detailed Description

Definition at line 34 of file MyAreaMarker.cs.

Constructor & Destructor Documentation

Sandbox.Game.Entities.MyAreaMarker.MyAreaMarker ( )
inline

Definition at line 50 of file MyAreaMarker.cs.

Sandbox.Game.Entities.MyAreaMarker.MyAreaMarker ( MyPositionAndOrientation  positionAndOrientation,
MyAreaMarkerDefinition  definition 
)
inline

Definition at line 55 of file MyAreaMarker.cs.

Member Function Documentation

virtual void Sandbox.Game.Entities.MyAreaMarker.AddHudMarker ( )
inlinevirtual

Definition at line 142 of file MyAreaMarker.cs.

override void Sandbox.Game.Entities.MyAreaMarker.Closing ( )
inlineprotectedvirtual

Reimplemented from VRage.Game.Entity.MyEntity.

Definition at line 154 of file MyAreaMarker.cs.

virtual MyActionDescription Sandbox.Game.Entities.MyAreaMarker.GetActionInfo ( UseActionEnum  actionEnum)
inlinevirtual

Gets action text Caller calls this method only on supported actions

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Definition at line 219 of file MyAreaMarker.cs.

override MyObjectBuilder_EntityBase Sandbox.Game.Entities.MyAreaMarker.GetObjectBuilder ( bool  copy = false)
inlinevirtual

Gets object builder from object.

Returns

Reimplemented from VRage.Game.Entity.MyEntity.

Definition at line 107 of file MyAreaMarker.cs.

bool Sandbox.Game.Entities.MyAreaMarker.HandleInput ( )
inline

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Definition at line 228 of file MyAreaMarker.cs.

override void Sandbox.Game.Entities.MyAreaMarker.Init ( MyObjectBuilder_EntityBase  objectBuilder)
inlinevirtual

Reimplemented from VRage.Game.Entity.MyEntity.

Definition at line 72 of file MyAreaMarker.cs.

void Sandbox.Game.Entities.MyAreaMarker.OnSelectionLost ( )
inline

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Definition at line 233 of file MyAreaMarker.cs.

void Sandbox.Game.Entities.MyAreaMarker.SetInstanceID ( int  id)
inline

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Definition at line 195 of file MyAreaMarker.cs.

void Sandbox.Game.Entities.MyAreaMarker.SetRenderID ( uint  id)
inline

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Definition at line 186 of file MyAreaMarker.cs.

virtual void Sandbox.Game.Entities.MyAreaMarker.Use ( UseActionEnum  actionEnum,
IMyEntity  user 
)
inlinevirtual

Uses object by specified action Caller calls this method only on supported actions

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Definition at line 214 of file MyAreaMarker.cs.

Member Data Documentation

MyAreaMarkerDefinition Sandbox.Game.Entities.MyAreaMarker.m_definition
protected

Definition at line 36 of file MyAreaMarker.cs.

Property Documentation

MatrixD Sandbox.Game.Entities.MyAreaMarker.ActivationMatrix
get

Definition at line 177 of file MyAreaMarker.cs.

bool Sandbox.Game.Entities.MyAreaMarker.ContinuousUsage
get

Definition at line 210 of file MyAreaMarker.cs.

MyAreaMarkerDefinition Sandbox.Game.Entities.MyAreaMarker.Definition
get

Definition at line 37 of file MyAreaMarker.cs.

int Sandbox.Game.Entities.MyAreaMarker.InstanceID
get

Definition at line 191 of file MyAreaMarker.cs.

float Sandbox.Game.Entities.MyAreaMarker.InteractiveDistance
get

Definition at line 172 of file MyAreaMarker.cs.

override Vector3D Sandbox.Game.Entities.MyAreaMarker.LocationForHudMarker
get

Definition at line 43 of file MyAreaMarker.cs.

int Sandbox.Game.Entities.MyAreaMarker.RenderObjectID
get

Definition at line 182 of file MyAreaMarker.cs.

bool Sandbox.Game.Entities.MyAreaMarker.ShowOverlay
get

Definition at line 200 of file MyAreaMarker.cs.

UseActionEnum Sandbox.Game.Entities.MyAreaMarker.SupportedActions
get

Definition at line 205 of file MyAreaMarker.cs.


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