Inheritance diagram for Sandbox.Game.Screens.MyGuiScreenScenarioBase:

Public Member Functions
	MyGuiScreenScenarioBase ()

override void	RecreateControls (bool constructor)

override bool	Update (bool hasFocus)

override bool	Draw ()

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 ()

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 ()

abstract string	GetFriendlyName ()
	For displaying in the list in the debug screen. More...

virtual int	GetTransitionOpeningTime ()

virtual int	GetTransitionClosingTime ()

virtual void	OnRemoved ()
	Called when [show]. More...

Protected Types
enum	StateEnum { StateEnum.ListNeedsReload, StateEnum.ListLoading, StateEnum.ListLoaded }

Protected Member Functions
virtual void	BuildControls ()

virtual MyGuiControlTable	CreateScenarioTable ()

MyGuiControlLabel	MakeLabel (MyStringId textEnum)

virtual void	SetDefaultValues ()

void	OnOkButtonClick (object sender)

virtual void	OnTableItemSelected (MyGuiControlTable sender, MyGuiControlTable.EventArgs eventArgs)

override void	OnShow ()
	Called when [show]. More...

void	FillRight ()

virtual void	FillList ()

void	AddSave (Tuple< string, MyWorldInfo > save)

void	AddSaves (List< Tuple< string, MyWorldInfo >> saves)

void	ClearSaves ()

void	RefreshGameList ()

Tuple< string, MyWorldInfo >	FindSave (MyGuiControlTable.Row row)

virtual MyGuiHighlightTexture	GetIcon (Tuple< string, MyWorldInfo > save)

virtual void	LoadSandboxInternal (Tuple< string, MyWorldInfo > save, bool MP)

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	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
StateEnum	m_state

MyGuiControlTextbox	m_nameTextbox

MyGuiControlButton	m_okButton

MyGuiControlTable	m_scenarioTable

MyGuiControlMultilineText	m_descriptionBox

MyLayoutTable	m_sideMenuLayout

MyLayoutTable	m_buttonsLayout

int	m_selectedRow

const float	MARGIN_TOP = 0.1f

const float	MARGIN_LEFT = 0.42f

const string	WORKSHOP_PATH_TAG = "workshop"

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
abstract MyStringId	ScreenCaption `[get]`

