Space Engineers
Namespaces | Classes | Enumerations | Functions
Package Sandbox.ModAPI

Namespaces

package  Ingame
 
package  Interfaces
 
package  Physics
 
package  Weapons
 

Classes

interface  IMyAdvancedDoor
 
interface  IMyAirtightDoorBase
 
interface  IMyAirtightHangarDoor
 
interface  IMyAirtightSlideDoor
 
interface  IMyAssembler
 
interface  IMyBatteryBlock
 
interface  IMyBeacon
 
interface  IMyBlockGroup
 
interface  IMyCameraBlock
 
interface  IMyCargoContainer
 
interface  IMyCockpit
 
interface  IMyCollector
 
interface  IMyConveyor
 
interface  IMyConveyorSorter
 
interface  IMyConveyorTube
 
interface  IMyCryoChamber
 
interface  IMyDecoy
 
interface  IMyDoor
 
interface  IMyExtendedPistonBase
 
interface  IMyFunctionalBlock
 
interface  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. More...
 
interface  IMyGridTerminalSystem
 
interface  IMyGyro
 
interface  IMyIngameScripting
 
interface  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. More...
 
interface  IMyJumpDrive
 
interface  IMyLargeTurretBase
 
interface  IMyLaserAntenna
 ModAPI laserantenna block interface More...
 
interface  IMyLightingBlock
 
interface  IMyMeteor
 
interface  IMyMotorAdvancedRotor
 
interface  IMyMotorAdvancedStator
 
interface  IMyMotorBase
 
interface  IMyMotorRotor
 
interface  IMyMotorStator
 
interface  IMyMotorSuspension
 
interface  IMyOreDetector
 
interface  IMyOxygenGenerator
 Oxygen generator interface More...
 
interface  IMyOxygenTank
 
interface  IMyPassage
 
interface  IMyPistonBase
 
interface  IMyPistonTop
 
interface  IMyProductionBlock
 
interface  IMyProgrammableBlock
 
interface  IMyProjector
 
interface  IMyRadioAntenna
 
interface  IMyReactor
 
interface  IMyRefinery
 
interface  IMyReflectorLight
 
interface  IMyRemoteControl
 
interface  IMyScriptBlacklist
 Exposes blacklist functionality to allow mods to disallow parts of the scripting API that has been allowed by the system whitelist. More...
 
interface  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. More...
 
interface  IMySensorBlock
 
interface  IMyShipConnector
 
interface  IMyShipController
 
interface  IMyShipDrill
 
interface  IMyShipGrinder
 
interface  IMyShipToolBase
 
interface  IMyShipWelder
 Ship welder interface More...
 
interface  IMySmallGatlingGun
 
interface  IMySmallMissileLauncher
 
interface  IMySmallMissileLauncherReload
 
interface  IMyTerminalActionsHelper
 
interface  IMyTerminalBlock
 
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. More...
 
interface  IMyTextPanel
 
interface  IMyThrust
 
interface  IMyUpgradableBlock
 interface to retrieve upgrade effects from block Ingame.IMyUpgradableBlock More...
 
interface  IMyUserControllableGun
 
interface  IMyWarhead
 
interface  IMyWheel
 
class  MyAPIGateway
 This is entry point for entire scripting possibilities in game
 
class  MyAPIUtilities
 
class  MyEntitiesHelper_ModAPI
 
class  MyGuiModHelpers
 
class  MyModAPIHelper
 
class  MyParallelTask
 
struct  MyProductionQueueItem
 
class  MyTerminalControlFactoryHelper
 

Enumerations

enum  BuildCheckResult {
  BuildCheckResult.OK, BuildCheckResult.NotConnected, BuildCheckResult.IntersectedWithGrid, BuildCheckResult.IntersectedWithSomethingElse,
  BuildCheckResult.AlreadyBuilt, BuildCheckResult.NotFound
}
 
enum  MyWhitelistTarget { MyWhitelistTarget.None, MyWhitelistTarget.ModApi = 0x1, MyWhitelistTarget.Ingame = 0x2, MyWhitelistTarget.Both = ModApi | Ingame }
 Determines what target a whitelisting entry does or should support. More...
 

Functions

delegate void CustomControlGetDelegate (IMyTerminalBlock block, List< IMyTerminalControl > controls)
 Allows you to modify the terminal control list before it is displayed to the user. Modifying controls will change which controls are displayed. More...
 
delegate void CustomActionGetDelegate (IMyTerminalBlock block, List< IMyTerminalAction > actions)
 Allows you to modify the actions associated with a block before it's displayed to user. More...
 

Enumeration Type Documentation

Enumerator
OK 
NotConnected 
IntersectedWithGrid 
IntersectedWithSomethingElse 
AlreadyBuilt 
NotFound 

Definition at line 5 of file IMyProjector.cs.

Determines what target a whitelisting entry does or should support.

Enumerator
None 

No target. Depending on the context, this may mean no support at all or unrestricted support.

ModApi 

The entry supports or must support ModAPI level entry.

Ingame 

The entry supports or must support Ingame level entry.

Both 

A shortcut flag meaning the entry supports or must support both ModAPI and Ingame level entries.

Definition at line 9 of file MyWhitelistTarget.cs.

Function Documentation

delegate void Sandbox.ModAPI.CustomActionGetDelegate ( IMyTerminalBlock  block,
List< IMyTerminalAction actions 
)

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

Parameters
blockThe block actions are associated with
actionsThe list of actions for this block
delegate void Sandbox.ModAPI.CustomControlGetDelegate ( IMyTerminalBlock  block,
List< IMyTerminalControl controls 
)

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

Parameters
blockThe block that was selected
controls