Class MyPlanet
  
  
  
  
    Inheritance
    System.Object
    
    
    MyPlanet
   
  
  
    Inherited Members
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      MyVoxelBase.IMyDecalProxy.AddDecals(MyHitInfo, MyStringHash, Vector3, Object, IMyDecalHandler, MyStringHash, MyStringHash, Boolean, MyDecalFlags, Int32, List<UInt32>)
     
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  
  Assembly: Sandbox.Game.dll
  Syntax
  
    [MyEntityType]
public class MyPlanet : MyVoxelBase, IMyVoxelDrawable, IMyVoxelBase, IMyEntity, IMyEntity, IMyDecalProxy, IMyEventProxy, IMyEventOwner, IMyOxygenProvider
   
  Constructors
  
  
  
  
  MyPlanet()
  
  
  Declaration
  
  Fields
  
  
  
  MemoryTracker
  
  
  Declaration
  
    public static MyMemorySystem MemoryTracker
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | VRage.Library.Memory.MyMemorySystem |  | 
    
  
  
  
  PHYSICS_SECTOR_SIZE_METERS
  
  
  Declaration
  
    public const int PHYSICS_SECTOR_SIZE_METERS = 1024
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
  
  RUN_SECTORS
  
  
  Declaration
  
    public static bool RUN_SECTORS
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  Properties
  
  
  
  
  AtmosphereAltitude
  
  
  Declaration
  
    public float AtmosphereAltitude { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Single |  | 
    
  
  
  
  
  AtmosphereRadius
  
  
  Declaration
  
    public float AtmosphereRadius { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Single |  | 
    
  
  
  
  
  AtmosphereSettings
  
  
  Declaration
  
    public MyAtmosphereSettings AtmosphereSettings { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | VRageRender.Messages.MyAtmosphereSettings |  | 
    
  
  
  
  
  AtmosphereWavelengths
  
  
  Declaration
  
    public Vector3 AtmosphereWavelengths { get; }
   
  Property Value
  
  
  
  
  AverageRadius
  
  
  Declaration
  
    public float AverageRadius { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Single |  | 
    
  
  
  
  
  Generator
  
  
  Declaration
  
    public MyPlanetGeneratorDefinition Generator { get; }
   
  Property Value
  
  
  
  
  GetInitArguments
  
  
  Declaration
  
    public MyPlanetInitArguments GetInitArguments { get; }
   
  Property Value
  
  
  
  
  HasAtmosphere
  
  
  Declaration
  
    public bool HasAtmosphere { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
  
  
  MaximumRadius
  
  
  Declaration
  
    public float MaximumRadius { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Single |  | 
    
  
  
  
  
  MinimumRadius
  
  
  Declaration
  
    public float MinimumRadius { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Single |  | 
    
  
  
  
  
  PositionLeftBottomCorner
  
  
  Declaration
  
    public override Vector3D PositionLeftBottomCorner { get; set; }
   
  Property Value
  
  Overrides
  
  
  
  
  Provider
  
  
  Declaration
  
    public MyPlanetStorageProvider Provider { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | Sandbox.Engine.Voxels.Planet.MyPlanetStorageProvider |  | 
    
  
  
  
  
  RootVoxel
  
  
  Declaration
  
    public override MyVoxelBase RootVoxel { get; }
   
  Property Value
  
  Overrides
  
  
  
  
  ScaleGroup
  
  
  Declaration
  
    public override MyClipmapScaleEnum ScaleGroup { get; }
   
  Property Value
  
  Overrides
  
  
  
  
  SpherizeWithDistance
  
  
  Declaration
  
    public bool SpherizeWithDistance { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
  
  
  Storage
  
  
  Declaration
  
    public IMyStorage Storage { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | VRage.Game.Voxels.IMyStorage |  | 
    
  
  Methods
  
  
  
  
  AddChildEntity(MyEntity)
  
  
  Declaration
  
    public void AddChildEntity(MyEntity child)
   
  Parameters
  
  
  
  
  AddToStationOreBlockTree(ref MyDynamicAABBTree, Vector3D, Single)
  
  
  Declaration
  
    public void AddToStationOreBlockTree(ref MyDynamicAABBTree stationOreBlockTree, Vector3D position, float radius)
   
  Parameters
  
  
  
  
  AfterPaste()
  
  
  Declaration
  
    public override void AfterPaste()
   
  Overrides
  
  
  
  
  BeforeDelete()
  
  
  Declaration
  
    protected override void BeforeDelete()
   
  Overrides
  
  
  
  
  BeforePaste()
  
  
  Declaration
  
    public override void BeforePaste()
   
  Overrides
  
  
  
  
  Closing()
  
  
  Declaration
  
    protected override void Closing()
   
  Overrides
  
  
  
  
  CorrectSpawnLocation(ref Vector3D, Double)
  
  
  Declaration
  
    public void CorrectSpawnLocation(ref Vector3D position, double radius)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3D | position |  | 
      
        | System.Double | radius |  | 
    
  
  
  
  
  CorrectSpawnLocation2(ref Vector3D, Double, Boolean)
  
  
  Declaration
  
    public bool CorrectSpawnLocation2(ref Vector3D position, double radius, bool resumeSearch = false)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3D | position |  | 
      
        | System.Double | radius |  | 
      
        | System.Boolean | resumeSearch | Don't modify initial search position | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | True if it a safe position is found | 
    
  
  
  
  
  DebugDrawPhysics()
  
  
  Declaration
  
    public override void DebugDrawPhysics()
   
  Overrides
  
  
  
  
  GetAirDensity(Vector3D)
  
  
  Declaration
  
    public float GetAirDensity(Vector3D worldPosition)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3D | worldPosition |  | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Single |  | 
    
  
  
  
  
  GetClosestSurfacePointGlobal(Vector3D)
  
  
  Declaration
  
    public Vector3D GetClosestSurfacePointGlobal(Vector3D globalPos)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3D | globalPos |  | 
    
  
  Returns
  
  
  
  
  GetClosestSurfacePointGlobal(ref Vector3D)
  
  
  Declaration
  
    public Vector3D GetClosestSurfacePointGlobal(ref Vector3D globalPos)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3D | globalPos |  | 
    
  
  Returns
  
  
  
  
  GetClosestSurfacePointLocal(ref Vector3)
  
  
  Declaration
  
    public Vector3D GetClosestSurfacePointLocal(ref Vector3 localPos)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3 | localPos |  | 
    
  
  Returns
  
  
  
  
  GetHeightFromSurface(Vector3D)
  
  
  Declaration
  
    public double GetHeightFromSurface(Vector3D position)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
  
  
  GetInstanceHash()
  
  
  Declaration
  
    public int GetInstanceHash()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
  
  
  GetObjectBuilder(Boolean)
  
  
  Declaration
  
    public override MyObjectBuilder_EntityBase GetObjectBuilder(bool copy = false)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Boolean | copy |  | 
    
  
  Returns
  
  Overrides
  
  
  
  
  GetOrePriority()
  
  
  Declaration
  
    public override int GetOrePriority()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  Overrides
  
  
  
  
  GetOxygenForPosition(Vector3D)
  
  
  Declaration
  
    public float GetOxygenForPosition(Vector3D worldPoint)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3D | worldPoint |  | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Single |  | 
    
  
  
  
  
  GetWindSpeed(Vector3D)
  
  
  Declaration
  
    public float GetWindSpeed(Vector3D worldPosition)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3D | worldPosition |  | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Single |  | 
    
  
  
  
  
  Init(MyPlanetInitArguments)
  
  
  Declaration
  
    public void Init(MyPlanetInitArguments arguments)
   
  Parameters
  
  
  
  
  Init(MyObjectBuilder_EntityBase)
  
  
  Declaration
  
    public override void Init(MyObjectBuilder_EntityBase builder)
   
  Parameters
  
  Overrides
  
  
  
  
  Init(MyObjectBuilder_EntityBase, IMyStorage)
  
  
  Declaration
  
    public override void Init(MyObjectBuilder_EntityBase builder, IMyStorage storage)
   
  Parameters
  
  Overrides
  
  
  
  
  IntersectsWithGravityFast(ref BoundingBoxD)
  
  
  Declaration
  
    public bool IntersectsWithGravityFast(ref BoundingBoxD boundingBox)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
  
  
  IsUnderGround(Vector3D)
  
  
  Declaration
  
    public bool IsUnderGround(Vector3D position)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
  
  
  OnAddedToScene(Object)
  
  
  Declaration
  
    public override void OnAddedToScene(object source)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Object | source |  | 
    
  
  Overrides
  
  
  
  
  OnRemovedFromScene(Object)
  
  
  Declaration
  
    public override void OnRemovedFromScene(object source)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Object | source |  | 
    
  
  Overrides
  
  
  
  
  PrefetchShapeOnRay(ref LineD, Boolean)
  Prefetch voxel physics and creates one if it don't exist
Declaration
  
    public bool PrefetchShapeOnRay(ref LineD ray, bool prefetchOnlyNew = false)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | LineD | ray |  | 
      
        | System.Boolean | prefetchOnlyNew | when true it starts shape prefetch only when voxel map was created | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
  
  
  RemoveChildEntity(MyEntity)
  
  
  Declaration
  
    public void RemoveChildEntity(MyEntity child)
   
  Parameters
  
  
  
  
  
  
  
  Declaration
  
    public static void RevertBoulder(MyBoulderInformation boulder)
   
  Parameters
  
  
  
  
  RevertBoulderBroadcast(Int64, Int64, Int32)
  
  
  Declaration
  
    [Event(null, 605)]
[Reliable]
[Broadcast]
public static void RevertBoulderBroadcast(long planetId, long sectorId, int itemId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Int64 | planetId |  | 
      
        | System.Int64 | sectorId |  | 
      
        | System.Int32 | itemId |  | 
    
  
  
  
  
  RevertBoulderServer(MyVoxelBase)
  
  
  Declaration
  
    public static void RevertBoulderServer(MyVoxelBase voxels)
   
  Parameters
  
  
  
  
  SetStationOreBlockTree(MyDynamicAABBTree)
  
  
  Declaration
  
    public void SetStationOreBlockTree(MyDynamicAABBTree tree)
   
  Parameters
  
  
  
  
  UpdateAfterSimulation10()
  
  
  Declaration
  
    public override void UpdateAfterSimulation10()
   
  Overrides
  
  
  
  
  UpdateAfterSimulation100()
  
  
  Declaration
  
    public override void UpdateAfterSimulation100()
   
  Overrides
  
  
  
  
  UpdateOnceBeforeFrame()
  
  
  Declaration
  
    public override void UpdateOnceBeforeFrame()
   
  Overrides
  
  Explicit Interface Implementations
  
  
  
  
  IMyOxygenProvider.IsPositionInRange(Vector3D)
  
  
  Declaration
  
    bool IMyOxygenProvider.IsPositionInRange(Vector3D worldPoint)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Vector3D | worldPoint |  | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  Implements
  
  
  
  
  
  Extension Methods