Space Engineers
Public Member Functions | Protected Member Functions | Properties | List of all members
Sandbox.Game.EntityComponents.MyAreaTriggerComponent Class Reference
Inheritance diagram for Sandbox.Game.EntityComponents.MyAreaTriggerComponent:
Sandbox.Game.Components.MyTriggerComponent VRage.Game.Components.MyEntityComponentBase VRage.Game.Components.MyComponentBase

Public Member Functions

 MyAreaTriggerComponent ()
 
 MyAreaTriggerComponent (string name)
 
override MyObjectBuilder_ComponentBase Serialize (bool copy)
 
override void Deserialize (MyObjectBuilder_ComponentBase builder)
 
override bool IsSerialized ()
 Tells the component container serializer whether this component should be saved More...
 
- Public Member Functions inherited from Sandbox.Game.Components.MyTriggerComponent
 MyTriggerComponent (TriggerType type, uint updateFrequency=300)
 
 MyTriggerComponent ()
 
override MyObjectBuilder_ComponentBase Serialize (bool copy=false)
 
override void Deserialize (MyObjectBuilder_ComponentBase builder)
 
override void OnAddedToScene ()
 CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already! More...
 
override void OnBeforeRemovedFromContainer ()
 Gets called before the removal of this component from a container More...
 
override void OnAddedToContainer ()
 Gets called after the container of this component changes More...
 
void Update ()
 
virtual void Dispose ()
 Override for custom trigger disposal before removing. More...
 
virtual void DebugDraw ()
 
override bool IsSerialized ()
 Tells the component container serializer whether this component should be saved More...
 
bool Contains (Vector3D point)
 
- Public Member Functions inherited from VRage.Game.Components.MyEntityComponentBase
override void OnAddedToContainer ()
 Gets called after the container of this component changes More...
 
override void OnBeforeRemovedFromContainer ()
 Gets called before the removal of this component from a container More...
 
- Public Member Functions inherited from VRage.Game.Components.MyComponentBase
virtual void SetContainer (MyComponentContainer container)
 Sets the container of this component. Note that the component is not added to the container here! Therefore, use MyComponentContainer.Add(...) method and it will in turn call this method. Actually, you should seldom have the need to call this method yourself. More...
 
virtual T GetAs< T > ()
 
virtual void OnRemovedFromScene ()
 CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene! More...
 
virtual void Init (MyComponentDefinitionBase definition)
 

Protected Member Functions

override void UpdateInternal ()
 Override this function to set custom update behaviour. Call base at first because it queries objects if DoQuery is set. More...
 
override bool QueryEvaluator (MyEntity entity)
 Override to discard query results of your choice. More...
 

Properties

string Name [get, set]
 
double Radius [get, set]
 
Vector3D Center [get, set]
 
- Properties inherited from Sandbox.Game.Components.MyTriggerComponent
bool DoQuery [get, set]
 
List< MyEntityQueryResult [get]
 
uint UpdateFrequency [get, set]
 
virtual bool Enabled [get, protected set]
 
override string ComponentTypeDebugString [get]
 
Color CustomDebugColor [get, set]
 
Vector3D Center [get]
 Trigger BB center position. More...
 
- Properties inherited from VRage.Game.Components.MyEntityComponentBase
MyEntityComponentContainer Container [get]
 
IMyEntity Entity [get]
 
abstract string ComponentTypeDebugString [get]
 Name of the base component type for debug purposes (e.g.: "Position") More...
 
- Properties inherited from VRage.Game.Components.MyComponentBase
MyComponentContainer ContainerBase [get]
 This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase. More...
 

Additional Inherited Members

- Public Types inherited from Sandbox.Game.Components.MyTriggerComponent
enum  TriggerType { TriggerType.AABB, TriggerType.Sphere }
 
- Public Attributes inherited from Sandbox.Game.Components.MyTriggerComponent
Vector3D DefaultTranslation = Vector3D.Zero
 
- Protected Attributes inherited from Sandbox.Game.Components.MyTriggerComponent
TriggerType m_triggerType
 
BoundingBoxD m_AABB
 
BoundingSphereD m_boundingSphere
 
- Events inherited from VRage.Game.Components.MyEntityComponentBase
static Action< MyEntityComponentBaseOnAfterAddedToContainer
 
Action< MyEntityComponentBaseBeforeRemovedFromContainer
 

Detailed Description

Definition at line 15 of file MyAreaTriggerComponent.cs.

Constructor & Destructor Documentation

Sandbox.Game.EntityComponents.MyAreaTriggerComponent.MyAreaTriggerComponent ( )
inline

Definition at line 37 of file MyAreaTriggerComponent.cs.

Sandbox.Game.EntityComponents.MyAreaTriggerComponent.MyAreaTriggerComponent ( string  name)
inline

Definition at line 40 of file MyAreaTriggerComponent.cs.

Member Function Documentation

override void Sandbox.Game.EntityComponents.MyAreaTriggerComponent.Deserialize ( MyObjectBuilder_ComponentBase  builder)
inlinevirtual

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 107 of file MyAreaTriggerComponent.cs.

override bool Sandbox.Game.EntityComponents.MyAreaTriggerComponent.IsSerialized ( )
inlinevirtual

Tells the component container serializer whether this component should be saved

Returns

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 115 of file MyAreaTriggerComponent.cs.

override bool Sandbox.Game.EntityComponents.MyAreaTriggerComponent.QueryEvaluator ( MyEntity  entity)
inlineprotectedvirtual

Override to discard query results of your choice.

Parameters
entity
Returns
True for valid entities.

Reimplemented from Sandbox.Game.Components.MyTriggerComponent.

Definition at line 85 of file MyAreaTriggerComponent.cs.

override MyObjectBuilder_ComponentBase Sandbox.Game.EntityComponents.MyAreaTriggerComponent.Serialize ( bool  copy)
inlinevirtual

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 99 of file MyAreaTriggerComponent.cs.

override void Sandbox.Game.EntityComponents.MyAreaTriggerComponent.UpdateInternal ( )
inlineprotectedvirtual

Override this function to set custom update behaviour. Call base at first because it queries objects if DoQuery is set.

Reimplemented from Sandbox.Game.Components.MyTriggerComponent.

Definition at line 45 of file MyAreaTriggerComponent.cs.

Property Documentation

Vector3D Sandbox.Game.EntityComponents.MyAreaTriggerComponent.Center
getset

Definition at line 24 of file MyAreaTriggerComponent.cs.

string Sandbox.Game.EntityComponents.MyAreaTriggerComponent.Name
getset

Definition at line 20 of file MyAreaTriggerComponent.cs.

double Sandbox.Game.EntityComponents.MyAreaTriggerComponent.Radius
getset

Definition at line 21 of file MyAreaTriggerComponent.cs.


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