Show / Hide Table of Contents

Class MyProceduralLogicalSector

Inheritance
System.Object
MyLogicalEnvironmentSectorBase
MyProceduralLogicalSector
Inherited Members
MyLogicalEnvironmentSectorBase.Id
MyLogicalEnvironmentSectorBase.WorldPos
MyLogicalEnvironmentSectorBase.Bounds
MyLogicalEnvironmentSectorBase.Owner
MyLogicalEnvironmentSectorBase.MinLod
MyLogicalEnvironmentSectorBase.OnClose
Namespace: Sandbox.Game.WorldEnvironment
Assembly: Sandbox.Game.dll
Syntax
public class MyProceduralLogicalSector : MyLogicalEnvironmentSectorBase, IMyEventProxy, IMyEventOwner

Constructors

MyProceduralLogicalSector(MyProceduralEnvironmentProvider, Int32, Int32, Int32, MyObjectBuilder_ProceduralEnvironmentSector)

Declaration
public MyProceduralLogicalSector(MyProceduralEnvironmentProvider provider, int x, int y, int localLod, MyObjectBuilder_ProceduralEnvironmentSector moduleData)
Parameters
Type Name Description
MyProceduralEnvironmentProvider provider
System.Int32 x
System.Int32 y
System.Int32 localLod
Sandbox.Game.WorldEnvironment.ObjectBuilders.MyObjectBuilder_ProceduralEnvironmentSector moduleData

Properties

DebugData

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

ServerOwned

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

Methods

AddView(MyProceduralDataView, Vector3D, Int32)

Declaration
public void AddView(MyProceduralDataView view, Vector3D localOrigin, int logicalLod)
Parameters
Type Name Description
MyProceduralDataView view
Vector3D localOrigin
System.Int32 logicalLod

Close()

Declaration
public override void Close()
Overrides
MyLogicalEnvironmentSectorBase.Close()

DebugDraw(Int32)

Declaration
public override void DebugDraw(int lod)
Parameters
Type Name Description
System.Int32 lod
Overrides
MyLogicalEnvironmentSectorBase.DebugDraw(Int32)

DisableItemsInBox(Vector3D, ref BoundingBoxD)

Declaration
public override void DisableItemsInBox(Vector3D center, ref BoundingBoxD box)
Parameters
Type Name Description
Vector3D center
BoundingBoxD box
Overrides
MyLogicalEnvironmentSectorBase.DisableItemsInBox(Vector3D, ref BoundingBoxD)

EnableItem(Int32, Boolean)

Declaration
public override void EnableItem(int itemId, bool enabled)
Parameters
Type Name Description
System.Int32 itemId
System.Boolean enabled
Overrides
MyLogicalEnvironmentSectorBase.EnableItem(Int32, Boolean)

GetItem(Int32, out ItemInfo)

Declaration
public override void GetItem(int logicalItem, out ItemInfo item)
Parameters
Type Name Description
System.Int32 logicalItem
ItemInfo item
Overrides
MyLogicalEnvironmentSectorBase.GetItem(Int32, out ItemInfo)

GetItemDefinition(UInt16, out MyRuntimeEnvironmentItemInfo)

Declaration
public override void GetItemDefinition(ushort key, out MyRuntimeEnvironmentItemInfo it)
Parameters
Type Name Description
System.UInt16 key
Sandbox.Game.WorldEnvironment.Definitions.MyRuntimeEnvironmentItemInfo it
Overrides
MyLogicalEnvironmentSectorBase.GetItemDefinition(UInt16, out MyRuntimeEnvironmentItemInfo)

GetItemDefinitionId(Int32)

Declaration
public override int GetItemDefinitionId(int itemId)
Parameters
Type Name Description
System.Int32 itemId
Returns
Type Description
System.Int32
Overrides
MyLogicalEnvironmentSectorBase.GetItemDefinitionId(Int32)

GetItemsInAabb(ref BoundingBoxD, List<Int32>)

Declaration
public override void GetItemsInAabb(ref BoundingBoxD aabb, List<int> itemsInBox)
Parameters
Type Name Description
BoundingBoxD aabb
System.Collections.Generic.List<System.Int32> itemsInBox
Overrides
MyLogicalEnvironmentSectorBase.GetItemsInAabb(ref BoundingBoxD, List<Int32>)

