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

Public Member Functions

 MySphericalNaturalGravityComponent (double minRadius, double maxRadius, double falloff, double intensity)
 
override bool IsPositionInRange (Vector3D worldPoint)
 
override Vector3 GetWorldGravity (Vector3D worldPoint)
 
override float GetGravityMultiplier (Vector3D worldPoint)
 
Vector3 GetWorldGravityNormalized (ref Vector3D worldPoint)
 
override void OnAddedToContainer ()
 Gets called after the container of this component changes More...
 
- 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

Vector3D Position [get]
 
override bool IsWorking [get]
 
float GravityLimit [get]
 
float GravityLimitSq [get]
 
override string ComponentTypeDebugString [get]
 
- Properties inherited from Sandbox.Game.Entities.MyGravityProviderComponent
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 MySphericalNaturalGravityComponent.cs.

Constructor & Destructor Documentation

Sandbox.Game.Entities.MySphericalNaturalGravityComponent.MySphericalNaturalGravityComponent ( double  minRadius,
double  maxRadius,
double  falloff,
double  intensity 
)
inline

Definition at line 23 of file MySphericalNaturalGravityComponent.cs.

Member Function Documentation

override float Sandbox.Game.Entities.MySphericalNaturalGravityComponent.GetGravityMultiplier ( Vector3D  worldPoint)
inlinevirtual
override Vector3 Sandbox.Game.Entities.MySphericalNaturalGravityComponent.GetWorldGravity ( Vector3D  worldPoint)
inlinevirtual
Vector3 Sandbox.Game.Entities.MySphericalNaturalGravityComponent.GetWorldGravityNormalized ( ref Vector3D  worldPoint)
inline

Definition at line 97 of file MySphericalNaturalGravityComponent.cs.

override bool Sandbox.Game.Entities.MySphericalNaturalGravityComponent.IsPositionInRange ( Vector3D  worldPoint)
inlinevirtual
override void Sandbox.Game.Entities.MySphericalNaturalGravityComponent.OnAddedToContainer ( )
inlinevirtual

Gets called after the container of this component changes

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 109 of file MySphericalNaturalGravityComponent.cs.

Property Documentation

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

Definition at line 105 of file MySphericalNaturalGravityComponent.cs.

float Sandbox.Game.Entities.MySphericalNaturalGravityComponent.GravityLimit
get

Definition at line 43 of file MySphericalNaturalGravityComponent.cs.

float Sandbox.Game.Entities.MySphericalNaturalGravityComponent.GravityLimitSq
get

Definition at line 53 of file MySphericalNaturalGravityComponent.cs.

override bool Sandbox.Game.Entities.MySphericalNaturalGravityComponent.IsWorking
get

Definition at line 38 of file MySphericalNaturalGravityComponent.cs.

Vector3D Sandbox.Game.Entities.MySphericalNaturalGravityComponent.Position
get

Definition at line 18 of file MySphericalNaturalGravityComponent.cs.


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