Namespace Sandbox.ModAPI

Classes

BuildCheckResult

Describes build check results

CustomActionGetDelegate

Allows you to modify the actions associated with a block before it's displayed to user.

CustomControlGetDelegate

Allows you to modify the terminal control list before it is displayed to the user. Modifying controls will change which controls are displayed.

HitInterceptor

Provide information about projectiles hit.

MissileMoveDelegate

Missile Move delegate

MyAPIGateway

This is entry point for entire scripting possibilities in game

MyAPIUtilities

MyAutopilotPathfindingState

Describes state of autopilot pathfinding

MyEntitiesHelper_ModAPI

MyExplosionTypeEnum

Enum defining which sound and effect would be played on explosion trigger

MyGuiModHelpers

MyModAPIHelper

MyModAPIHelper.MyMultiplayer

MyProductionQueueItem

Describes item in queue of production block (PB scripting interface)(mods interface)

MyProjectileHitInfo

Describes information projectile about projectile hit. (mods interface) You can change values

MyProjectileInfo

Implements read-only info about existing projectile

MySurfaceImpactEnum

Enum describes which surface projectile hit

MyTerminalControlFactoryHelper

MyTerminalInterfaceAttribute

Used on block classes inheriting MyTerminalBlock. Attribute tells the terminal system which interface types should be linked to this class.

MyVRageIngameScriptingAdapter

Allows mods change programmable block script settings

OnProjectileAddedRemoved

Index is used to get position of projectile Projectile can change it index, when it's index == projectilesCount - 1

Interfaces

IMyAdvancedDoor

Describes advanced door block (mods interface)

IMyAiBlockComponent

Describes AI block activator entity component. This entity component turns on/off AI Behavior.

IMyAirtightDoorBase

Describes airtight door block (mods interface)

IMyAirtightHangarDoor

Describes hangar door block (mods interface)

IMyAirtightSlideDoor

Describes air tight slide block (mods interface)

IMyAiRvoSessionComponent

Describes AI RVO (Collision Avoidance) session component for dynamic grids

IMyAssembler

Describes assembler block (PB scripting interface)

IMyAttachableTopBlock

Describes rotor,piston or wheel suspension attachable block (mods interface)

IMyAttackPatternComponent

Describes entity component for AttackPattern of offensive combat block

IMyBasicMissionAutopilot

Describes autopilot mission for the Basic AI block

IMyBasicMissionBlock

Describes basic mission block (mods interface)

IMyBasicMissionComponent

Describes entity component interface for basic mission (Basic AI block)

IMyBasicMissionFollowHome

Describes follow home mission for Basic AI block

IMyBasicMissionFollowPlayer

Describes follow player mission for Basic AI block

IMyBatteryBlock

Describes battery block (mods interface)

IMyBeacon

Describes beacon block interface

IMyBlockGroup

Describes terminal block group (mods interface)

IMyCameraBlock

Describes Camera block (mods interface)

IMyCargoContainer

Describes Cargo Container block (mods interface)

IMyCockpit

Describes cockpit block (mods interface)

IMyCollector

Describes collector block (mods interface)

IMyConveyor

Describes conveyor block (mods interface)

IMyConveyorSorter

Describes conveyor sorter block (mods interface)

IMyConveyorTube

Describes conveyor tube block (mods interface)

IMyCryoChamber

Describes cryo chamber block (mods interface)

IMyDecoy

Describes decoy block (mods interface)

IMyDefensiveCombatBlock

Describes defensive combat block (mods interface) All logic is done on server, so dont use that api on client

IMyDistanceToLockedTarget

Describes distance to locked target interface for block, which is able to target lock

IMyDoor

Describes door block (mods interface)

IMyEmotionControllerBlock

Describes EmotionControllerBlock interface

IMyEventComponentWithGui

Describes interface of event controller entity component, which requires UI in the terminal panel

IMyEventControllerBlock

Describes Event Controller Block

IMyEventControllerEntityComponent

Describes entity component for event controller with custom UI

IMyExhaustBlock

Describes exhaust block (mods interface)

IMyExtendedPistonBase

Describes piston block (mods interface)

IMyFlightMovementBlock

Describes flight movement block (mods interface)

IMyFunctionalBlock

Describes functional block (block with Enabled/Disabled toggle) (mods interface)

IMyGasGenerator

Gas generator interface (mods interface)

IMyGasTank

Describes gas tank block (mods interface)

IMyGlobalEncounterComponent

Describes entity component used for global encounters grids

IMyGridProgram

The interface for the grid program provides extra access for the game and for mods. See MyGridProgram for the class the scripts actually derive from.

IMyGridTerminalSystem

Describes grid terminal system interface

IMyGyro

Describes gyro block interface

IMyIngameScripting

Allows mods change programmable block script settings

IMyInventoryBag

Inventory bag spawned when character died, container breaks, or when entity from other inventory cannot be spawned then bag spawned with the item in its inventory.

IMyJumpDrive

Describes jump drive block (mods interface)

IMyLargeTurretBase

Describes turret block (mods interface)

IMyLaserAntenna

Describes laser antenna block interface (mods interface)

IMyLcdSurfaceComponent

Describes LCD surface entity component.

IMyLightingBlock

Describes lighting block (mods interface)

IMyMechanicalConnectionBlock

Describes blocks linked with Mechanical connection (mods interface)

IMyMeteor

