Sandbox.Game.Entities.MyPlaceArea Class Reference

Inheritance diagram for Sandbox.Game.Entities.MyPlaceArea:

Public Member Functions
	MyPlaceArea (MyStringHash areaType)
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...
abstract double	DistanceSqToPoint (Vector3D point)
abstract bool	TestPoint (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	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...

Static Public Member Functions
static MyPlaceArea	FromEntity (long entityId)

Public Attributes
int	PlaceAreaProxyId = MyVRageConstants.PRUNING_PROXY_ID_UNITIALIZED

Properties
abstract BoundingBoxD	WorldAABB [get]
MyStringHash	AreaType [get]
override string	ComponentTypeDebugString [get]
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
Events inherited from VRage.Game.Components.MyEntityComponentBase
static Action< MyEntityComponentBase >	OnAfterAddedToContainer
Action< MyEntityComponentBase >	BeforeRemovedFromContainer

Detailed Description

Definition at line 17 of file MyPlaceArea.cs.

Constructor & Destructor Documentation

Sandbox.Game.Entities.MyPlaceArea.MyPlaceArea ( MyStringHash  areaType )

inline

Definition at line 37 of file MyPlaceArea.cs.

Member Function Documentation

abstract double Sandbox.Game.Entities.MyPlaceArea.DistanceSqToPoint ( Vector3D  point )

pure virtual

Implemented in Sandbox.Game.Entities.MySpherePlaceArea.

static MyPlaceArea Sandbox.Game.Entities.MyPlaceArea.FromEntity ( long  entityId )

inlinestatic

Definition at line 24 of file MyPlaceArea.cs.

override void Sandbox.Game.Entities.MyPlaceArea.OnAddedToContainer ( )

inlinevirtual

Gets called after the container of this component changes

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 42 of file MyPlaceArea.cs.

override void Sandbox.Game.Entities.MyPlaceArea.OnBeforeRemovedFromContainer ( )

inlinevirtual

Gets called before the removal of this component from a container

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 48 of file MyPlaceArea.cs.

abstract bool Sandbox.Game.Entities.MyPlaceArea.TestPoint ( Vector3D  point )

pure virtual

Implemented in Sandbox.Game.Entities.MySpherePlaceArea.

Member Data Documentation

int Sandbox.Game.Entities.MyPlaceArea.PlaceAreaProxyId = MyVRageConstants.PRUNING_PROXY_ID_UNITIALIZED

Definition at line 19 of file MyPlaceArea.cs.

Property Documentation

MyStringHash Sandbox.Game.Entities.MyPlaceArea.AreaType

get

Definition at line 22 of file MyPlaceArea.cs.

override string Sandbox.Game.Entities.MyPlaceArea.ComponentTypeDebugString

get

Definition at line 59 of file MyPlaceArea.cs.

abstract BoundingBoxD Sandbox.Game.Entities.MyPlaceArea.WorldAABB

get

Definition at line 21 of file MyPlaceArea.cs.

---

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

• Sources/Sandbox.Game/Game/Entities/MyPlaceArea.cs