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 Feb 3, 2022
·
66 revisions
← Index ← Namespace Index
public interface IMyTextPanel: IMyTextSurface, IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntityDescribes LCD block (mods interface)
Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Implements:
Type Definitions:
- MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_1
- MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_2
- MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_Flat_1
- MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_Flat_2
- MyObjectBuilder_TextPanel/LargeLCDPanel
- MyObjectBuilder_TextPanel/LargeLCDPanel3x3
- MyObjectBuilder_TextPanel/LargeLCDPanel5x3
- MyObjectBuilder_TextPanel/LargeLCDPanel5x5
- MyObjectBuilder_TextPanel/LargeLCDPanelWide
- MyObjectBuilder_TextPanel/LargeTextPanel
- MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_1
- MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_2
- MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_Flat_1
- MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_Flat_2
- MyObjectBuilder_TextPanel/SmallLCDPanel
- MyObjectBuilder_TextPanel/SmallLCDPanelWide
- MyObjectBuilder_TextPanel/SmallTextPanel
- MyObjectBuilder_TextPanel/TransparentLCDLarge
- MyObjectBuilder_TextPanel/TransparentLCDSmall
| Member | Description |
|---|---|
| ShowOnScreen { get; } |
Obsolete: LCD public text is deprecated Indicates what should be shown on the screen, none being an image. |
| ShowText { get; } |
Obsolete: LCD public text is deprecated Returns true if the ShowOnScreen flag is set to either PUBLIC or PRIVATE |
| Components { get; } | Gets blocks component logic container Inherited from IMyEntity |
| EntityId { get; } | Id of entity Inherited from IMyEntity |
| Name { get; } | Some entities can have uniq name, and game can find them by name VRage.ModAPI.IMyEntities.TryGetEntityByName(System.String,VRage.ModAPI.IMyEntity@) Inherited from IMyEntity |
| DisplayName { get; } | Gets user friendly name of entity. May be null For block terminal name use DisplayNameText Inherited from IMyEntity |
| HasInventory { get; } | 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 { get; } | Returns the count of the number of inventories this entity has. Inherited from IMyEntity |
| Closed { get; } | True if the block has been removed from the world. Inherited from IMyEntity |
| WorldAABB { get; } | Gets world axis-aligned bounding box Inherited from IMyEntity |
| WorldAABBHr { get; } | Gets world axis-aligned bounding box Inherited from IMyEntity |
| WorldMatrix { get; } | Gets world matrix of this entity Inherited from IMyEntity |
| WorldVolume { get; } | Gets bounding sphere of this entity Inherited from IMyEntity |
| WorldVolumeHr { get; } | Gets bounding sphere of this entity Inherited from IMyEntity |
| BlockDefinition { get; } | Gets definition.Id assigned to this block Inherited from IMyCubeBlock |
| CheckConnectionAllowed { get; set; } | Whether the grid should call the ConnectionAllowed method for this block (ConnectionAllowed checks mount points and other per-block requirements) Inherited from IMyCubeBlock |
| CubeGrid { get; } | Grid in which the block is placed Inherited from IMyCubeBlock |
| DefinitionDisplayNameText { get; } | Definition name Inherited from IMyCubeBlock |
| DisassembleRatio { get; } | Is set in definition Ratio at which is the block disassembled (grinding) Bigger values - longer grinding Inherited from IMyCubeBlock |
| DisplayNameText { get; } | Translated block name Inherited from IMyCubeBlock |
| IsBeingHacked { get; } | Hacking of the block is in progress Inherited from IMyCubeBlock |
| IsFunctional { get; } | Gets if integrity is above breaking threshold Inherited from IMyCubeBlock |
| IsWorking { get; } | True if block is able to do its work depening on block type (is functional, powered, enabled, etc...) Inherited from IMyCubeBlock |
| Max { get; } | Maximum coordinates of grid cells occupied by this block Inherited from IMyCubeBlock |
| Mass { get; } | Block mass Inherited from IMyCubeBlock |
| Min { get; } | Minimum coordinates of grid cells occupied by this block Inherited from IMyCubeBlock |
| NumberInGrid { get; } | Order in which were the blocks of same type added to grid Used in default display name Inherited from IMyCubeBlock |
| Orientation { get; } | Returns block orientation in base 6 directions Inherited from IMyCubeBlock |
| OwnerId { get; } | IdentityId of player owning block (not steam Id) Inherited from IMyCubeBlock |
| Position { get; } | Position in grid coordinates Inherited from IMyCubeBlock |
| CustomName { get; set; } | Gets or sets how block is named in Terminal menu Inherited from IMyTerminalBlock |
| CustomNameWithFaction { get; } | Gets or sets how block is named in Terminal menu. Work only for Cockpit, LaserAntenna RadioAntenna, SpaceBall, Beacon Inherited from IMyTerminalBlock |
| DetailedInfo { get; } | Gets information about block status. In Control panel bottom right text Inherited from IMyTerminalBlock |
| CustomInfo { get; } | Gets information about block status (available from mods) Sandbox.ModAPI.IMyTerminalBlock.AppendingCustomInfo Sandbox.ModAPI.IMyTerminalBlock.RefreshCustomInfo . Inherited from IMyTerminalBlock |
| CustomData { get; set; } | 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 { get; set; } | Represent terminal gui toggle Show On HUD. Gets or sets its valueInherited from IMyTerminalBlock |
| ShowInTerminal { get; set; } | Represent terminal gui toggle Show block in terminal. Gets or sets its valueInherited from IMyTerminalBlock |
| ShowInToolbarConfig { get; set; } | Represent terminal gui toggle Show in toolbar config. Gets or sets its valueInherited from IMyTerminalBlock |
| ShowInInventory { get; set; } | Represent terminal gui toggle Show block in Inventory Screen. Gets or sets its valueInherited from IMyTerminalBlock |
| Enabled { get; set; } | Represents terminal gui toggle. Gets or sets if block is Enabled Inherited from IMyFunctionalBlock |
| CurrentlyShownImage { get; } | 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 |
| FontSize { get; set; } | Gets or sets font size Inherited from IMyTextSurface |
| FontColor { get; set; } | Gets or sets font color Inherited from IMyTextSurface |
| BackgroundColor { get; set; } | Gets or sets background color Inherited from IMyTextSurface |
| BackgroundAlpha { get; set; } | 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 { get; set; } | Gets or sets the change interval for selected textures Inherited from IMyTextSurface |
| Font { get; set; } | Gets or sets the font Inherited from IMyTextSurface |
| Alignment { get; set; } | How should the text be aligned Inherited from IMyTextSurface |
| Script { get; set; } | Currently running script Inherited from IMyTextSurface |
| ContentType { get; set; } | Type of content to be displayed on the screen. Inherited from IMyTextSurface |
| SurfaceSize { get; } | Gets size of the drawing surface. Inherited from IMyTextSurface |
| TextureSize { get; } | Gets size of the texture the drawing surface is rendered to. Inherited from IMyTextSurface |
| PreserveAspectRatio { get; set; } | Gets or sets preserve aspect ratio of images. Inherited from IMyTextSurface |
| TextPadding { get; set; } | Gets or sets text padding from all sides of the panel. Inherited from IMyTextSurface |
| ScriptBackgroundColor { get; set; } | Gets or sets background color used for scripts. Inherited from IMyTextSurface |
| ScriptForegroundColor { get; set; } | Gets or sets foreground color used for scripts. Inherited from IMyTextSurface |
| Name { get; } | Gets identifier name of this surface. Inherited from IMyTextSurface |
| DisplayName { get; } | Get localized name of this surface. Inherited from IMyTextSurface |
| Member | Description |
|---|---|
| WritePublicTitle(string, bool) | Writes LCD popup dialog title If somebody opened LCD text in popup dialog, text can no longer be added. |
| GetPublicTitle() | Gets popup dialog title |
| 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() | Gets position in world coordinates 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 Relation of local player to the block Should not be called on Dedicated Server. Inherited from IMyCubeBlock |
| GetUserRelationToOwner(long, MyRelationsBetweenPlayerAndBlock) | Gets relation to owner of block Inherited from IMyCubeBlock |
| UpdateIsWorking() |
Obsolete Force refresh working state. Call if you change block state that could affect its working status. Inherited from IMyCubeBlock |
| UpdateVisual() |
Obsolete Updates block visuals (ie. block emissivity) Inherited from IMyCubeBlock |
| HasLocalPlayerAccess() | Returns if local player can use block. Executes HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock) with local player identityId. On Dedicated Server as identityId it is using 0 as playerId Inherited from IMyTerminalBlock |
| HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock) | Returns if local player can use block. It is also checking for admin access. 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) | Get all terminal actions available for block Inherited from IMyTerminalBlock |
| SearchActionsOfName(string, List, Func) | Get all terminal actions available for block. NOTE: First called <br /><br /> and then <br /><br /> checkInherited from IMyTerminalBlock |
| GetActionWithName(string) | Get first found terminal action with name Inherited from IMyTerminalBlock |
| GetProperty(string) | Finds terminal property with provided id Inherited from IMyTerminalBlock |
| GetProperties(List, Func) | Get all terminal actions available for block. Inherited from IMyTerminalBlock |
| IsSameConstructAs(IMyTerminalBlock) | Determines whether this block is VRage.Game.ModAPI.GridLinkTypeEnum.Mechanical 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) | 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 |
| 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 |
| 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 |
| ReadText(StringBuilder, bool) | Gets current text that is written on surface. Inherited from IMyTextSurface |
| AddImageToSelection(string, bool) | Adds image to list of shown images. You can get image ids by GetSelectedImages(List<System.String>) Inherited from IMyTextSurface |
| AddImagesToSelection(List, bool) | Adds image to list of shown images. You can get image ids by GetSelectedImages(List<System.String>) Inherited from IMyTextSurface |
| RemoveImageFromSelection(string, bool) | Removes image from shown images. Inherited from IMyTextSurface |
| RemoveImagesFromSelection(List, bool) | Removes images from shown images. Inherited from IMyTextSurface |
| ClearImagesFromSelection() | Removes images from shown images. 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!