GetObjectBuilder()

Declaration
public override MyObjectBuilder_EnvironmentSector GetObjectBuilder()
Returns
Type Description
Sandbox.Game.WorldEnvironment.ObjectBuilders.MyObjectBuilder_EnvironmentSector
Overrides
MyLogicalEnvironmentSectorBase.GetObjectBuilder()

Init(MyObjectBuilder_EnvironmentSector)

Declaration
public override void Init(MyObjectBuilder_EnvironmentSector sectorBuilder)
Parameters
Type Name Description
Sandbox.Game.WorldEnvironment.ObjectBuilders.MyObjectBuilder_EnvironmentSector sectorBuilder
Overrides
MyLogicalEnvironmentSectorBase.Init(MyObjectBuilder_EnvironmentSector)

InvalidateItem(Int32)

Declaration
public override void InvalidateItem(int itemId)
Parameters
Type Name Description
System.Int32 itemId
Overrides
MyLogicalEnvironmentSectorBase.InvalidateItem(Int32)

IterateItems(MyLogicalEnvironmentSectorBase.ItemIterator)

Declaration
public override void IterateItems(MyLogicalEnvironmentSectorBase.ItemIterator action)
Parameters
Type Name Description
MyLogicalEnvironmentSectorBase.ItemIterator action
Overrides
MyLogicalEnvironmentSectorBase.IterateItems(MyLogicalEnvironmentSectorBase.ItemIterator)

RaiseItemEvent<TModule>(Int32, Object, Boolean)

Raise event from a storage module.

Can be either a client event to server (fromClient = true) or a broadcast of a server event to all clients with this logical sector (fromClient = false).

Declaration
public void RaiseItemEvent<TModule>(int logicalItem, object eventData, bool fromClient = false)
    where TModule : IMyEnvironmentModule
Parameters
Type Name Description
System.Int32 logicalItem

Logical item Id

System.Object eventData

Data to send along with the event.

System.Boolean fromClient

Weather this event comes from client to server or server to all clients.

Type Parameters
Name Description
TModule

Type of the storage module to notify

RaiseItemEvent<T>(Int32, ref MyDefinitionId, T, Boolean)

Declaration
public override void RaiseItemEvent<T>(int logicalItem, ref MyDefinitionId modDef, T eventData, bool fromClient)
Parameters
Type Name Description
System.Int32 logicalItem
MyDefinitionId modDef
T eventData
System.Boolean fromClient
Type Parameters
Name Description
T
Overrides
Sandbox.Game.WorldEnvironment.MyLogicalEnvironmentSectorBase.RaiseItemEvent<T>(System.Int32, VRage.Game.MyDefinitionId, T, System.Boolean)

ReenableItem(Int32)

Declaration
public void ReenableItem(int itemId)
Parameters
Type Name Description
System.Int32 itemId

RemoveView(MyProceduralDataView)

Declaration
public void RemoveView(MyProceduralDataView view)
Parameters
Type Name Description
MyProceduralDataView view

RevalidateItem(Int32)

Declaration
public override void RevalidateItem(int itemId)
Parameters
Type Name Description
System.Int32 itemId
Overrides
MyLogicalEnvironmentSectorBase.RevalidateItem(Int32)

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

UpdateItemModel(Int32, Int16)

Declaration
public override void UpdateItemModel(int itemId, short modelId)
Parameters
Type Name Description
System.Int32 itemId
System.Int16 modelId
Overrides
MyLogicalEnvironmentSectorBase.UpdateItemModel(Int32, Int16)

UpdateItemModelBatch(List<Int32>, Int16)

Declaration
public override void UpdateItemModelBatch(List<int> itemIds, short newModelId)
Parameters
Type Name Description
System.Collections.Generic.List<System.Int32> itemIds
System.Int16 newModelId
Overrides
MyLogicalEnvironmentSectorBase.UpdateItemModelBatch(List<Int32>, Int16)

Events

OnViewerEmpty

Declaration
public event Action<MyProceduralLogicalSector> OnViewerEmpty
Event Type
Type Description
System.Action<MyProceduralLogicalSector>
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