Inheritance diagram for Sandbox.ModAPI.Ingame.IMyTextPanel:

Public Member Functions
bool	WritePublicText (string value, bool append=false)

string	GetPublicText ()

bool	WritePublicTitle (string value, bool append=false)

string	GetPublicTitle ()

bool	WritePrivateText (string value, bool append=false)

string	GetPrivateText ()

bool	WritePrivateTitle (string value, bool append=false)

string	GetPrivateTitle ()

void	AddImageToSelection (string id, bool checkExistence=false)

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

void	RemoveImageFromSelection (string id, bool removeDuplicates=false)

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

void	ClearImagesFromSelection ()

void	GetSelectedImages (List< string > output)
	Outputs the selected image ids to the specified list. More...

void	ShowPublicTextOnScreen ()

void	ShowPrivateTextOnScreen ()

void	ShowTextureOnScreen ()

void	SetShowOnScreen (ShowTextOnScreenFlag set)

Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
void	RequestEnable (bool enable)

void	RequestEnable (bool enable)

Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
bool	HasLocalPlayerAccess ()

bool	HasPlayerAccess (long playerId)

void	SetCustomName (string text)

void	SetCustomName (StringBuilder text)

void	GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)

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

Sandbox.ModAPI.Interfaces.ITerminalAction	GetActionWithName (string name)

Sandbox.ModAPI.Interfaces.ITerminalProperty	GetProperty (string id)

void	GetProperties (List< Sandbox.ModAPI.Interfaces.ITerminalProperty > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalProperty, bool > collect=null)

bool	HasLocalPlayerAccess ()

bool	HasPlayerAccess (long playerId)

void	RequestShowOnHUD (bool enable)

void	SetCustomName (string text)

void	SetCustomName (StringBuilder text)

void	GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)

Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
string	GetOwnerFactionTag ()

Sandbox.Common.MyRelationsBetweenPlayerAndBlock	GetPlayerRelationToOwner ()

Sandbox.Common.MyRelationsBetweenPlayerAndBlock	GetUserRelationToOwner (long playerId)

void	UpdateIsWorking ()

void	UpdateVisual ()

Properties
string	CurrentlyShownImage `[get]`
	The image that is currently shown on the screen. More...

ShowTextOnScreenFlag	ShowOnScreen `[get]`
	Indicates what should be shown on the screen, none being an image. More...

bool	ShowText `[get]`
	Returns true if the ShowOnScreen flag is set to either PUBLIC or PRIVATE More...

Properties inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
bool	Enabled `[get]`

Properties inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
string	CustomName `[get]`

string	CustomNameWithFaction `[get]`

string	DetailedInfo `[get]`

string	CustomInfo `[get]`

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 More...

bool	ShowOnHUD `[get]`

Properties inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Sandbox.Common.ObjectBuilders.Definitions.SerializableDefinitionId	BlockDefinition `[get]`

bool	CheckConnectionAllowed `[get]`

IMyCubeGrid	CubeGrid `[get]`

String	DefinitionDisplayNameText `[get]`

float	DisassembleRatio `[get]`

String	DisplayNameText `[get]`

bool	IsBeingHacked `[get]`

bool	IsFunctional `[get]`

bool	IsWorking `[get]`

VRageMath.Vector3I	Max `[get]`

VRageMath.Vector3I	Min `[get]`

int	NumberInGrid `[get]`

VRageMath.MyBlockOrientation	Orientation `[get]`

long	OwnerId `[get]`

VRageMath.Vector3I	Position `[get]`

Additional Inherited Members
Events inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
Action< IMyTerminalBlock >	EnabledChanged

Events inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
Action< IMyTerminalBlock >	CustomNameChanged

Action< IMyTerminalBlock >	OwnershipChanged

Action< IMyTerminalBlock >	PropertiesChanged

Action< IMyTerminalBlock >	ShowOnHUDChanged

Action< IMyTerminalBlock >	VisibilityChanged

Events inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Action< IMyCubeBlock >	IsWorkingChanged

Detailed Description

Definition at line 9 of file IMyTextPanel.cs.

Member Function Documentation

void Sandbox.ModAPI.Ingame.IMyTextPanel.AddImagesToSelection	(	List< string >	ids,
		bool	checkExistence = `false`
	)

void Sandbox.ModAPI.Ingame.IMyTextPanel.AddImageToSelection	(	string	id,
		bool	checkExistence = `false`
	)

void Sandbox.ModAPI.Ingame.IMyTextPanel.ClearImagesFromSelection ( )

string Sandbox.ModAPI.Ingame.IMyTextPanel.GetPrivateText ( )

string Sandbox.ModAPI.Ingame.IMyTextPanel.GetPrivateTitle ( )

string Sandbox.ModAPI.Ingame.IMyTextPanel.GetPublicText ( )

string Sandbox.ModAPI.Ingame.IMyTextPanel.GetPublicTitle ( )

void Sandbox.ModAPI.Ingame.IMyTextPanel.GetSelectedImages ( List< string > output )

Outputs the selected image ids to the specified list.

NOTE: List is not cleared internally.

Parameters

output

void Sandbox.ModAPI.Ingame.IMyTextPanel.RemoveImageFromSelection	(	string	id,
		bool	removeDuplicates = `false`
	)

void Sandbox.ModAPI.Ingame.IMyTextPanel.RemoveImagesFromSelection	(	List< string >	ids,
		bool	removeDuplicates = `false`
	)

void Sandbox.ModAPI.Ingame.IMyTextPanel.SetShowOnScreen ( ShowTextOnScreenFlag set )

void Sandbox.ModAPI.Ingame.IMyTextPanel.ShowPrivateTextOnScreen ( )

void Sandbox.ModAPI.Ingame.IMyTextPanel.ShowPublicTextOnScreen ( )

void Sandbox.ModAPI.Ingame.IMyTextPanel.ShowTextureOnScreen ( )

bool Sandbox.ModAPI.Ingame.IMyTextPanel.WritePrivateText	(	string	value,
		bool	append = `false`
	)

bool Sandbox.ModAPI.Ingame.IMyTextPanel.WritePrivateTitle	(	string	value,
		bool	append = `false`
	)

bool Sandbox.ModAPI.Ingame.IMyTextPanel.WritePublicText	(	string	value,
		bool	append = `false`
	)

bool Sandbox.ModAPI.Ingame.IMyTextPanel.WritePublicTitle	(	string	value,
		bool	append = `false`
	)

Property Documentation

string Sandbox.ModAPI.Ingame.IMyTextPanel.CurrentlyShownImage

get

The image that is currently shown on the screen.

Returns NULL if there are no images selected OR the screen is in text mode.

Definition at line 48 of file IMyTextPanel.cs.

ShowTextOnScreenFlag Sandbox.ModAPI.Ingame.IMyTextPanel.ShowOnScreen

get

Indicates what should be shown on the screen, none being an image.

Definition at line 59 of file IMyTextPanel.cs.

bool Sandbox.ModAPI.Ingame.IMyTextPanel.ShowText

get

Returns true if the ShowOnScreen flag is set to either PUBLIC or PRIVATE

Definition at line 64 of file IMyTextPanel.cs.

The documentation for this interface was generated from the following file:

Sources/Sandbox.Common/ModAPI/Ingame/IMyTextPanel.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation