Space Engineers
Public Member Functions | Properties | Events | List of all members
VRage.Game.Components.MyEntityComponentBase Class Reference
Inheritance diagram for VRage.Game.Components.MyEntityComponentBase:
VRage.Game.Components.MyComponentBase Sandbox.Game.Components.MyCharacterSoundComponent Sandbox.Game.Components.MyEntityStatComponent Sandbox.Game.Components.MyTimerComponent Sandbox.Game.Components.MyTriggerComponent Sandbox.Game.Entities.Character.MyCharacterComponent Sandbox.Game.Entities.Inventory.MyTriggerAggregate Sandbox.Game.Entities.MyDataBroadcaster Sandbox.Game.Entities.MyDataReceiver Sandbox.Game.Entities.MyGravityProviderComponent Sandbox.Game.Entities.MyPlaceArea Sandbox.Game.Entities.MyWeaponSharedActionsComponentBase Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent Sandbox.Game.EntityComponents.MyAtmosphereDetectorComponent Sandbox.Game.EntityComponents.MyCasterComponent Sandbox.Game.EntityComponents.MyEntityInventorySpawnComponent Sandbox.Game.EntityComponents.MyEntityReferenceComponent Sandbox.Game.EntityComponents.MyEntityReverbDetectorComponent Sandbox.Game.EntityComponents.MyFractureComponentBase Sandbox.Game.EntityComponents.MyGridOwnershipComponentBase Sandbox.Game.EntityComponents.MyGridTargeting Sandbox.Game.EntityComponents.MyModelComponent Sandbox.Game.EntityComponents.MyResourceDistributorComponent Sandbox.Game.EntityComponents.MyShipSoundComponent Sandbox.Game.GameSystems.MyEntityThrustComponent VRage.Game.Components.MyAnimationControllerComponent VRage.Game.Components.MyGameLogicComponent VRage.Game.Components.MyHierarchyComponentBase VRage.Game.Components.MyModStorageComponentBase VRage.Game.Components.MyPhysicsComponentBase VRage.Game.Components.MyPositionComponentBase VRage.Game.Components.MyRenderComponentBase VRage.Game.Components.MyResourceSinkComponentBase VRage.Game.Components.MyResourceSourceComponentBase VRage.Game.Components.MyRespawnComponent VRage.Game.Components.MySyncComponentBase VRage.Game.Components.MyUseObjectsComponentBase VRage.Game.Entity.EntityComponents.MyEntityOwnershipComponent VRage.Game.Entity.MyInventoryBase

Public Member Functions

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 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...
 
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 MyObjectBuilder_ComponentBase Serialize (bool copy=false)
 
virtual void Deserialize (MyObjectBuilder_ComponentBase builder)
 
virtual void Init (MyComponentDefinitionBase definition)
 
virtual bool IsSerialized ()
 Tells the component container serializer whether this component should be saved More...
 

Properties

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...
 

Events

static Action< MyEntityComponentBaseOnAfterAddedToContainer
 
Action< MyEntityComponentBaseBeforeRemovedFromContainer
 

Detailed Description

Definition at line 32 of file MyEntityComponentBase.cs.

Member Function Documentation

override void VRage.Game.Components.MyEntityComponentBase.OnAddedToContainer ( )
inlinevirtual
override void VRage.Game.Components.MyEntityComponentBase.OnBeforeRemovedFromContainer ( )
inlinevirtual

Property Documentation

abstract string VRage.Game.Components.MyEntityComponentBase.ComponentTypeDebugString
get

Name of the base component type for debug purposes (e.g.: "Position")

Definition at line 55 of file MyEntityComponentBase.cs.

MyEntityComponentContainer VRage.Game.Components.MyEntityComponentBase.Container
get

Definition at line 35 of file MyEntityComponentBase.cs.

IMyEntity VRage.Game.Components.MyEntityComponentBase.Entity
get

Definition at line 43 of file MyEntityComponentBase.cs.

Event Documentation

Action<MyEntityComponentBase> VRage.Game.Components.MyEntityComponentBase.BeforeRemovedFromContainer

Definition at line 69 of file MyEntityComponentBase.cs.

Action<MyEntityComponentBase> VRage.Game.Components.MyEntityComponentBase.OnAfterAddedToContainer
static

Definition at line 59 of file MyEntityComponentBase.cs.


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