Show / Hide Table of Contents

Class MySphericalNaturalGravityComponent

Inheritance
System.Object
MyComponentBase
MyEntityComponentBase
MyGravityProviderComponent
MySphericalNaturalGravityComponent
Implements
IMyGravityProvider
IMySphericalNaturalGravityComponent
IMyNaturalGravityComponent
Inherited Members
MyEntityComponentBase.OnBeforeRemovedFromContainer()
MyEntityComponentBase.Container
MyEntityComponentBase.Entity
MyEntityComponentBase.AttachSyncToEntity
MyEntityComponentBase.OnAfterAddedToContainer
MyEntityComponentBase.BeforeRemovedFromContainer
MyComponentBase.SetContainer(IMyComponentContainer)
MyComponentBase.GetAs<T>()
MyComponentBase.OnAddedToScene()
MyComponentBase.OnRemovedFromScene()
MyComponentBase.Serialize(Boolean)
MyComponentBase.Deserialize(MyObjectBuilder_ComponentBase)
MyComponentBase.Init(MyComponentDefinitionBase)
MyComponentBase.IsSerialized()
MyComponentBase.RemoveExistingComponentOnNewInsert
MyComponentBase.ContainerBase
Namespace: Sandbox.Game.Entities
Assembly: Sandbox.Game.dll
Syntax
public class MySphericalNaturalGravityComponent : MyGravityProviderComponent, IMyEntityComponentBase, IMyComponentBase, IMyGravityProvider, IMySphericalNaturalGravityComponent, IMyNaturalGravityComponent

Constructors

MySphericalNaturalGravityComponent(Double, Double, Double, Double)

Declaration
public MySphericalNaturalGravityComponent(double minRadius, double maxRadius, double falloff, double intensity)
Parameters
Type Name Description
System.Double minRadius
System.Double maxRadius
System.Double falloff
System.Double intensity

Properties

ComponentTypeDebugString

Declaration
public override string ComponentTypeDebugString { get; }
Property Value
Type Description
System.String
Overrides
MyGravityProviderComponent.ComponentTypeDebugString

GravityLimit

Declaration
public override float GravityLimit { get; }
Property Value
Type Description
System.Single
Overrides
MyGravityProviderComponent.GravityLimit

GravityLimitSq

Declaration
public float GravityLimitSq { get; }
Property Value
Type Description
System.Single

IsWorking

Declaration
public override bool IsWorking { get; }
Property Value
Type Description
System.Boolean
Overrides
MyGravityProviderComponent.IsWorking

Position

Declaration
public Vector3D Position { get; }
Property Value
Type Description
Vector3D

Methods

CalculateGravityLimit()

Declaration
public void CalculateGravityLimit()

DoesTrajectoryIntersectNaturalGravity(RayD, Double)

Declaration
public override Nullable<double> DoesTrajectoryIntersectNaturalGravity(RayD trajectory, double raySize)
Parameters
Type Name Description
RayD trajectory
System.Double raySize
Returns
Type Description
System.Nullable<System.Double>
Overrides
MyGravityProviderComponent.DoesTrajectoryIntersectNaturalGravity(RayD, Double)

GetGravityMultiplier(Vector3D)

Declaration
public override float GetGravityMultiplier(Vector3D worldPoint)
Parameters
Type Name Description
Vector3D worldPoint
Returns
Type Description
System.Single
Overrides
MyGravityProviderComponent.GetGravityMultiplier(Vector3D)

GetProxyAABB(out BoundingBoxD)

Declaration
public override void GetProxyAABB(out BoundingBoxD aabb)
Parameters
Type Name Description
BoundingBoxD aabb
Overrides
MyGravityProviderComponent.GetProxyAABB(out BoundingBoxD)

GetWorldGravity(Vector3D)

Declaration
public override Vector3 GetWorldGravity(Vector3D worldPoint)
Parameters
Type Name Description
Vector3D worldPoint
Returns
Type Description
Vector3
Overrides
MyGravityProviderComponent.GetWorldGravity(Vector3D)

GetWorldGravityNormalized(in Vector3D)

Declaration
public override Vector3 GetWorldGravityNormalized(in Vector3D worldPoint)
Parameters
Type Name Description
Vector3D worldPoint
Returns
Type Description
Vector3
Overrides
MyGravityProviderComponent.GetWorldGravityNormalized(in Vector3D)

IsPositionInRange(Vector3D)

Declaration
public override bool IsPositionInRange(Vector3D worldPoint)
Parameters
Type Name Description
Vector3D worldPoint
Returns
Type Description
System.Boolean
Overrides
MyGravityProviderComponent.IsPositionInRange(Vector3D)

OnAddedToContainer()

Declaration
public override void OnAddedToContainer()
Overrides
MyEntityComponentBase.OnAddedToContainer()

Explicit Interface Implementations

IMyNaturalGravityComponent.Position

Declaration
Vector3D IMyNaturalGravityComponent.Position { get; set; }
Returns
Type Description
Vector3D

IMySphericalNaturalGravityComponent.Falloff

Declaration
double IMySphericalNaturalGravityComponent.Falloff { get; set; }
Returns
Type Description
System.Double

IMySphericalNaturalGravityComponent.Intensity

Declaration
double IMySphericalNaturalGravityComponent.Intensity { get; set; }
Returns
Type Description
System.Double

IMySphericalNaturalGravityComponent.MaxRadius

Declaration
double IMySphericalNaturalGravityComponent.MaxRadius { get; set; }
Returns
Type Description
System.Double

IMySphericalNaturalGravityComponent.MinRadius

Declaration
double IMySphericalNaturalGravityComponent.MinRadius { get; set; }
Returns
Type Description
System.Double

Implements

IMyGravityProvider
IMySphericalNaturalGravityComponent
IMyNaturalGravityComponent

Extension Methods

MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
MyEntityContainerEventExtensions.UnregisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash)
MyEntityContainerEventExtensions.RaiseEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