Space Engineers
Public Member Functions | Properties | List of all members
Sandbox.Game.Entities.MyGravityProviderComponent Class Referenceabstract
Inheritance diagram for Sandbox.Game.Entities.MyGravityProviderComponent:
VRage.Game.Components.MyEntityComponentBase Sandbox.Game.Entities.IMyGravityProvider VRage.Game.Components.MyComponentBase Sandbox.Game.Entities.MySphericalNaturalGravityComponent

Public Member Functions

abstract Vector3 GetWorldGravity (Vector3D worldPoint)
 
abstract bool IsPositionInRange (Vector3D worldPoint)
 
abstract float GetGravityMultiplier (Vector3D worldPoint)
 
- 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...
 

Properties

override string ComponentTypeDebugString [get]
 
abstract bool IsWorking [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...
 
- Properties inherited from Sandbox.Game.Entities.IMyGravityProvider
bool IsWorking [get]
 

Additional Inherited Members

- Events inherited from VRage.Game.Components.MyEntityComponentBase
static Action< MyEntityComponentBaseOnAfterAddedToContainer
 
Action< MyEntityComponentBaseBeforeRemovedFromContainer
 

Detailed Description

Definition at line 8 of file MyGravityProviderComponent.cs.

Member Function Documentation

abstract float Sandbox.Game.Entities.MyGravityProviderComponent.GetGravityMultiplier ( Vector3D  worldPoint)
pure virtual
abstract Vector3 Sandbox.Game.Entities.MyGravityProviderComponent.GetWorldGravity ( Vector3D  worldPoint)
pure virtual
abstract bool Sandbox.Game.Entities.MyGravityProviderComponent.IsPositionInRange ( Vector3D  worldPoint)
pure virtual

Property Documentation

override string Sandbox.Game.Entities.MyGravityProviderComponent.ComponentTypeDebugString
get

Definition at line 11 of file MyGravityProviderComponent.cs.

abstract bool Sandbox.Game.Entities.MyGravityProviderComponent.IsWorking
get

Definition at line 15 of file MyGravityProviderComponent.cs.


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