Space Engineers
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Sandbox.Game.Screens.MyGuiScreenBriefing Class Reference
Inheritance diagram for Sandbox.Game.Screens.MyGuiScreenBriefing:
Sandbox.Graphics.GUI.MyGuiScreenBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner

Public Member Functions

 MyGuiScreenBriefing ()
 
override void RecreateControls (bool constructor)
 
override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
override bool Update (bool hasFocus)
 
- 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 CloseScreen ()
 
virtual bool HideScreen ()
 
virtual bool UnhideScreen ()
 
virtual void CloseScreenNow ()
 
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...
 

Static Public Attributes

static MyGuiScreenBriefing Static
 

Protected Member Functions

virtual void OnOkClicked (MyGuiControlButton sender)
 
override void OnClosed ()
 Called when [show]. More...
 
- 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)
 
virtual void Canceling ()
 Called when user presses ESC or clicks on CANCEL - hook to this method so you can do gui-screen-specific event More...
 
Color ApplyTransitionAlpha (Vector4 color, float transition)
 
virtual void OnShow ()
 Called when [show]. More...
 
virtual void OnHide ()
 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

MyGuiControlButton m_okButton
 
- 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

string Briefing [set]
 
- 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 17 of file MyGuiScreenBriefing.cs.

Constructor & Destructor Documentation

Sandbox.Game.Screens.MyGuiScreenBriefing.MyGuiScreenBriefing ( )
inline

Definition at line 34 of file MyGuiScreenBriefing.cs.

Member Function Documentation

override string Sandbox.Game.Screens.MyGuiScreenBriefing.GetFriendlyName ( )
inlinevirtual

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 70 of file MyGuiScreenBriefing.cs.

override void Sandbox.Game.Screens.MyGuiScreenBriefing.OnClosed ( )
inlineprotectedvirtual

Called when [show].

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 86 of file MyGuiScreenBriefing.cs.

virtual void Sandbox.Game.Screens.MyGuiScreenBriefing.OnOkClicked ( MyGuiControlButton  sender)
inlineprotectedvirtual

Definition at line 80 of file MyGuiScreenBriefing.cs.

override void Sandbox.Game.Screens.MyGuiScreenBriefing.RecreateControls ( bool  constructor)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 42 of file MyGuiScreenBriefing.cs.

override bool Sandbox.Game.Screens.MyGuiScreenBriefing.Update ( bool  hasFocus)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 75 of file MyGuiScreenBriefing.cs.

Member Data Documentation

MyGuiControlButton Sandbox.Game.Screens.MyGuiScreenBriefing.m_okButton
protected

Definition at line 24 of file MyGuiScreenBriefing.cs.

MyGuiScreenBriefing Sandbox.Game.Screens.MyGuiScreenBriefing.Static
static

Definition at line 19 of file MyGuiScreenBriefing.cs.

Property Documentation

string Sandbox.Game.Screens.MyGuiScreenBriefing.Briefing
set

Definition at line 27 of file MyGuiScreenBriefing.cs.


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