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

Public Member Functions

 MyGuiScreenScenarioMpBase ()
 
override void RecreateControls (bool constructor)
 
override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
override bool Update (bool hasFocus)
 
void MySyncScenario_PlayerReady (ulong Id)
 
void MySyncScenario_SetTimeout (int index)
 
void MySyncScenario_SetCanJoinRunning (bool canJoin)
 
- 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 MyGuiScreenScenarioMpBase Static
 

Protected Member Functions

virtual void OnStartClicked (MyGuiControlButton sender)
 
override void OnClosed ()
 Called when [show]. More...
 
bool CanKick ()
 
- 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_kickPlayerButton
 
MyGuiControlTable m_connectedPlayers
 
MyGuiControlCheckbox m_canJoinRunning
 
MyHudControlChat m_chatControl
 
MyGuiControlTextbox m_chatTextbox
 
MyGuiControlButton m_sendChatButton
 
MyGuiControlButton m_startButton
 
- 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
 

Static Protected Attributes

static HashSet< ulong > m_readyPlayers = new HashSet<ulong>()
 

Properties

MyGuiControlCombobox TimeoutCombo [get, protected set]
 
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 29 of file MyGuiScreenScenarioMpBase.cs.

Constructor & Destructor Documentation

Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.MyGuiScreenScenarioMpBase ( )
inline

Definition at line 65 of file MyGuiScreenScenarioMpBase.cs.

Member Function Documentation

bool Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.CanKick ( )
inlineprotected

Definition at line 255 of file MyGuiScreenScenarioMpBase.cs.

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

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 192 of file MyGuiScreenScenarioMpBase.cs.

void Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.MySyncScenario_PlayerReady ( ulong  Id)
inline

Definition at line 225 of file MyGuiScreenScenarioMpBase.cs.

void Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.MySyncScenario_SetCanJoinRunning ( bool  canJoin)
inline

Definition at line 292 of file MyGuiScreenScenarioMpBase.cs.

void Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.MySyncScenario_SetTimeout ( int  index)
inline

Definition at line 280 of file MyGuiScreenScenarioMpBase.cs.

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

Called when [show].

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Reimplemented in Sandbox.Game.Screens.MyGuiScreenScenarioMpClient.

Definition at line 212 of file MyGuiScreenScenarioMpBase.cs.

virtual void Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.OnStartClicked ( MyGuiControlButton  sender)
inlineprotectedvirtual
override void Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.RecreateControls ( bool  constructor)
inlinevirtual
override bool Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.Update ( bool  hasFocus)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 197 of file MyGuiScreenScenarioMpBase.cs.

Member Data Documentation

MyGuiControlCheckbox Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.m_canJoinRunning
protected

Definition at line 40 of file MyGuiScreenScenarioMpBase.cs.

MyHudControlChat Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.m_chatControl
protected

Definition at line 42 of file MyGuiScreenScenarioMpBase.cs.

MyGuiControlTextbox Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.m_chatTextbox
protected

Definition at line 43 of file MyGuiScreenScenarioMpBase.cs.

MyGuiControlTable Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.m_connectedPlayers
protected

Definition at line 35 of file MyGuiScreenScenarioMpBase.cs.

MyGuiControlButton Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.m_kickPlayerButton
protected

Definition at line 34 of file MyGuiScreenScenarioMpBase.cs.

HashSet<ulong> Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.m_readyPlayers = new HashSet<ulong>()
staticprotected

Definition at line 62 of file MyGuiScreenScenarioMpBase.cs.

MyGuiControlButton Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.m_sendChatButton
protected

Definition at line 44 of file MyGuiScreenScenarioMpBase.cs.

MyGuiControlButton Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.m_startButton
protected

Definition at line 46 of file MyGuiScreenScenarioMpBase.cs.

MyGuiScreenScenarioMpBase Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.Static
static

Definition at line 31 of file MyGuiScreenScenarioMpBase.cs.

Property Documentation

string Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.Briefing
set

Definition at line 56 of file MyGuiScreenScenarioMpBase.cs.

MyGuiControlCombobox Sandbox.Game.Screens.MyGuiScreenScenarioMpBase.TimeoutCombo
getprotected set

Definition at line 37 of file MyGuiScreenScenarioMpBase.cs.


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