IMyGridProgram Interface

v01.180.0 (Beta)

[This is preliminary documentation and is subject to change.]

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.

Namespace: Sandbox.ModAPI
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public interface IMyGridProgram

Public Interface IMyGridProgram

public interface class IMyGridProgram

type IMyGridProgram =  interface end

The IMyGridProgram type exposes the following members.

Methods

	Name	Description
	Main	Invokes this grid program.
	Save	If this grid program has state saving capability, calling this method will invoke it.

Properties

	Name	Description
	Echo	Gets or sets the action which prints out text onto the currently running programmable block's detail info area.
	ElapsedTime	Obsolete. Gets or sets the amount of time elapsed since the last time this grid program was run.
	GridTerminalSystem	Gets or sets the GridTerminalSystem available for the grid programs.
	HasMainMethod	Determines whether this grid program has a valid Main method.
	HasSaveMethod	Determines whether this grid program has a valid Save method.
	Me	Gets or sets the programmable block which is currently running this grid program.
	Runtime	Gets or sets the object used to provide runtime information for the running grid program.
	Storage	Gets or sets the storage string for this grid program.