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

Public Types

enum  MySoundModeEnum { MySoundModeEnum.Arcade, MySoundModeEnum.Realistic }
 

Public Member Functions

 MyGuiScreenWorldSettings ()
 
 MyGuiScreenWorldSettings (MyObjectBuilder_Checkpoint checkpoint, string path)
 
override bool CloseScreen ()
 
override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
override void RecreateControls (bool constructor)
 
void UpdateAsteroidAmountEnabled (bool enabled)
 
- 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...
 

Static Public Member Functions

static Vector2 CalcSize (MyObjectBuilder_Checkpoint checkpoint)
 

Static Public Attributes

static MyGuiScreenWorldSettings Static
 

Protected Member Functions

virtual void BuildControls ()
 
virtual MyObjectBuilder_SessionSettings GetDefaultSettings ()
 
virtual MyObjectBuilder_SessionSettings CopySettings (MyObjectBuilder_SessionSettings source)
 
virtual void GetSettingsFromControls ()
 
virtual void SetSettingsToControls ()
 
- 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 ()
 

Protected Attributes

bool m_isNewGame
 
MyObjectBuilder_SessionSettings m_settings
 
- 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

MyObjectBuilder_SessionSettings Settings [get]
 
MyObjectBuilder_Checkpoint Checkpoint [get]
 
int AsteroidAmount [get, 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 29 of file MyGuiScreenWorldSettings.cs.

Member Enumeration Documentation

Enumerator
Arcade 
Realistic 

Definition at line 55 of file MyGuiScreenWorldSettings.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyGuiScreenWorldSettings.MyGuiScreenWorldSettings ( )
inline

Definition at line 124 of file MyGuiScreenWorldSettings.cs.

Sandbox.Game.Gui.MyGuiScreenWorldSettings.MyGuiScreenWorldSettings ( MyObjectBuilder_Checkpoint  checkpoint,
string  path 
)
inline

Definition at line 130 of file MyGuiScreenWorldSettings.cs.

Member Function Documentation

virtual void Sandbox.Game.Gui.MyGuiScreenWorldSettings.BuildControls ( )
inlineprotectedvirtual

Definition at line 209 of file MyGuiScreenWorldSettings.cs.

static Vector2 Sandbox.Game.Gui.MyGuiScreenWorldSettings.CalcSize ( MyObjectBuilder_Checkpoint  checkpoint)
inlinestatic

Definition at line 153 of file MyGuiScreenWorldSettings.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 161 of file MyGuiScreenWorldSettings.cs.

virtual MyObjectBuilder_SessionSettings Sandbox.Game.Gui.MyGuiScreenWorldSettings.CopySettings ( MyObjectBuilder_SessionSettings  source)
inlineprotectedvirtual

Definition at line 590 of file MyGuiScreenWorldSettings.cs.

virtual MyObjectBuilder_SessionSettings Sandbox.Game.Gui.MyGuiScreenWorldSettings.GetDefaultSettings ( )
inlineprotectedvirtual

Definition at line 585 of file MyGuiScreenWorldSettings.cs.

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

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 180 of file MyGuiScreenWorldSettings.cs.

virtual void Sandbox.Game.Gui.MyGuiScreenWorldSettings.GetSettingsFromControls ( )
inlineprotectedvirtual

Definition at line 779 of file MyGuiScreenWorldSettings.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 185 of file MyGuiScreenWorldSettings.cs.

virtual void Sandbox.Game.Gui.MyGuiScreenWorldSettings.SetSettingsToControls ( )
inlineprotectedvirtual

Definition at line 794 of file MyGuiScreenWorldSettings.cs.

void Sandbox.Game.Gui.MyGuiScreenWorldSettings.UpdateAsteroidAmountEnabled ( bool  enabled)
inline

Definition at line 944 of file MyGuiScreenWorldSettings.cs.

Member Data Documentation

bool Sandbox.Game.Gui.MyGuiScreenWorldSettings.m_isNewGame
protected

Definition at line 40 of file MyGuiScreenWorldSettings.cs.

MyObjectBuilder_SessionSettings Sandbox.Game.Gui.MyGuiScreenWorldSettings.m_settings
protected

Definition at line 44 of file MyGuiScreenWorldSettings.cs.

MyGuiScreenWorldSettings Sandbox.Game.Gui.MyGuiScreenWorldSettings.Static
static

Definition at line 32 of file MyGuiScreenWorldSettings.cs.

Property Documentation

int Sandbox.Game.Gui.MyGuiScreenWorldSettings.AsteroidAmount
getset

Definition at line 82 of file MyGuiScreenWorldSettings.cs.

MyObjectBuilder_Checkpoint Sandbox.Game.Gui.MyGuiScreenWorldSettings.Checkpoint
get

Definition at line 65 of file MyGuiScreenWorldSettings.cs.

MyObjectBuilder_SessionSettings Sandbox.Game.Gui.MyGuiScreenWorldSettings.Settings
get

Definition at line 46 of file MyGuiScreenWorldSettings.cs.


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