Space Engineers
Public Member Functions | Properties | List of all members
Sandbox.ModAPI.IMyGridProgram Interface Reference

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...

Inheritance diagram for Sandbox.ModAPI.IMyGridProgram:
Sandbox.ModAPI.Ingame.MyGridProgram

Public Member Functions

void Main (string argument)
 Invokes this grid program. More...
 
void Save ()
 If this grid program has state saving capability, calling this method will invoke it. More...
 

Properties

Ingame.IMyGridTerminalSystem GridTerminalSystem [get, set]
 Gets or sets the GridTerminalSystem available for the grid programs. More...
 
Ingame.IMyProgrammableBlock Me [get, set]
 Gets or sets the programmable block which is currently running this grid program. More...
 
TimeSpan ElapsedTime [get, set]
 Gets or sets the amount of time elapsed since the last time this grid program was run. More...
 
string Storage [get, set]
 Gets or sets the storage string for this grid program. More...
 
IMyGridProgramRuntimeInfo Runtime [get, set]
 Gets or sets the object used to provide runtime information for the running grid program. More...
 
Action< string > Echo [get, set]
 Gets or sets the action which prints out text onto the currently running programmable block's detail info area. More...
 
bool HasMainMethod [get]
 Determines whether this grid program has a valid Main method. More...
 
bool HasSaveMethod [get]
 Determines whether this grid program has a valid Save method. More...
 

Detailed Description

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.

Definition at line 10 of file IMyGridProgram.cs.

Member Function Documentation

void Sandbox.ModAPI.IMyGridProgram.Main ( string  argument)

Invokes this grid program.

Parameters
argument
void Sandbox.ModAPI.IMyGridProgram.Save ( )

If this grid program has state saving capability, calling this method will invoke it.

Property Documentation

Action<string> Sandbox.ModAPI.IMyGridProgram.Echo
getset

Gets or sets the action which prints out text onto the currently running programmable block's detail info area.

Definition at line 41 of file IMyGridProgram.cs.

TimeSpan Sandbox.ModAPI.IMyGridProgram.ElapsedTime
getset

Gets or sets the amount of time elapsed since the last time this grid program was run.

Definition at line 26 of file IMyGridProgram.cs.

Ingame.IMyGridTerminalSystem Sandbox.ModAPI.IMyGridProgram.GridTerminalSystem
getset

Gets or sets the GridTerminalSystem available for the grid programs.

Definition at line 15 of file IMyGridProgram.cs.

bool Sandbox.ModAPI.IMyGridProgram.HasMainMethod
get

Determines whether this grid program has a valid Main method.

Definition at line 46 of file IMyGridProgram.cs.

bool Sandbox.ModAPI.IMyGridProgram.HasSaveMethod
get

Determines whether this grid program has a valid Save method.

Definition at line 57 of file IMyGridProgram.cs.

Ingame.IMyProgrammableBlock Sandbox.ModAPI.IMyGridProgram.Me
getset

Gets or sets the programmable block which is currently running this grid program.

Definition at line 20 of file IMyGridProgram.cs.

IMyGridProgramRuntimeInfo Sandbox.ModAPI.IMyGridProgram.Runtime
getset

Gets or sets the object used to provide runtime information for the running grid program.

Definition at line 36 of file IMyGridProgram.cs.

string Sandbox.ModAPI.IMyGridProgram.Storage
getset

Gets or sets the storage string for this grid program.

Definition at line 31 of file IMyGridProgram.cs.


The documentation for this interface was generated from the following file: