Space Engineers
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
Sandbox.Game.Gui.MyGuiScreenText Class Reference
Inheritance diagram for Sandbox.Game.Gui.MyGuiScreenText:
Sandbox.Graphics.GUI.MyGuiScreenBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner Sandbox.Game.Gui.MyGuiScreenEditor Sandbox.Game.Gui.MyGuiScreenTextPanel Sandbox.Game.Screens.MyGuiScreenMission

Classes

class  Style
 

Public Member Functions

 MyGuiScreenText (string missionTitle=null, string currentObjectivePrefix=null, string currentObjective=null, string description=null, Action< ResultEnum > resultCallback=null, string okButtonCaption=null, Vector2?windowSize=null, Vector2?descSize=null, bool editEnabled=false, bool canHideOthers=true, bool enableBackgroundFade=false, MyMissionScreenStyleEnum style=MyMissionScreenStyleEnum.BLUE)
 
override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
override void RecreateControls (bool constructor)
 
void SetTitle (string title)
 
void SetCurrentObjective (string objective)
 
void SetDescription (string desc)
 
void AppendTextToDescription (string text, Vector4 color, string font=MyFontEnum.White, float scale=1.0f)
 
void AppendTextToDescription (string text, string font=MyFontEnum.White, float scale=1.0f)
 
void SetCurrentObjectivePrefix (string prefix)
 
void SetOkButtonCaption (string caption)
 
override bool CloseScreen ()
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
delegate void ScreenHandler (MyGuiScreenBase source)
 
MyObjectBuilder_GuiScreen GetObjectBuilder ()
 
void Init (MyObjectBuilder_GuiScreen objectBuilder)
 
virtual void LoadContent ()
 
virtual void LoadData ()
 
virtual void UnloadContent ()
 
virtual void UnloadData ()
 
virtual void RunLoadingAction ()
 
bool IsMouseOverAnyControl ()
 
MyGuiControlBase GetMouseOverControl ()
 
virtual void GetControlsUnderMouseCursor (Vector2 position, List< MyGuiControlBase > controls, bool visibleOnly)
 
MyGuiControlBase GetNextFocusControl (MyGuiControlBase currentFocusControl, bool forwardMovement)
 
virtual void HandleInput (bool receivedFocusInThisUpdate)
 
virtual void InputLost ()
 
virtual void HandleUnhandledInput (bool receivedFocusInThisUpdate)
 
virtual bool HandleInputAfterSimulation ()
 
virtual bool HideScreen ()
 
virtual bool UnhideScreen ()
 
virtual void CloseScreenNow ()
 
virtual bool Update (bool hasFocus)
 
virtual bool Draw ()
 
void HideTooltips ()
 
Vector2 GetPositionAbsolute ()
 
Vector2 GetPositionAbsoluteCenter ()
 
Vector2 GetPositionAbsoluteTopLeft ()
 
bool GetDrawMouseCursor ()
 
bool IsTopMostScreen ()
 
bool IsAlwaysFirst ()
 
bool IsTopScreen ()
 
bool IsFirstForUnload ()
 
bool GetDrawScreenEvenWithoutFocus ()
 
Vector2 GetPosition ()
 
Vector2 GetSize ()
 
bool CanShareInput ()
 
bool CanCloseInCloseAllScreenCalls ()
 
virtual int GetTransitionOpeningTime ()
 
virtual int GetTransitionClosingTime ()
 
virtual void OnRemoved ()
 Called when [show]. More...
 

Protected Member Functions

MyGuiControlCompositePanel AddCompositePanel (MyGuiCompositeTexture texture, Vector2 position, Vector2 size, MyGuiDrawAlignEnum panelAlign)
 
virtual MyGuiControlMultilineText AddMultilineText (Vector2?size=null, Vector2?offset=null, float textScale=1.0f, bool selectable=false, MyGuiDrawAlignEnum textAlign=MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_TOP, MyGuiDrawAlignEnum textBoxAlign=MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_TOP)
 
override void Canceling ()
 Called when user presses ESC or clicks on CANCEL - hook to this method so you can do gui-screen-specific event More...
 
void CallResultCallback (ResultEnum result)
 
- Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
 MyGuiScreenBase (Vector2?position=null, Vector4?backgroundColor=null, Vector2?size=null, bool isTopMostScreen=false, string backgroundTexture=null, float backgroundTransition=0.0f, float guiTransition=0.0f)
 
bool HandleKeyboardActiveIndex (bool forwardMovement)
 
bool IsMouseOver ()
 
MyGuiControlLabel AddCaption (MyStringId textEnum, Vector4?captionTextColor=null, Vector2?captionOffset=null, float captionScale=MyGuiConstants.DEFAULT_TEXT_SCALE)
 
