Inheritance diagram for VRage.Game.Components.MyComponentBase:

Public Member Functions
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	OnAddedToContainer ()
	Gets called after the container of this component changes More...

virtual void	OnBeforeRemovedFromContainer ()
	Gets called before the removal of this component from a container More...

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
MyComponentContainer	ContainerBase `[get]`
	This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase. More...

Detailed Description

Definition at line 5 of file MyComponentBase.cs.

Member Function Documentation

virtual void VRage.Game.Components.MyComponentBase.Deserialize ( MyObjectBuilder_ComponentBase builder )

inlinevirtual

Reimplemented in Sandbox.Game.MyInventory, Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent, VRage.Game.Components.MyPhysicsComponentBase, Sandbox.Game.Entities.Inventory.MyInventoryAggregate, Sandbox.Game.Components.MyCraftingComponentBlock, VRage.Game.Components.MyHierarchyComponentBase, Sandbox.Game.Components.MyEntityStatComponent, Sandbox.Game.Components.MyCraftingComponentInteractive, Sandbox.Game.Components.MyTimerComponent, Sandbox.Game.Components.MyCraftingComponentBasic, Sandbox.Game.Entities.Inventory.MyTriggerAggregate, Sandbox.Game.EntityComponents.MyAreaTriggerComponent, Sandbox.Game.EntityComponents.MyModStorageComponent, Sandbox.Game.Components.MyTriggerComponent, Sandbox.Game.EntityComponents.MyFractureComponentCubeBlock, VRage.Game.Entity.EntityComponents.MyEntityOwnershipComponent, VRage.Game.Entity.MyInventoryBase, and Sandbox.Game.Components.MyUpdateTriggerComponent.

Definition at line 81 of file MyComponentBase.cs.

virtual T VRage.Game.Components.MyComponentBase.GetAs< T > ( )

inlinevirtual

Reimplemented in Sandbox.Game.Entities.MyCompositeGameLogicComponent.

Type Constraints

T

:

MyComponentBase

Definition at line 43 of file MyComponentBase.cs.

virtual void VRage.Game.Components.MyComponentBase.Init ( MyComponentDefinitionBase definition )

inlinevirtual

Reimplemented in Sandbox.Engine.Physics.MyPhysicsBody, Sandbox.Game.MyInventory, VRage.Game.Components.MyPhysicsComponentBase, Sandbox.Game.Components.MyUseObjectsComponent, Sandbox.Game.Components.MyEntityStatComponent, Sandbox.Game.Components.MyCraftingComponentBlock, Sandbox.Game.EntityComponents.MyEntityInventorySpawnComponent, Sandbox.Game.Components.MyTimerComponent, Sandbox.Game.EntityComponents.MyCasterComponent, Sandbox.Game.EntityComponents.MyModelComponent, Sandbox.Game.Components.MyCraftingComponentInteractive, and Sandbox.Game.Components.MyCraftingComponentBasic.

Definition at line 85 of file MyComponentBase.cs.

virtual bool VRage.Game.Components.MyComponentBase.IsSerialized ( )

inlinevirtual

Tells the component container serializer whether this component should be saved

Returns

Reimplemented in Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent, VRage.Game.Components.MyPhysicsComponentBase, Sandbox.Game.Components.MyUseObjectsComponent, Sandbox.Game.Components.MyCraftingComponentBlock, Sandbox.Game.Components.MyEntityStatComponent, Sandbox.Game.Components.MyTriggerComponent, VRage.Game.Components.MyHierarchyComponentBase, Sandbox.Game.Components.MyCraftingComponentInteractive, Sandbox.Game.Entities.Character.Components.MyInventorySpawnComponent, Sandbox.Game.EntityComponents.MyEntityInventorySpawnComponent, VRage.Game.Entity.MyInventoryBase, Sandbox.Game.Components.MyTimerComponent, Sandbox.Game.EntityComponents.MyAreaTriggerComponent, Sandbox.Game.Components.MyCraftingComponentBasic, VRage.Game.Components.MyRespawnComponent, VRage.Game.Entity.EntityComponents.MyEntityOwnershipComponent, Sandbox.Game.EntityComponents.MyFractureComponentBase, Sandbox.Game.Entities.Inventory.MyTriggerAggregate, and Sandbox.Game.EntityComponents.MyModStorageComponent.

Definition at line 91 of file MyComponentBase.cs.

virtual void VRage.Game.Components.MyComponentBase.OnAddedToContainer ( )

inlinevirtual

Gets called after the container of this component changes

Definition at line 51 of file MyComponentBase.cs.

virtual void VRage.Game.Components.MyComponentBase.OnAddedToScene ( )

inlinevirtual

CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already!

Reimplemented in Sandbox.Engine.Physics.MyPhysicsBody, Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent, Sandbox.Game.Components.MyUseObjectsComponent, VRage.Game.Components.MyHierarchyComponentBase, Sandbox.Game.Components.MyUpdateTriggerComponent, Sandbox.Game.Entities.Inventory.MyTriggerAggregate, Sandbox.Game.Components.MyTriggerComponent, VRage.Game.Components.MyUseObjectsComponentBase, and VRage.Game.Components.MyRespawnComponent.

Definition at line 65 of file MyComponentBase.cs.

virtual void VRage.Game.Components.MyComponentBase.OnBeforeRemovedFromContainer ( )

inlinevirtual

Gets called before the removal of this component from a container

Definition at line 58 of file MyComponentBase.cs.

virtual void VRage.Game.Components.MyComponentBase.OnRemovedFromScene ( )

inlinevirtual

CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene!

Reimplemented in Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent, Sandbox.Game.Entities.Character.MyCharacterDetectorComponent, Sandbox.Game.Entities.Inventory.MyTriggerAggregate, VRage.Game.Components.MyUseObjectsComponentBase, and VRage.Game.Components.MyRespawnComponent.

Definition at line 72 of file MyComponentBase.cs.

virtual MyObjectBuilder_ComponentBase VRage.Game.Components.MyComponentBase.Serialize ( bool copy = false )

inlinevirtual

Definition at line 76 of file MyComponentBase.cs.

virtual void VRage.Game.Components.MyComponentBase.SetContainer ( MyComponentContainer container )

inlinevirtual

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.

Parameters

container The new container of the component

Definition at line 23 of file MyComponentBase.cs.

Property Documentation

MyComponentContainer VRage.Game.Components.MyComponentBase.ContainerBase

get

This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase.

Definition at line 13 of file MyComponentBase.cs.

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

Sources/VRage.Game/Components/MyComponentBase.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation