Class MyAPIGateway

This is entry point for entire scripting possibilities in game

Inheritance

System.Object

MyAPIGateway

Namespace: Sandbox.ModAPI

Assembly: Sandbox.Common.dll

Syntax

public static class MyAPIGateway : Object

Fields

ContractSystem

IMyContractSystem allows you add or edit contracts

Declaration

public static IMyContractSystem ContractSystem

Field Value

Type	Description
IMyContractSystem

CubeBuilder

IMyCubeBuilder represents building hand

Declaration

public static IMyCubeBuilder CubeBuilder

Field Value

Type	Description
IMyCubeBuilder

DLC

Provides access for checking installation state of DLCs, and if DLC required by a definition is present.

Declaration

public static IMyDLCs DLC

Field Value

Type	Description
IMyDLCs

GravityProviderSystem

Provides access to gravity control

Declaration

public static IMyGravityProviderSystem GravityProviderSystem

Field Value

Type	Description
IMyGravityProviderSystem

GridGroups

Provides access to the Grid Group system

Declaration

public static IMyGridGroups GridGroups

Field Value

Type	Description
IMyGridGroups

Gui

IMyGui exposes some useful values from the GUI systems

Declaration

public static IMyGui Gui

Field Value

Type	Description
IMyGui

GuiControlCreated

Obsolete

Declaration

public static Action<object> GuiControlCreated

Field Value

Type	Description
System.Action<System.Object>

IngameScripting

Provides mod access to control compilation of ingame scripts

Declaration

public static IMyIngameScripting IngameScripting

Field Value

Type	Description
IMyIngameScripting

Input

IMyInput allows accessing direct input device states

Declaration

public static IMyInput Input

Field Value

Type	Description
VRage.ModAPI.IMyInput

Missiles

Interface for controlling missiles

Declaration

public static IMyMissiles Missiles

Field Value

Type	Description
IMyMissiles

Multiplayer

IMyMultiplayer contains multiplayer related things

Declaration

public static IMyMultiplayer Multiplayer

Field Value

Type	Description
IMyMultiplayer

Parallel

IMyParallelTask allows to run tasks on background threads

Declaration

public static IMyParallelTask Parallel

Field Value

Type	Description
IMyParallelTask

Physics

IMyPhysics contains physics related things (CastRay, etc.)

Declaration

public static IMyPhysics Physics

Field Value

Type	Description
IMyPhysics

Players

IMyPlayerCollection contains all players that are in world

Declaration

public static IMyPlayerCollection Players

Field Value

Type	Description
IMyPlayerCollection

PrefabManager

Allows you spawn prefabs

Declaration

public static IMyPrefabManager PrefabManager

Field Value

Type	Description
IMyPrefabManager

Projectiles

Interface for controlling projectile behavior

Declaration

public static IMyProjectiles Projectiles

Field Value

Type	Description
IMyProjectiles

Reflection

Allows you to use some reflection tools

Declaration

public static IMyReflection Reflection

Field Value

Type	Description
IMyReflection

SpectatorTools

Gives you access to spectator tools.

Declaration

public static IMySpectatorTools SpectatorTools

Field Value

Type	Description
IMySpectatorTools

TerminalActionsHelper

IMyTerminalActionsHelper is helper for terminal actions and allows to access terminal

Declaration

public static IMyTerminalActionsHelper TerminalActionsHelper

Field Value

Type	Description
IMyTerminalActionsHelper

TerminalControls

IMyTerminalControls allows access to adding and removing controls from a block's terminal screen

Declaration

public static IMyTerminalControls TerminalControls

Field Value

Type	Description
IMyTerminalControls

Utilities

IMyUtilities contains mainly I/O, serialization, mod interaction functions

Declaration

public static IMyUtilities Utilities

Field Value

Type	Description
IMyUtilities

Properties

Entities

IMyEntities represents all objects that currently in world

Declaration

public static IMyEntities Entities { get; set; }

Property Value

Type	Description
IMyEntities

Session

IMySession represents session object e.g. current world and its settings

Declaration

public static IMySession Session { get; set; }

Property Value

Type	Description
IMySession

Methods

Clean()

Obsolete

Declaration

public static void Clean()

DoorBase(String)

Obsolete

Declaration

public static StringBuilder DoorBase(string name)

Parameters

Type	Name	Description
System.String	name	obsolete

Returns

Type	Description
System.Text.StringBuilder

GetMessageBoxPointer(ref IntPtr)

Obsolete

Declaration

public static void GetMessageBoxPointer(ref IntPtr pointer)

Parameters

Type	Name	Description
System.IntPtr	pointer	Obsolete