Describes meteor entity (mods interface)

IMyMissile

Describes missile entity (mods interface)

IMyMissiles

Interface for controlling missiles

IMyMotorAdvancedRotor

Describes advanced motor rotor (mods interface)

IMyMotorAdvancedStator

Describes advanced motor stator (mods interface)

IMyMotorBase

Describes base class for motor, advanced rotor and motor suspension block (mods interface)

IMyMotorRotor

Describes motor rotor (mods interface)

IMyMotorStator

Describes base class for motor, advanced rotor and motor suspension block (mods interface)

IMyMotorSuspension

Describes motor suspension block (mods interface)

IMyNPCGridClaimSessionComponent

Session for maintaining info about claims on npc grids

IMyOffensiveCombatBlock

Describes offensive combat block (mods interface)

IMyOffensiveCombatCircleOrbit

Describes circle orbit attack pattern of offensive combat block

IMyOffensiveCombatHitAndRun

Describes entity component for AttackPattern of offensive combat block

IMyOffensiveCombatIntercept

Describes entity component for AttackPattern of offensive combat block

IMyOffensiveCombatStayAtRange

Describes entity component for AttackPattern of offensive combat block

IMyOreDetector

Describes ore detector block (mods interface)

IMyPassage

Describes passage block (mods interface)

IMyPathfindingSessionComponent

Describes pathfinding session component

IMyPathRecorderBlock

PathRecorder interface

IMyPathRecorderComponent

Interface for modding PathRecorderComponent

IMyPistonBase

Describes piston block (mods interface)

IMyPistonTop

Describes piston top block (movable part) (mods interface)

IMyPowerProducer

Describes power producer block (mods interface)

IMyProductionBlock

Describes production blocks : refinery block, assembler block, survival kit block. (mods interface)

IMyProgrammableBlock

Describes programmable block (mods interface)

IMyProjectileDetector

Describes projectile that have custom logic on handling bullets (mods interface)

IMyProjectiles

Interface for controlling projectile behavior (mods interface)

IMyProjector

Describes projector block (mods interface)

IMyRadioAntenna

Describes radio antenna block interface

IMyRandomCargoEntityComponent

Describes entity component MyRandomCargoEntityComponent

IMyReactor

Describes reactor block (mods interface)

IMyRefinery

Describes assembler block (mods interface)

IMyReflectorLight

Describes spotlight block (mods interface)

IMyRemoteControl

Describes remote control block (mods interface)

IMyRespawnComponent

IMyScriptBlacklist

Exposes blacklist functionality to allow mods to disallow parts of the scripting API that has been allowed by the system whitelist.

IMyScriptBlacklistBatch

A handle which enables adding members to the blacklist in a batch. It is highly recommended that you try to group your changes into as few batches as possible.

IMySearchEnemyComponent

Describes component that can find enemy grids and characters in range

IMySearchlight

Describes Searchlight (mods interface)

IMySensorBlock

Describes sensor block (mods interface)

IMyShipConnector

Describes connector block (mods interface)

IMyShipController

Describes ship controller block (cockpit/remote control/cryopod) (mods interface)

IMyShipDrill

Describes ship drill block (mods interface)

IMyShipGrinder

Describes ship grinder block (mods interface)

IMyShipToolBase

Describes ship tool block (drill/grinder/welder) (mods interface)

IMyShipWelder

Describes ship welder interface (mods interface)

IMyShootOrigin

Interface describing part of weapon block logic Used in detection if target is visible

IMySignalReceiverEntityComponent

Describes entity component for triggering toolbar-defined actions when receiving a signal

IMySignalSenderEntityComponent

Describes entity component for sending a signal to appropriate receivers

IMySmallGatlingGun

Describes gatling gun (mods interface)

IMySmallMissileLauncher

Describes missile launcher block (mods interface)

IMySmallMissileLauncherReload

Describes reloadable missile block (mods interface)

IMyStoreBlock

Describes store block (mods interface)

IMyStoredPowerRatio

Describes stored power ration interface for block, which are storing power

IMyTargetDummyBlock

Describes target dummy block (mods interface)

IMyTargetingCapableBlock

Describes block that can target (cockpits and turrets) (mods interface)

IMyTerminalActionsHelper

API class for interactions with terminal actions and properties

IMyTerminalBlock

Describes assembler block (mods interface)

IMyTerminalControls

This interface allows you to query, add or remove terminal controls for a block. The terminal controls are the controls that appear in the terminal screen when you select a block. You may add new controls, remove existing controls, or modify existing controls.

IMyTextPanel

Describes text panel block (mods interface)

IMyTextSurface

Describes one of block LCDs where you can write text or draw things (mods interface)

IMyTextSurfaceProvider

Describes block, that has at least 1 text surface (mods interface)

IMyThrust

Describes assembler block (mods interface)

IMyUpgradableBlock

Describes block, which has upgrade effects from block IMyUpgradableBlock (PB scripting interface)

IMyUpgradeModule

Describes upgrade module block (mods interface) IMyUpgradeModule

IMyUserControllableGun

Describes gun block (mods interface)

IMyVendingMachine

Describes vending machine block (mods interface)

IMyWarhead

Describes warhead block (mods interface)

IMyWheel

Describes wheel block (mods interface)

IMyWindTurbine

Describes wind turbine block (mod interface)

IMyWorkAreaTool

Describes tool used by work area component