This repository was archived by the owner on Dec 13, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
Sandbox.ModAPI.Ingame.IMyTextPanel
Morten Aune Lyrstad edited this page Dec 20, 2019
·
66 revisions
← Index ← Namespace Index
public interface IMyTextPanel: IMyTextSurface, IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntityNamespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Implements:
Type Definitions:
MyObjectBuilder_TextPanel/SmallTextPanelMyObjectBuilder_TextPanel/SmallLCDPanelWideMyObjectBuilder_TextPanel/SmallLCDPanelMyObjectBuilder_TextPanel/LargeBlockCorner_LCD_1MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_2MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_Flat_1MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_Flat_2MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_1MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_2MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_Flat_1MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_Flat_2MyObjectBuilder_TextPanel/LargeTextPanelMyObjectBuilder_TextPanel/LargeLCDPanelMyObjectBuilder_TextPanel/LargeLCDPanelWideMyObjectBuilder_TextPanel/TransparentLCDLargeMyObjectBuilder_TextPanel/TransparentLCDSmall
| Member | Description |
|---|---|
| ShowOnScreen |
Obsolete: LCD public text is deprecated Indicates what should be shown on the screen, none being an image. |
| ShowText |
Obsolete: LCD public text is deprecated Returns true if the ShowOnScreen flag is set to either PUBLIC or PRIVATE |
| Components | Inherited from IMyEntity |
| EntityId | Inherited from IMyEntity |
| Name | Inherited from IMyEntity |
| DisplayName | Inherited from IMyEntity |
| HasInventory | Returns true if this entity has got at least one inventory. Note that one aggregate inventory can contain zero simple inventories => zero will be returned even if GetInventory() != null. Inherited from IMyEntity |
| InventoryCount | Returns the count of the number of inventories this entity has. Inherited from IMyEntity |
| WorldAABB | Inherited from IMyEntity |
| WorldAABBHr | Inherited from IMyEntity |
| WorldMatrix | Inherited from IMyEntity |
| WorldVolume | Inherited from IMyEntity |
| WorldVolumeHr | Inherited from IMyEntity |
| BlockDefinition | Inherited from IMyCubeBlock |
| CheckConnectionAllowed | Inherited from IMyCubeBlock |
| CubeGrid | Grid in which the block is placed Inherited from IMyCubeBlock |
| DefinitionDisplayNameText | Definition name Inherited from IMyCubeBlock |
| DisassembleRatio | Is set in definition Ratio at which is the block disassembled (grinding) Inherited from IMyCubeBlock |
| DisplayNameText | Translated block name Inherited from IMyCubeBlock |
| IsBeingHacked | Hacking of the block is in progress Inherited from IMyCubeBlock |
| IsFunctional | True if integrity is above breaking threshold Inherited from IMyCubeBlock |
| IsWorking | True if block is able to do its work depening on block type (is functional, powered, enabled, etc...) Inherited from IMyCubeBlock |
| Max | Maximum coordinates of grid cells occupied by this block Inherited from IMyCubeBlock |
| Mass | Block mass Inherited from IMyCubeBlock |
| Min | Minimum coordinates of grid cells occupied by this block Inherited from IMyCubeBlock |
| NumberInGrid | Order in which were the blocks of same type added to grid Used in default display name Inherited from IMyCubeBlock |
| Orientation | Returns block orientation in base 6 directions Inherited from IMyCubeBlock |
| OwnerId | Id of player owning block (not steam Id) Inherited from IMyCubeBlock |
| Position | Position in grid coordinates Inherited from IMyCubeBlock |
| CustomName | Inherited from IMyTerminalBlock |
| CustomNameWithFaction | Inherited from IMyTerminalBlock |
| DetailedInfo | Inherited from IMyTerminalBlock |
| CustomInfo | Inherited from IMyTerminalBlock |
| CustomData | Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent Inherited from IMyTerminalBlock |
| ShowOnHUD | Inherited from IMyTerminalBlock |
| ShowInTerminal | Inherited from IMyTerminalBlock |
| ShowInToolbarConfig | Inherited from IMyTerminalBlock |
| ShowInInventory | Inherited from IMyTerminalBlock |
| Enabled | Inherited from IMyFunctionalBlock |
| CurrentlyShownImage | The 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 |
| FontSize | Gets or sets font size Inherited from IMyTextSurface |
| FontColor | Gets or sets font color Inherited from IMyTextSurface |
| BackgroundColor | Gets or sets background color 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 |
| ChangeInterval | Gets or sets the change interval for selected textures Inherited from IMyTextSurface |
| Font | Gets or sets the font Inherited from IMyTextSurface |
| Alignment | How should the text be aligned Inherited from IMyTextSurface |
| Script | Currently running script Inherited from IMyTextSurface |
| ContentType | Type of content to be displayed on the screen. Inherited from IMyTextSurface |
| SurfaceSize | Size of the drawing surface. Inherited from IMyTextSurface |
| TextureSize | Size of the texture the drawing surface is rendered to. Inherited from IMyTextSurface |
| PreserveAspectRatio | Preserve aspect ratio of images. Inherited from IMyTextSurface |
| TextPadding | Text padding from all sides of the panel. Inherited from IMyTextSurface |
| ScriptBackgroundColor | Background color used for scripts. Inherited from IMyTextSurface |
| ScriptForegroundColor | Foreground color used for scripts. Inherited from IMyTextSurface |
| Name | Identifier name of this surface. Inherited from IMyTextSurface |
| DisplayName | Localized name of this surface. Inherited from IMyTextSurface |
| Member | Description |
|---|---|
| WritePublicTitle(string, bool) | |
| GetPublicTitle() | |
| WritePrivateText(string, bool) | Obsolete: LCD private text is deprecated |
| GetPrivateText() | Obsolete: LCD private text is deprecated |
| WritePrivateTitle(string, bool) | Obsolete: LCD private text is deprecated |
| GetPrivateTitle() | Obsolete: LCD private text is deprecated |
| ShowPrivateTextOnScreen() | Obsolete: LCD private text is deprecated |
| WritePublicText(string, bool) | Obsolete: LCD public text is deprecated |
| GetPublicText() | Obsolete: LCD public text is deprecated |
| WritePublicText(StringBuilder, bool) | Obsolete: LCD public text is deprecated |
| ReadPublicText(StringBuilder, bool) | Obsolete: LCD public text is deprecated |
| ShowPublicTextOnScreen() | Obsolete: LCD public text is deprecated |
| ShowTextureOnScreen() | Obsolete: LCD public text is deprecated |
| SetShowOnScreen(ShowTextOnScreenFlag) | Obsolete: LCD public text is deprecated |
| GetInventory() | Simply get the MyInventoryBase component stored in this entity. Inherited from IMyEntity |
| GetInventory(int) | Search for inventory component with maching index. Inherited from IMyEntity |
| GetPosition() | Inherited from IMyEntity |
| GetOwnerFactionTag() | Tag of faction owning block Inherited from IMyCubeBlock |
| GetPlayerRelationToOwner() |
Obsolete: GetPlayerRelationToOwner() is useless ingame. Mods should use the one in ModAPI.IMyCubeBlock Inherited from IMyCubeBlock |
| GetUserRelationToOwner(long) | Inherited from IMyCubeBlock |
| UpdateIsWorking() |
Obsolete Inherited from IMyCubeBlock |
| UpdateVisual() |
Obsolete Inherited from IMyCubeBlock |
| HasLocalPlayerAccess() | Inherited from IMyTerminalBlock |
| HasPlayerAccess(long) | Inherited from IMyTerminalBlock |
| SetCustomName(string) |
Obsolete: Use the setter of Customname Inherited from IMyTerminalBlock |
| SetCustomName(StringBuilder) |
Obsolete: Use the setter of Customname Inherited from IMyTerminalBlock |
| GetActions(List, Func) | Inherited from IMyTerminalBlock |
| SearchActionsOfName(string, List, Func) | Inherited from IMyTerminalBlock |
| GetActionWithName(string) | Inherited from IMyTerminalBlock |
| GetProperty(string) | Inherited from IMyTerminalBlock |
| GetProperties(List, Func) | Inherited from IMyTerminalBlock |
| IsSameConstructAs(IMyTerminalBlock) | Determines whether this block is mechanically connected to the other. This is any block connected with rotors or pistons or other mechanical devices, but not things like connectors. This will in most cases constitute your complete construct. Be aware that using merge blocks combines grids into one, so this function will not filter out grids connected that way. Also be aware that detaching the heads of pistons and rotors will cause this connection to change. Inherited from IMyTerminalBlock |
| RequestEnable(bool) |
Obsolete: Use the setter of Enabled Inherited from IMyFunctionalBlock |
| WriteText(string, bool) | Inherited from IMyTextSurface |
| GetText() | Inherited from IMyTextSurface |
| WriteText(StringBuilder, bool) | Inherited from IMyTextSurface |
| ReadText(StringBuilder, bool) | Inherited from IMyTextSurface |
| AddImageToSelection(string, bool) | Inherited from IMyTextSurface |
| AddImagesToSelection(List, bool) | Inherited from IMyTextSurface |
| RemoveImageFromSelection(string, bool) | Inherited from IMyTextSurface |
| RemoveImagesFromSelection(List, bool) | Inherited from IMyTextSurface |
| ClearImagesFromSelection() | Inherited from IMyTextSurface |
| GetSelectedImages(List) | Outputs the selected image ids to the specified list. NOTE: List is not cleared internally. Inherited from IMyTextSurface |
| GetFonts(List) | Gets a list of available fonts Inherited from IMyTextSurface |
| GetSprites(List) | Gets a list of available sprites Inherited from IMyTextSurface |
| GetScripts(List) | Gets a list of available scripts Inherited from IMyTextSurface |
| DrawFrame() | Creates a new draw frame where you can add sprites to be rendered. 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 |
Do you have questions, comments, suggestions for improvements? Is there something I can do better? Did I make a mistake? Please add an issue here, and prefix your issue title with Wiki. Thank you, your help will be very appreciated!