abstract bool	IsOnlineMode `[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< MyGuiScreenBase >	DataLoading

Action< MyGuiScreenBase >	DataUnloading

Detailed Description

Definition at line 21 of file MyGuiScreenScenarioBase.cs.

Member Enumeration Documentation

enum Sandbox.Game.Screens.MyGuiScreenScenarioBase.StateEnum

protected

Enumerator
ListNeedsReload
ListLoading
ListLoaded

Definition at line 23 of file MyGuiScreenScenarioBase.cs.

Constructor & Destructor Documentation

Sandbox.Game.Screens.MyGuiScreenScenarioBase.MyGuiScreenScenarioBase ( )

inline

Definition at line 47 of file MyGuiScreenScenarioBase.cs.

Member Function Documentation

void Sandbox.Game.Screens.MyGuiScreenScenarioBase.AddSave ( Tuple< string, MyWorldInfo > save )

inlineprotected

Definition at line 288 of file MyGuiScreenScenarioBase.cs.

void Sandbox.Game.Screens.MyGuiScreenScenarioBase.AddSaves ( List< Tuple< string, MyWorldInfo >> saves )

inlineprotected

Definition at line 293 of file MyGuiScreenScenarioBase.cs.

virtual void Sandbox.Game.Screens.MyGuiScreenScenarioBase.BuildControls ( )

inlineprotectedvirtual

Reimplemented in Sandbox.Game.Gui.MyGuiScreenScenario, and Sandbox.Game.Gui.MyGuiScreenTutorial.

Definition at line 71 of file MyGuiScreenScenarioBase.cs.

void Sandbox.Game.Screens.MyGuiScreenScenarioBase.ClearSaves ( )

inlineprotected

Definition at line 298 of file MyGuiScreenScenarioBase.cs.

virtual MyGuiControlTable Sandbox.Game.Screens.MyGuiScreenScenarioBase.CreateScenarioTable ( )

inlineprotectedvirtual

Reimplemented in Sandbox.Game.Gui.MyGuiScreenTutorial.

Definition at line 161 of file MyGuiScreenScenarioBase.cs.

override bool Sandbox.Game.Screens.MyGuiScreenScenarioBase.Draw ( )

inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 249 of file MyGuiScreenScenarioBase.cs.

virtual void Sandbox.Game.Screens.MyGuiScreenScenarioBase.FillList ( )

inlineprotectedvirtual

Reimplemented in Sandbox.Game.Gui.MyGuiScreenScenario, and Sandbox.Game.Gui.MyGuiScreenTutorial.

Definition at line 283 of file MyGuiScreenScenarioBase.cs.

void Sandbox.Game.Screens.MyGuiScreenScenarioBase.FillRight ( )

inlineprotected

Definition at line 266 of file MyGuiScreenScenarioBase.cs.

Tuple<string, MyWorldInfo> Sandbox.Game.Screens.MyGuiScreenScenarioBase.FindSave ( MyGuiControlTable.Row row )

inlineprotected

Definition at line 330 of file MyGuiScreenScenarioBase.cs.

virtual MyGuiHighlightTexture Sandbox.Game.Screens.MyGuiScreenScenarioBase.GetIcon ( Tuple< string, MyWorldInfo > save )

inlineprotectedvirtual

Reimplemented in Sandbox.Game.Gui.MyGuiScreenScenario.

Definition at line 336 of file MyGuiScreenScenarioBase.cs.

virtual void Sandbox.Game.Screens.MyGuiScreenScenarioBase.LoadSandboxInternal	(	Tuple< string, MyWorldInfo >	save,
		bool	MP
	)

inlineprotectedvirtual

Reimplemented in Sandbox.Game.Gui.MyGuiScreenScenario, and Sandbox.Game.Gui.MyGuiScreenTutorial.

Definition at line 357 of file MyGuiScreenScenarioBase.cs.

MyGuiControlLabel Sandbox.Game.Screens.MyGuiScreenScenarioBase.MakeLabel ( MyStringId textEnum )

inlineprotected

Definition at line 176 of file MyGuiScreenScenarioBase.cs.

void Sandbox.Game.Screens.MyGuiScreenScenarioBase.OnOkButtonClick ( object sender )

inlineprotected

Definition at line 189 of file MyGuiScreenScenarioBase.cs.

override void Sandbox.Game.Screens.MyGuiScreenScenarioBase.OnShow ( )

inlineprotectedvirtual

Called when [show].

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 258 of file MyGuiScreenScenarioBase.cs.

virtual void Sandbox.Game.Screens.MyGuiScreenScenarioBase.OnTableItemSelected	(	MyGuiControlTable	sender,
		MyGuiControlTable.EventArgs	eventArgs
	)

inlineprotectedvirtual

Reimplemented in Sandbox.Game.Gui.MyGuiScreenScenario.

Definition at line 226 of file MyGuiScreenScenarioBase.cs.

override void Sandbox.Game.Screens.MyGuiScreenScenarioBase.RecreateControls ( bool constructor )

inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 63 of file MyGuiScreenScenarioBase.cs.

void Sandbox.Game.Screens.MyGuiScreenScenarioBase.RefreshGameList ( )

inlineprotected

Definition at line 303 of file MyGuiScreenScenarioBase.cs.

virtual void Sandbox.Game.Screens.MyGuiScreenScenarioBase.SetDefaultValues ( )

inlineprotectedvirtual

Reimplemented in Sandbox.Game.Gui.MyGuiScreenScenario.

Definition at line 184 of file MyGuiScreenScenarioBase.cs.

override bool Sandbox.Game.Screens.MyGuiScreenScenarioBase.Update ( bool hasFocus )

inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Reimplemented in Sandbox.Game.Gui.MyGuiScreenTutorial.

Definition at line 232 of file MyGuiScreenScenarioBase.cs.

Member Data Documentation

MyLayoutTable Sandbox.Game.Screens.MyGuiScreenScenarioBase.m_buttonsLayout

protected

Definition at line 37 of file MyGuiScreenScenarioBase.cs.

MyGuiControlMultilineText Sandbox.Game.Screens.MyGuiScreenScenarioBase.m_descriptionBox

protected

Definition at line 34 of file MyGuiScreenScenarioBase.cs.

MyGuiControlTextbox Sandbox.Game.Screens.MyGuiScreenScenarioBase.m_nameTextbox

protected

Definition at line 31 of file MyGuiScreenScenarioBase.cs.

MyGuiControlButton Sandbox.Game.Screens.MyGuiScreenScenarioBase.m_okButton

protected

Definition at line 32 of file MyGuiScreenScenarioBase.cs.

MyGuiControlTable Sandbox.Game.Screens.MyGuiScreenScenarioBase.m_scenarioTable

protected

Definition at line 33 of file MyGuiScreenScenarioBase.cs.

int Sandbox.Game.Screens.MyGuiScreenScenarioBase.m_selectedRow

protected

Definition at line 39 of file MyGuiScreenScenarioBase.cs.

MyLayoutTable Sandbox.Game.Screens.MyGuiScreenScenarioBase.m_sideMenuLayout

protected

Definition at line 36 of file MyGuiScreenScenarioBase.cs.

StateEnum Sandbox.Game.Screens.MyGuiScreenScenarioBase.m_state

protected

Definition at line 29 of file MyGuiScreenScenarioBase.cs.

const float Sandbox.Game.Screens.MyGuiScreenScenarioBase.MARGIN_LEFT = 0.42f

protected

Definition at line 42 of file MyGuiScreenScenarioBase.cs.

const float Sandbox.Game.Screens.MyGuiScreenScenarioBase.MARGIN_TOP = 0.1f

protected

Definition at line 41 of file MyGuiScreenScenarioBase.cs.

const string Sandbox.Game.Screens.MyGuiScreenScenarioBase.WORKSHOP_PATH_TAG = "workshop"

protected

Definition at line 43 of file MyGuiScreenScenarioBase.cs.

Property Documentation

abstract bool Sandbox.Game.Screens.MyGuiScreenScenarioBase.IsOnlineMode

getprotected

Definition at line 182 of file MyGuiScreenScenarioBase.cs.

abstract MyStringId Sandbox.Game.Screens.MyGuiScreenScenarioBase.ScreenCaption

getprotected

Definition at line 181 of file MyGuiScreenScenarioBase.cs.

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

Sources/Sandbox.Game/Game/Screens/MyGuiScreenScenarioBase.cs

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation