Sandbox.ModAPI.Ingame.IMyTextPanel

← Index ← Namespace Index

IMyTextPanel Interface

public interface IMyTextPanel: IMyTextSurface, IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntity

Describes LCD block (mods interface)

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll

Implements:

• IMyCubeBlock
• IMyEntity
• IMyFunctionalBlock
• IMyTerminalBlock
• IMyTextSurface

Type Definitions:

• MyObjectBuilder_TextPanel/HoloLCDLarge
• MyObjectBuilder_TextPanel/HoloLCDSmall
• MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_1
• MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_2
• MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_Flat_1
• MyObjectBuilder_TextPanel/LargeBlockCorner_LCD_Flat_2
• MyObjectBuilder_TextPanel/LargeCurvedLCDPanel
• MyObjectBuilder_TextPanel/LargeDiagonalLCDPanel
• MyObjectBuilder_TextPanel/LargeFullBlockLCDPanel
• MyObjectBuilder_TextPanel/LargeLCDPanel
• MyObjectBuilder_TextPanel/LargeLCDPanel3x3
• MyObjectBuilder_TextPanel/LargeLCDPanel5x3
• MyObjectBuilder_TextPanel/LargeLCDPanel5x5
• MyObjectBuilder_TextPanel/LargeLCDPanelWide
• MyObjectBuilder_TextPanel/LargeTextPanel
• MyObjectBuilder_TextPanel/SmallBlockConsoleModuleScreens
• MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_1
• MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_2
• MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_Flat_1
• MyObjectBuilder_TextPanel/SmallBlockCorner_LCD_Flat_2
• MyObjectBuilder_TextPanel/SmallCurvedLCDPanel
• MyObjectBuilder_TextPanel/SmallDiagonalLCDPanel
• MyObjectBuilder_TextPanel/SmallFullBlockLCDPanel
• MyObjectBuilder_TextPanel/SmallLCDPanel
• MyObjectBuilder_TextPanel/SmallLCDPanelWide
• MyObjectBuilder_TextPanel/SmallTextPanel
• MyObjectBuilder_TextPanel/TransparentLCDLarge
• MyObjectBuilder_TextPanel/TransparentLCDSmall

Properties

TextAlignment Alignment { get; set; }

How should the text be aligned

Inherited from IMyTextSurface

byte 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

Color BackgroundColor { get; set; }

Gets or sets background color

Inherited from IMyTextSurface

SerializableDefinitionId BlockDefinition { get; }

Gets definition.Id assigned to this block

Inherited from IMyCubeBlock

float ChangeInterval { get; set; }

Gets or sets the change interval for selected textures

Inherited from IMyTextSurface

bool Closed { get; }

True if the block has been removed from the world.

Inherited from IMyEntity

IMyEntityComponentContainer Components { get; }

Gets blocks component logic container

Inherited from IMyEntity

ContentType ContentType { get; set; }

Type of content to be displayed on the screen.

Inherited from IMyTextSurface

IMyCubeGrid CubeGrid { get; }

Grid in which the block is placed

Inherited from IMyCubeBlock

string 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

string 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

string CustomInfo { get; }

Gets information about block status (available from mods) Sandbox.ModAPI.IMyTerminalBlock.AppendingCustomInfo Sandbox.ModAPI.IMyTerminalBlock.RefreshCustomInfo .

Inherited from IMyTerminalBlock

string CustomName { get; set; }

Gets or sets how block is named in Terminal menu

Inherited from IMyTerminalBlock

string CustomNameWithFaction { get; }

Gets or sets how block is named in Terminal menu. Work only for Cockpit, LaserAntenna RadioAntenna, SpaceBall, Beacon

Inherited from IMyTerminalBlock

string DefinitionDisplayNameText { get; }

Definition name

Inherited from IMyCubeBlock

string DetailedInfo { get; }

Gets information about block status. In Control panel bottom right text

Inherited from IMyTerminalBlock

float DisassembleRatio { get; }

Is set in definition Ratio at which is the block disassembled (grinding) Bigger values - longer grinding

Inherited from IMyCubeBlock

string DisplayName { get; }

Gets user friendly name of entity. May be null For block terminal name use DisplayNameText

Inherited from IMyEntity

string DisplayName { get; }

Get localized name of this surface.

Inherited from IMyTextSurface

string DisplayNameText { get; }

Translated block name

Inherited from IMyCubeBlock

bool Enabled { get; set; }

Represents terminal gui toggle. Gets or sets if block is Enabled

Inherited from IMyFunctionalBlock

long EntityId { get; }

Id of entity

Inherited from IMyEntity

string Font { get; set; }

Gets or sets the font

Inherited from IMyTextSurface

Color FontColor { get; set; }

Gets or sets font color

Inherited from IMyTextSurface

float FontSize { get; set; }

Gets or sets font size

Inherited from IMyTextSurface

bool 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

int InventoryCount { get; }

Returns the count of the number of inventories this entity has.

Inherited from IMyEntity

bool IsBeingHacked { get; }

Hacking of the block is in progress

Inherited from IMyCubeBlock

bool IsFunctional { get; }

Gets if integrity is above breaking threshold

Inherited from IMyCubeBlock

bool IsWorking { get; }

True if block is able to do its work depening on block type (is functional, powered, enabled, etc...)

Inherited from IMyCubeBlock

float Mass { get; }

Block mass

Inherited from IMyCubeBlock

Vector3I Max { get; }

Maximum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock

Vector3I Min { get; }

Minimum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock

string 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

string Name { get; }

Gets identifier name of this surface.

Inherited from IMyTextSurface

int NumberInGrid { get; }

Order in which were the blocks of same type added to grid Used in default display name

Inherited from IMyCubeBlock

MyBlockOrientation Orientation { get; }

Returns block orientation in base 6 directions

Inherited from IMyCubeBlock

long OwnerId { get; }

IdentityId of player owning block (not steam Id)

Inherited from IMyCubeBlock

Vector3I Position { get; }

Position in grid coordinates

Inherited from IMyCubeBlock

bool PreserveAspectRatio { get; set; }

Gets or sets preserve aspect ratio of images.

Inherited from IMyTextSurface

string Script { get; set; }

Currently running script

Inherited from IMyTextSurface

Color ScriptBackgroundColor { get; set; }

Gets or sets background color used for scripts.

Inherited from IMyTextSurface

Color ScriptForegroundColor { get; set; }

Gets or sets foreground color used for scripts.

Inherited from IMyTextSurface

bool ShowInInventory { get; set; }

Represent terminal gui toggle Show block in Inventory Screen. Gets or sets its value

Inherited from IMyTerminalBlock

bool ShowInTerminal { get; set; }

Represent terminal gui toggle Show block in terminal. Gets or sets its value

Inherited from IMyTerminalBlock

bool ShowInToolbarConfig { get; set; }

Represent terminal gui toggle Show in toolbar config. Gets or sets its value

Inherited from IMyTerminalBlock

bool ShowOnHUD { get; set; }

Represent terminal gui toggle Show On HUD. Gets or sets its value

Inherited from IMyTerminalBlock

Vector2 SurfaceSize { get; }

Gets size of the drawing surface.

Inherited from IMyTextSurface

float TextPadding { get; set; }

Gets or sets text padding from all sides of the panel.

Inherited from IMyTextSurface

Vector2 TextureSize { get; }

Gets size of the texture the drawing surface is rendered to.

Inherited from IMyTextSurface

BoundingBoxD WorldAABB { get; }

Gets world axis-aligned bounding box

Inherited from IMyEntity

BoundingBoxD WorldAABBHr { get; }

Gets world axis-aligned bounding box

Inherited from IMyEntity

MatrixD WorldMatrix { get; }

Gets world matrix of this entity

Inherited from IMyEntity

BoundingSphereD WorldVolume { get; }

Gets bounding sphere of this entity

Inherited from IMyEntity

BoundingSphereD WorldVolumeHr { get; }

Gets bounding sphere of this entity

Inherited from IMyEntity

Methods

string GetPublicTitle()

Gets popup dialog title

bool WritePublicTitle(string value, bool append = default)

Writes LCD popup dialog title If somebody opened LCD text in popup dialog, text can no longer be added.

void AddImagesToSelection(List<string> ids, bool checkExistence = default)

Adds image to list of shown images. You can get image ids by GetSelectedImages(List)

Inherited from IMyTextSurface

void AddImageToSelection(string id, bool checkExistence = default)

Adds image to list of shown images. You can get image ids by GetSelectedImages(List)

Inherited from IMyTextSurface

void ClearImagesFromSelection()

Removes images from shown images.

Inherited from IMyTextSurface

MySpriteDrawFrame DrawFrame()

Creates a new draw frame where you can add sprites to be rendered.

Inherited from IMyTextSurface

void GetActions(List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect = null)

Get all terminal actions available for block

Inherited from IMyTerminalBlock

ITerminalAction GetActionWithName(string name)

Get first found terminal action with name

Inherited from IMyTerminalBlock

void GetFonts(List<string> fonts)

Gets a list of available fonts

Inherited from IMyTextSurface

IMyInventory GetInventory()

Simply get the MyInventoryBase component stored in this entity.

Inherited from IMyEntity

IMyInventory GetInventory(int index)

Search for inventory component with maching index.

Inherited from IMyEntity

string GetOwnerFactionTag()

Tag of faction owning block

Inherited from IMyCubeBlock

Vector3D GetPosition()

Gets position in world coordinates

Inherited from IMyEntity

void GetProperties(List<ITerminalProperty> resultList, Func<ITerminalProperty, bool> collect = null)

Get all terminal actions available for block.

Inherited from IMyTerminalBlock

ITerminalProperty GetProperty(string id)

Finds terminal property with provided id

Inherited from IMyTerminalBlock

void GetScripts(List<string> scripts)

Gets a list of available scripts

Inherited from IMyTextSurface

void GetSelectedImages(List<string> output)

Outputs the selected image ids to the specified list. NOTE: List is not cleared internally.

Inherited from IMyTextSurface

void GetSprites(List<string> sprites)

Gets a list of available sprites

Inherited from IMyTextSurface

string GetText()

Gets current text that is written on surface. Allocates memory (StringBuilder.ToString())! This method doesn't allocate memory ReadText(StringBuilder, bool = default)

Inherited from IMyTextSurface

MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long playerId, MyRelationsBetweenPlayerAndBlock defaultNoUser = MyRelationsBetweenPlayerAndBlock.NoOwnership)

Gets relation to owner of block

Inherited from IMyCubeBlock

bool HasLocalPlayerAccess()

Returns if local player can use block. Executes HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock = MyRelationsBetweenPlayerAndBlock.NoOwnership) with local player identityId. On Dedicated Server as identityId it is using 0 as playerId

Inherited from IMyTerminalBlock

bool HasNobodyPlayerAccessToBlock()

Returns if Nobody has access to block.

Inherited from IMyTerminalBlock

bool HasPlayerAccess(long playerId, MyRelationsBetweenPlayerAndBlock defaultNoUser = MyRelationsBetweenPlayerAndBlock.NoOwnership)

Returns if local player can use block. It is also checking for admin access.

Inherited from IMyTerminalBlock

bool HasPlayerAccessWithNobodyCheck(long playerId, bool isForPB = default)

Returns if player can use block. If playerId is 0 (Nobody), calls HasNobodyPlayerAccessToBlock instead It is also checking for admin access.

Inherited from IMyTerminalBlock

bool IsSameConstructAs(IMyTerminalBlock other)

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

Vector2 MeasureStringInPixels(StringBuilder text, string font, float scale)

Calculates how many pixels a string of a given font and scale will take up.

Inherited from IMyTextSurface

void ReadText(StringBuilder buffer, bool append = default)

Gets current text that is written on surface.

Inherited from IMyTextSurface

void RemoveImageFromSelection(string id, bool removeDuplicates = default)

Removes image from shown images.

Inherited from IMyTextSurface

void RemoveImagesFromSelection(List<string> ids, bool removeDuplicates = default)

Removes images from shown images.

Inherited from IMyTextSurface

void SearchActionsOfName(string name, List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect = null)

Get all terminal actions available for block. NOTE: First called `

and then

` check

Inherited from IMyTerminalBlock

bool WriteText(string value, bool append = default)

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

bool WriteText(StringBuilder value, bool append = default)

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

MyRelationsBetweenPlayerAndBlock 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

void RequestEnable(bool enable)

Obsolete: Use the setter of Enabled

Obsolete

Inherited from IMyFunctionalBlock

void SetCustomName(string text)

Obsolete: Use the setter of Customname

Obsolete

Inherited from IMyTerminalBlock

void SetCustomName(StringBuilder text)

Obsolete: Use the setter of Customname

Obsolete

Inherited from IMyTerminalBlock

void UpdateIsWorking()

Obsolete

Force refresh working state. Call if you change block state that could affect its working status.

Inherited from IMyCubeBlock

void UpdateVisual()

Obsolete

Updates block visuals (ie. block emissivity)

Inherited from IMyCubeBlock