Skip to content

Api Index

Morten Aune Lyrstad edited this page Sep 2, 2023 · 36 revisions

Namespace Index

This index contains all types and members available to ingame scripting - with exception to the .NET types, because including those would have made the listing far too big. There will be links to Microsoft's own documentation for those types where appropriate.

Blocks

Use these interfaces when you wish to access specific block types.

IMyAdvancedDoor
IMyAirtightHangarDoor
IMyAirtightSlideDoor
IMyAirVent
IMyArtificialMassBlock
IMyAssembler
IMyBasicMissionBlock
IMyBatteryBlock
IMyBeacon
IMyButtonPanel
IMyCameraBlock
IMyCargoContainer
IMyCollector
IMyControlPanel
IMyConveyorSorter
IMyCryoChamber
IMyDecoy
IMyDefensiveCombatBlock
IMyEmotionControllerBlock
IMyEventControllerBlock
IMyExtendedPistonBase
IMyFlightMovementBlock
IMyGasTank
IMyGravityGenerator
IMyGravityGeneratorSphere
IMyGyro
IMyHeatVent
IMyInteriorLight
IMyJumpDrive
IMyLandingGear
IMyLargeGatlingTurret
IMyLargeInteriorTurret
IMyLargeMissileTurret
IMyLaserAntenna
IMyMedicalRoom
IMyMotorAdvancedStator
IMyMotorSuspension
IMyOffensiveCombatBlock
IMyOreDetector
IMyOxygenFarm
IMyParachute
IMyPathRecorderBlock
IMyProgrammableBlock
IMyProjector
IMyRadioAntenna
IMyReactor
IMyRefinery
IMyReflectorLight
IMyRemoteControl
IMySafeZoneBlock
IMySearchlight
IMySensorBlock
IMyShipConnector
IMyShipDrill
IMyShipGrinder
IMyShipMergeBlock
IMyShipWelder
IMySmallGatlingGun
IMySmallMissileLauncherReload
IMySolarPanel
IMySoundBlock
IMySpaceBall
IMyStoreBlock
IMyTargetDummyBlock
IMyTextPanel
IMyThrust
IMyTimerBlock
IMyTurretControlBlock
IMyUpgradeModule
IMyVirtualMass
IMyWarhead
IMyWindTurbine

Block Categories

Use these interfaces when you wish to access blocks by a specific function or category rather than a specific block type.

IMyAirtightDoorBase
IMyCockpit
IMyDoor
IMyFunctionalBlock
IMyGasGenerator
IMyGravityGeneratorBase
IMyLargeConveyorTurretBase
IMyLargeTurretBase
IMyLightingBlock
IMyMechanicalConnectionBlock
IMyMotorBase
IMyMotorStator
IMyPistonBase
IMyPowerProducer
IMyProductionBlock
IMyShipController
IMyShipToolBase
IMySmallMissileLauncher
IMyTerminalBlock
IMyUserControllableGun

Utilities

Various useful utilities for your scripts

MyCommandLine
MyCommandLine.Enumerator
MyCommandLine.ItemCollection
MyCommandLine.SwitchCollection
MyCommandLine.SwitchEnumerator
MyIni
MyIniKey
MyIniParseResult
MyIniValue
StringSegment
StringSegmentComparer
StringSegmentIgnoreCaseComparer
TextPtr

Grid Program and Terminal System

Types related to the grid program and grid terminal system

IMyBlockGroup
IMyCubeBlock
IMyCubeGrid
IMyGridProgramRuntimeInfo
IMyGridTerminalSystem
IMySlimBlock
MyGridProgram
UpdateFrequency
UpdateType

Entity Component Systems

Gain access to advanced block components

MyComponentBase
MyComponentContainer
MyResourceSinkComponent
MyResourceSinkComponentBase
MyResourceSourceComponent
MyResourceSourceComponentBase

IGC

Types related to the intergrid communication system.

IMyBroadcastListener
IMyIntergridCommunicationSystem
IMyMessageProvider
IMyUnicastListener
TransmissionDistance

Inventory

Types related to inventory analysis and management.

IMyInventory
MyInventoryItem
MyItemInfo

Terminal Properties and Actions

Types related to the terminal properties and actions. You should endeavor to avoid the use of these if possible due to their extra overhead. There are usually proper interface members available instead, which are orders of magnitude faster in use.

ITerminalAction
ITerminalProperty
ITerminalProperty<TValue>
TerminalActionExtensions
TerminalActionParameter

Math

Math utilities

Base27Directions
Base27Directions.Direction
Base6Directions
Base6Directions.Axis
Base6Directions.Direction
Base6Directions.DirectionFlags
BoundingBox
BoundingBox.ComparerType
BoundingBox2
BoundingBox2D
BoundingBox2I
BoundingBoxD
BoundingBoxD.ComparerType
BoundingBoxExtensions
BoundingBoxI
BoundingFrustum
BoundingFrustumD
BoundingFrustumExtensions
BoundingSphere
BoundingSphereD
BoxCornerEnumerator
BoxCornerEnumerator.<m_minMax>e__FixedBuffer
Capsule
CapsuleD
Color
ColorExtensions
CompressedPositionOrientation
ContainmentType
CubeFace
Curve
CurveContinuity
CurveKey
CurveKeyCollection
CurveLoopType
CurveTangent
HyperSphereHelpers
IAddOp<T>
Line
LineD
MathHelper
MathHelperD
Matrix
Matrix3x3
MatrixD
MatrixI
MyBlockOrientation
MyBounds
MyCuboid
MyCuboidSide
MyDynamicAABBTree
MyDynamicAABBTree.DynamicTreeNode
MyDynamicAABBTreeD
MyLineSegmentOverlapResult<T>
MyLineSegmentOverlapResult<T>.MyLineSegmentOverlapResultComparer<T>
MyMath
MyMortonCode3D
MyMovingAverage
MyOrientedBoundingBox
MyOrientedBoundingBoxD
MyQuad
MyQuadD
MyShort4
MyTransform
MyTransformD
MyUShort4
NullableVector3DExtensions
NullableVector3Extensions
Plane
PlaneD
PlaneIntersectionType
Point
Quaternion
QuaternionD
Ray
RayD
Rectangle
RectangleF
SerializableRange
SymmetricSerializableRange
Vector2
Vector2B
Vector2D
Vector2I
Vector2I.ComparerClass
Vector3
Vector3B
Vector3D
Vector3Extensions
Vector3I
Vector3I.EqualityComparer
Vector3I_RangeIterator
Vector3INormalEqualityComparer
Vector3L
Vector3L.EqualityComparer
Vector3L_RangeIterator
Vector3LNormalEqualityComparer
Vector3S
Vector3UByte
Vector3UByte.EqualityComparer
Vector3Ushort
Vector4
Vector4D
Vector4I
Vector4I.EqualityComparer
Vector4UByte

Other

Currently ungrouped types

ArrayExtensions
ChargeMode
ClearToken<T>
ContentType
DictionaryExtensions
DoorStatus
FleeMode
FleeTrigger
FlightMode
GuidanceType
HashSetExtensions
IMyAttachableTopBlock
IMyAttackPatternComponent
IMyAutopilotWaypoint
IMyBasicMissionComponent
IMyBasicMissionFollowHome
IMyBasicMissionFollowPlayer
IMyConveyor
IMyConveyorTube
IMyEntity
IMyInventoryItem
IMyInventoryOwner
IMyMotorAdvancedRotor
IMyMotorRotor
IMyOffensiveCombatCircleOrbit
IMyOffensiveCombatHitAndRun
IMyOffensiveCombatIntercept
IMyOffensiveCombatStayAtRange
IMyPassage
IMyPathRecorderComponent
IMyPistonTop
IMySearchEnemyComponent
IMyTextSurface
IMyTextSurfaceProvider
IMyUpgradableBlock
IMyWheel
LandingGearMode
ListExtensions
ListReader<T>
MergeState
MyAssemblerMode
MyConveyorSorterMode
MyCubeSize
MyDefinitionId
MyDefinitionId.DefinitionIdComparerType
MyDetectedEntityInfo
MyDetectedEntityType
MyFixedPoint
MyGridTargetingRelationFiltering
MyIGCMessage
MyInventoryItemExtension
MyInventoryItemFilter
MyItemType
MyJumpDriveStatus
MyLanguagesEnum
MyLaserAntennaStatus
MyObjectBuilder_Base
MyObjectBuilder_GasProperties
MyPhysicalInventoryItemExtensions_ModAPI
MyPlanetElevation
MyProductionItem
MyRelationsBetweenPlayerAndBlock
MyRelationsBetweenPlayerAndBlockExtensions
MySerializableSprite
MySerializableSpriteCollection
MyShipConnectorStatus
MyShipMass
MyShipVelocities
MySpaceTexts
MySprite
MySpriteCollection
MySpriteDrawFrame
MySpriteDrawFrame.ClearClipToken
MyStoreInsertResults
MyStoreItemDataSimple
MyStoreQueryItem
MyTerminalAccessScope
MyTexts
MyTexts.MyLanguageDescription
MyTransmitTarget
MyTuple
MyTuple<T1, T2, T3, T4, T5, T6>
MyTuple<T1, T2, T3, T4, T5>
MyTuple<T1, T2, T3, T4>
MyTuple<T1, T2, T3>
MyTuple<T1, T2>
MyTuple<T1>
MyTupleComparer<T1, T2, T3>
MyTupleComparer<T1, T2>
MyWaypointInfo
OffensiveCombatTargetPriority
PistonStatus
QueueExtensions
SerializableDefinitionId
ShowTextOnScreenFlag
SpriteType
StringBuilderExtensions_Format
TargetingGroupOptions
TerminalBlockExtentions
TerminalPropertyExtensions
TextAlignment
TextPanelAccessFlag
VentStatus

Obsolete

These types should no longer be used and may be removed in the future. If you're using one of these types, you should replace them as soon as possible.

IMyOxygenGenerator

Clone this wiki locally