Space Engineers
Public Member Functions | Static Public Attributes | Events | List of all members
Sandbox.Game.Gui.MyGuiScreenLoading Class Reference
Inheritance diagram for Sandbox.Game.Gui.MyGuiScreenLoading:
Sandbox.Graphics.GUI.MyGuiScreenBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner

Public Member Functions

 MyGuiScreenLoading (MyGuiScreenGamePlay screenToLoad, MyGuiScreenGamePlay screenToUnload, string textureFromConstructor, string customText=null)
 
 MyGuiScreenLoading (MyGuiScreenGamePlay screenToLoad, MyGuiScreenGamePlay screenToUnload)
 
override void RecreateControls (bool constructor)
 
override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
override void LoadContent ()
 
override void UnloadContent ()
 
override bool Update (bool hasFocus)
 
override void HandleInput (bool receivedFocusInThisUpdate)
 
override bool Draw ()
 
override void OnRemoved ()
 Called when [show]. More...
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
delegate void ScreenHandler (MyGuiScreenBase source)
 
MyObjectBuilder_GuiScreen GetObjectBuilder ()
 
void Init (MyObjectBuilder_GuiScreen objectBuilder)
 
virtual void LoadData ()
 
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 InputLost ()
 
virtual void HandleUnhandledInput (bool receivedFocusInThisUpdate)
 
virtual bool HandleInputAfterSimulation ()
 
virtual bool CloseScreen ()
 
virtual bool HideScreen ()
 
virtual bool UnhideScreen ()
 
virtual void CloseScreenNow ()
 
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 ()
 

Static Public Attributes

static MyGuiScreenLoading Static
 
static string LastBackgroundTexture
 
static int m_currentQuoteIdx = 0
 

Events

Action OnScreenLoadingFinished
 Event created once the screen has been loaded and added to gui manager. More...
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
ScreenHandler Closed
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiScreenBaseDataLoading
 
Action< MyGuiScreenBaseDataUnloading
 

Additional Inherited Members

- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnLoadingAction
 
readonly MyGuiControls Elements
 
- 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...
 
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 ()
 
- Static Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
static string MakeScreenFilepath (string name)
 
- 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 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]
 

Detailed Description

Definition at line 30 of file MyGuiScreenLoading.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyGuiScreenLoading.MyGuiScreenLoading ( MyGuiScreenGamePlay  screenToLoad,
MyGuiScreenGamePlay  screenToUnload,
string  textureFromConstructor,
string  customText = null 
)
inline

Definition at line 65 of file MyGuiScreenLoading.cs.

Sandbox.Game.Gui.MyGuiScreenLoading.MyGuiScreenLoading ( MyGuiScreenGamePlay  screenToLoad,
MyGuiScreenGamePlay  screenToUnload 
)
inline

Definition at line 104 of file MyGuiScreenLoading.cs.

Member Function Documentation

override bool Sandbox.Game.Gui.MyGuiScreenLoading.Draw ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 438 of file MyGuiScreenLoading.cs.

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

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 148 of file MyGuiScreenLoading.cs.

override void Sandbox.Game.Gui.MyGuiScreenLoading.HandleInput ( bool  receivedFocusInThisUpdate)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 358 of file MyGuiScreenLoading.cs.

override void Sandbox.Game.Gui.MyGuiScreenLoading.LoadContent ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 153 of file MyGuiScreenLoading.cs.

override void Sandbox.Game.Gui.MyGuiScreenLoading.OnRemoved ( )
inlinevirtual

Called when [show].

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 454 of file MyGuiScreenLoading.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 109 of file MyGuiScreenLoading.cs.

override void Sandbox.Game.Gui.MyGuiScreenLoading.UnloadContent ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 199 of file MyGuiScreenLoading.cs.

override bool Sandbox.Game.Gui.MyGuiScreenLoading.Update ( bool  hasFocus)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 236 of file MyGuiScreenLoading.cs.

Member Data Documentation

string Sandbox.Game.Gui.MyGuiScreenLoading.LastBackgroundTexture
static

Definition at line 50 of file MyGuiScreenLoading.cs.

int Sandbox.Game.Gui.MyGuiScreenLoading.m_currentQuoteIdx = 0
static

Definition at line 57 of file MyGuiScreenLoading.cs.

MyGuiScreenLoading Sandbox.Game.Gui.MyGuiScreenLoading.Static
static

Definition at line 33 of file MyGuiScreenLoading.cs.

Event Documentation

Action Sandbox.Game.Gui.MyGuiScreenLoading.OnScreenLoadingFinished

Event created once the screen has been loaded and added to gui manager.

Definition at line 55 of file MyGuiScreenLoading.cs.


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