MyGuiControlLabel AddCaption (String text, Vector4?captionTextColor=null, Vector2?captionOffset=null, float captionScale=MyGuiConstants.DEFAULT_TEXT_SCALE)
 
Color ApplyTransitionAlpha (Vector4 color, float transition)
 
virtual void OnShow ()
 Called when [show]. More...
 
virtual void OnHide ()
 Called when [show]. More...
 
virtual void OnClosed ()
 Called when [show]. More...
 
void MakeXAndYEqual (ref Vector2 val)
 Computes ratio of width and height in GUI coordinates to make X and Y of equal value represent same distance on screen as well. Then multiplies Y using this ratio. More...
 
Vector2 MakeXAndYEqual (Vector2 val)
 
void SetDefaultCloseButtonOffset ()
 

Protected Attributes

Vector2 m_descSize
 
string m_description = ""
 
bool m_enableEdit = false
 
MyGuiControlLabel m_titleLabel
 
MyGuiControlMultilineText m_descriptionBox
 
MyGuiControlButton m_okButton
 
MyGuiControlCompositePanel m_descriptionBackgroundPanel = null
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnEnterCallback
 
float m_transitionAlpha
 
float m_backgroundTransition
 
float m_guiTransition
 
Vector2 m_position
 
Color m_backgroundFadeColor
 
bool m_isTopMostScreen = false
 
bool m_isAlwaysFirst = false
 
bool m_isTopScreen = false
 
bool m_isFirstForUnload = false
 
Vector4 m_backgroundColor
 
string m_backgroundTexture
 
bool m_canCloseInCloseAllScreenCalls = true
 
Vector2 m_size
 
bool m_closeOnEsc = true
 
bool m_joystickAsMouse = true
 
bool m_defaultJoystickDpadUse = true
 
bool m_defaultJoystickCancelUse = true
 
bool m_drawEvenWithoutFocus = false
 
bool m_canShareInput = false
 
bool m_allowUnhidePreviousScreen
 
GuiSounds m_openingCueEnum
 
GuiSounds m_closingCueEnum
 
MyGuiControlGridDragAndDrop m_gridDragAndDropHandlingNow
 
MyGuiControlBase m_comboboxHandlingNow
 
MyGuiControlBase m_lastHandlingControl
 

Properties

MyGuiControlMultilineText Description [get]
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Color BackgroundFadeColor [get]
 
bool SkipTransition [get, set]
 
bool Cancelled [get]
 
bool DrawMouseCursor [get, set]
 
bool JoystickAsMouse [get, set]
 
MyGuiScreenState State [get, set]
 
bool IsLoaded [get, set]
 
bool EnabledBackgroundFade [get, protected set]
 Draw fade rectangle under top-most screen? More...
 
bool CanBeHidden [get, protected set]
 Indicates whether screen can be hidden when another screen is on top of it (assuming that screen hides screens below it). More...
 
bool CanHideOthers [get, protected set]
 Indicates whether screen can hide screens below it. This will not hide screens that cannot be hidden. More...
 
bool CanHaveFocus [get, protected set]
 Without focus, this screen will not steal input. More...
 
virtual MyGuiControls Controls [get]
 
Vector4 BackgroundColor [get, set]
 
Vector2 Size [get, set]
 
bool Visible [get]
 
Vector2 CloseButtonOffset [get, set]
 
bool CloseButtonEnabled [get, set]
 
MyGuiControlBase FocusedControl [get, set]
 
string DebugNamePath [get]
 
string Name [get]
 
IMyGuiControlsOwner Owner [get]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsParent
MyGuiControls Controls [get]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsOwner
string DebugNamePath [get]
 
string Name [get]
 
IMyGuiControlsOwner Owner [get]
 

Additional Inherited Members

- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnLoadingAction
 
readonly MyGuiControls Elements
 
- Static Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
static string MakeScreenFilepath (string name)
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
ScreenHandler Closed
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiScreenBaseDataLoading
 
Action< MyGuiScreenBaseDataUnloading
 

Detailed Description

Definition at line 42 of file MyGuiScreenText.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyGuiScreenText.MyGuiScreenText ( string  missionTitle = null,
string  currentObjectivePrefix = null,
string  currentObjective = null,
string  description = null,
Action< ResultEnum resultCallback = null,
string  okButtonCaption = null,
Vector2 windowSize = null,
Vector2 descSize = null,
bool  editEnabled = false,
bool  canHideOthers = true,
bool  enableBackgroundFade = false,
MyMissionScreenStyleEnum  style = MyMissionScreenStyleEnum.BLUE 
)
inline

Definition at line 104 of file MyGuiScreenText.cs.

Member Function Documentation

MyGuiControlCompositePanel Sandbox.Game.Gui.MyGuiScreenText.AddCompositePanel ( MyGuiCompositeTexture  texture,
Vector2  position,
Vector2  size,
MyGuiDrawAlignEnum  panelAlign 
)
inlineprotected

Definition at line 190 of file MyGuiScreenText.cs.

virtual MyGuiControlMultilineText Sandbox.Game.Gui.MyGuiScreenText.AddMultilineText ( Vector2 size = null,
Vector2 offset = null,
float  textScale = 1.0f,
bool  selectable = false,
MyGuiDrawAlignEnum  textAlign = MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_TOP,
MyGuiDrawAlignEnum  textBoxAlign = MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_TOP 
)
inlineprotectedvirtual

Reimplemented in Sandbox.Game.Gui.MyGuiScreenEditor.

Definition at line 204 of file MyGuiScreenText.cs.

void Sandbox.Game.Gui.MyGuiScreenText.AppendTextToDescription ( string  text,
Vector4  color,
string  font = MyFontEnum.White,
float  scale = 1.0f 
)
inline

Definition at line 261 of file MyGuiScreenText.cs.

void Sandbox.Game.Gui.MyGuiScreenText.AppendTextToDescription ( string  text,
string  font = MyFontEnum.White,
float  scale = 1.0f 
)
inline

Definition at line 267 of file MyGuiScreenText.cs.

void Sandbox.Game.Gui.MyGuiScreenText.CallResultCallback ( ResultEnum  result)
inlineprotected

Definition at line 293 of file MyGuiScreenText.cs.

override void Sandbox.Game.Gui.MyGuiScreenText.Canceling ( )
inlineprotectedvirtual

Called when user presses ESC or clicks on CANCEL - hook to this method so you can do gui-screen-specific event

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 282 of file MyGuiScreenText.cs.

override bool Sandbox.Game.Gui.MyGuiScreenText.CloseScreen ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 287 of file MyGuiScreenText.cs.

override string Sandbox.Game.Gui.MyGuiScreenText.GetFriendlyName ( )
inlinevirtual

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 154 of file MyGuiScreenText.cs.

override void Sandbox.Game.Gui.MyGuiScreenText.RecreateControls ( bool  constructor)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 159 of file MyGuiScreenText.cs.

void Sandbox.Game.Gui.MyGuiScreenText.SetCurrentObjective ( string  objective)
inline

Definition at line 248 of file MyGuiScreenText.cs.

void Sandbox.Game.Gui.MyGuiScreenText.SetCurrentObjectivePrefix ( string  prefix)
inline

Definition at line 273 of file MyGuiScreenText.cs.

void Sandbox.Game.Gui.MyGuiScreenText.SetDescription ( string  desc)
inline

Definition at line 254 of file MyGuiScreenText.cs.

void Sandbox.Game.Gui.MyGuiScreenText.SetOkButtonCaption ( string  caption)
inline

Definition at line 277 of file MyGuiScreenText.cs.

void Sandbox.Game.Gui.MyGuiScreenText.SetTitle ( string  title)
inline

Definition at line 242 of file MyGuiScreenText.cs.

Member Data Documentation

string Sandbox.Game.Gui.MyGuiScreenText.m_description = ""
protected

Definition at line 64 of file MyGuiScreenText.cs.

MyGuiControlCompositePanel Sandbox.Game.Gui.MyGuiScreenText.m_descriptionBackgroundPanel = null
protected

Definition at line 72 of file MyGuiScreenText.cs.

MyGuiControlMultilineText Sandbox.Game.Gui.MyGuiScreenText.m_descriptionBox
protected

Definition at line 70 of file MyGuiScreenText.cs.

Vector2 Sandbox.Game.Gui.MyGuiScreenText.m_descSize
protected

Definition at line 58 of file MyGuiScreenText.cs.

bool Sandbox.Game.Gui.MyGuiScreenText.m_enableEdit = false
protected

Definition at line 65 of file MyGuiScreenText.cs.

MyGuiControlButton Sandbox.Game.Gui.MyGuiScreenText.m_okButton
protected

Definition at line 71 of file MyGuiScreenText.cs.

MyGuiControlLabel Sandbox.Game.Gui.MyGuiScreenText.m_titleLabel
protected

Definition at line 68 of file MyGuiScreenText.cs.

Property Documentation

MyGuiControlMultilineText Sandbox.Game.Gui.MyGuiScreenText.Description
get

Definition at line 78 of file MyGuiScreenText.cs.


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