Sandbox.ModAPI
IMyTextSurface
Assembly: Sandbox.Common.dll
public interface IMyTextSurface: IMyTextSurface
Describes one of block LCDs where you can write text or draw things (mods interface)
Properties
| Member | Description |
|---|---|
| Alignment | How should the text be aligned Inherited from IMyTextSurface |
| BackgroundAlpha | Value for offscreen texture alpha channel - for PBR material it is metalness (should be 0) - for transparent texture it is opacity Inherited from IMyTextSurface |
| BackgroundColor | Gets or sets background color Inherited from IMyTextSurface |
| ChangeInterval | Gets or sets the change interval for selected textures Inherited from IMyTextSurface |
| ContentType | Type of content to be displayed on the screen. Inherited from IMyTextSurface |
| CurrentlyShownImage | Gets image that is currently shown on the screen. Returns NULL if there are no images selected OR the screen is in text mode. Inherited from IMyTextSurface |
| DisplayName | Get localized name of this surface. Inherited from IMyTextSurface |
| Font | Gets or sets the font Inherited from IMyTextSurface |
| FontColor | Gets or sets font color Inherited from IMyTextSurface |
| FontSize | Gets or sets font size Inherited from IMyTextSurface |
| Name | Gets identifier name of this surface. Inherited from IMyTextSurface |
| PreserveAspectRatio | Gets or sets preserve aspect ratio of images. Inherited from IMyTextSurface |
| Script | Currently running script Inherited from IMyTextSurface |
| ScriptBackgroundColor | Gets or sets background color used for scripts. Inherited from IMyTextSurface |
| ScriptForegroundColor | Gets or sets foreground color used for scripts. Inherited from IMyTextSurface |
| SurfaceSize | Gets size of the drawing surface. Inherited from IMyTextSurface |
| TextPadding | Gets or sets text padding from all sides of the panel. Inherited from IMyTextSurface |
| TextureSize | Gets size of the texture the drawing surface is rendered to. Inherited from IMyTextSurface |
Methods
| Member | Description |
|---|---|
| AddImagesToSelection(List |
Adds image to list of shown images. You can get image ids by GetSelectedImages(List Inherited from IMyTextSurface |
| AddImageToSelection(string, bool) | Adds image to list of shown images. You can get image ids by GetSelectedImages(List Inherited from IMyTextSurface |
| ClearImagesFromSelection() | Removes images from shown images. Inherited from IMyTextSurface |
| DrawFrame() | Creates a new draw frame where you can add sprites to be rendered. Inherited from IMyTextSurface |
| GetFonts(List |
Gets a list of available fonts Inherited from IMyTextSurface |
| GetScripts(List |
Gets a list of available scripts Inherited from IMyTextSurface |
| GetSelectedImages(List |
Outputs the selected image ids to the specified list. NOTE: List is not cleared internally. Inherited from IMyTextSurface |
| GetSprites(List |
Gets a list of available sprites Inherited from IMyTextSurface |
| GetText() | Gets current text that is written on surface. Allocates memory (StringBuilder.ToString())! This method doesn't allocate memory ReadText(StringBuilder, bool) Inherited from IMyTextSurface |
| MeasureStringInPixels(StringBuilder, string, float) | Calculates how many pixels a string of a given font and scale will take up. Inherited from IMyTextSurface |
| ReadText(StringBuilder, bool) | Gets current text that is written on surface. Inherited from IMyTextSurface |
| RemoveImageFromSelection(string, bool) | Removes image from shown images. Inherited from IMyTextSurface |
| RemoveImagesFromSelection(List |
Removes images from shown images. Inherited from IMyTextSurface |
| WriteText(string, bool) | Writes text to surface. If somebody opened LCD text in popup dialog, text can no longer be added to the surface. Resulting text must is capped with 100000 symbols Inherited from IMyTextSurface |
| WriteText(StringBuilder, bool) | Writes text to surface. If somebody opened LCD text in popup dialog, text can no longer be added to the surface. Resulting text must is capped with 100000 symbols Inherited from IMyTextSurface |
Implements:
Inheritors: