VerticesEngine.vxSaveBusyScreen3D Class Reference

The save busy screen for 3D Scene. More...

Inheritance diagram for VerticesEngine.vxSaveBusyScreen3D:

Public Member Functions
	vxSaveBusyScreen3D (vxGameplayScene3D Scene)
	Initializes a new instance of the T:VerticesEngine.vxSaveBusyScreen class.
override string	SaveFile (vxGameplaySceneBase sceneBase, bool IsWorkshop=false)
	Saves the file and returns the file path.
override void	OnAsyncWriteSaveFile (object sender, DoWorkEventArgs e)
Public Member Functions inherited from VerticesEngine.vxSaveBusyScreen
	vxSaveBusyScreen (vxGameplaySceneBase Scene)
	Initializes a new instance of the T:VerticesEngine.vxSaveBusyScreen class.
void	StartSave ()
virtual void	OnAsyncSaveFileWriter_ProgressChanged (object sender, ProgressChangedEventArgs e)
virtual void	OnAsyncWriteSaveFile (object sender, System.ComponentModel.DoWorkEventArgs e)
	The Async File Save Writer, override this to provide your own custom saving.
override void	Draw ()
	Draws the message box.
Public Member Functions inherited from VerticesEngine.UI.MessageBoxs.vxMessageBox
	vxMessageBox (string message, string title)
	Constructor lets the caller specify whether to include the standard "A=ok, B=cancel" usage text prompt.
	vxMessageBox (string message, string title, vxEnumButtonTypes ButtonTypes)
virtual void	SetButtonText ()
	Sets the button text.
override void	LoadContent ()
	Loads graphics content for this screen. This uses the shared ContentManager provided by the Game class, so the content will remain loaded forever. Whenever a subsequent MessageBoxScreen tries to load this same content, it will just get back another reference to the already loaded data.
override void	UnloadContent ()
	Unload content for the screen.
virtual void	OnApplyButtonClicked (object sender, VerticesEngine.UI.Events.vxUIControlClickEventArgs e)
	Buttons the apply clicked.
virtual void	OnOKButtonClicked (object sender, VerticesEngine.UI.Events.vxUIControlClickEventArgs e)
	Raise the accepted event, then exit the message box.
virtual void	OnCancelButtonClicked (object sender, VerticesEngine.UI.Events.vxUIControlClickEventArgs e)
void	OnCancel ()
virtual void	OnButtonPositionSet ()
virtual void	SetArtProvider (vxMessageBoxArtProvider NewArtProvider)
Public Member Functions inherited from VerticesEngine.vxBaseScene
virtual System.Collections.IEnumerator	LoadContentAsync ()
	Loads content as part of a Coroutine allowing the game to update frames during the loading process.
virtual bool	PlaySound (vxBaseScene sender, SoundEffect SoundEffect, float Volume=1, float Pitch=0)
void	ExitScreen ()
	Tells the screen to go away. Unlike ScreenManager.RemoveScreen, which instantly kills the screen, this method respects the transition timings and will give the screen a chance to gradually transition off.
virtual void	Dispose ()

Protected Member Functions
virtual void	ReportProgress (int perc)
Protected Member Functions inherited from VerticesEngine.vxSaveBusyScreen
virtual void	OnFinished (bool success)
Protected Member Functions inherited from VerticesEngine.vxBaseScene
virtual void	OnFirstUpdate ()
	Called at the start of this scenes first update/tick.
virtual void	OnFirstDraw ()
	Called on the first draw of this scene.

Additional Inherited Members
Static Public Member Functions inherited from VerticesEngine.UI.MessageBoxs.vxMessageBox
static vxMessageBox	Show (string title, string text, vxEnumButtonTypes buttonTypes=vxEnumButtonTypes.Ok)
	Shows a Message Box.
Public Attributes inherited from VerticesEngine.vxSaveBusyScreen
BackgroundWorker	SaveFileAsyncWriter
Public Attributes inherited from VerticesEngine.UI.MessageBoxs.vxMessageBox
string	Message
	Main text for the Message box.
string	Title
	Message Box Title.
vxUIManager	InternalGUIManager
	Message Box GUI Manager.
vxButtonControl	ApplyButton
vxButtonControl	OKButton
vxButtonControl	CancelButton
vxEnumButtonTypes	ButtonTypes
	The button types for this Message Box.
bool	IsCustomButtonPosition = false
Protected Attributes inherited from VerticesEngine.vxBaseScene
bool	IsLoadingTimeMeasured = false
bool	HideIfCovered = true
Properties inherited from VerticesEngine.UI.MessageBoxs.vxMessageBox
vxMessageBoxArtProvider	ArtProvider [get, set]
	The given Art Provider of the Menu Entry.
Vector2	Padding [get]
	Gets the bounds of the art providers bounding GUI rectangle.
Rectangle	Bounds [get]
Properties inherited from VerticesEngine.vxBaseScene
bool	IsPopup [get, protected set]
	Normally when one screen is brought up over the top of another, the first screen will transition off to make room for the new one. This property indicates whether the screen is only a small popup, in which case screens underneath it do not need to bother transitioning off.
bool	IsRemoved [get, set]
	Has this scene been removed?
TimeSpan	TransitionOnTime [get, protected set]
	Indicates how long the screen takes to transition on when it is activated.
TimeSpan	TransitionOffTime [get, protected set]
	Indicates how long the screen takes to transition off when it is deactivated.
float	TransitionPosition [get, protected set]
	Gets the current position of the screen transition, ranging from zero (fully active, no transition) to one (transitioned fully off to nothing).
float	TransitionAlpha [get]
	Gets the current alpha of the screen transition, ranging from 1 (fully active, no transition) to 0 (transitioned fully off to nothing).
ScreenState	ScreenState [get, protected set]
	Gets the current screen transition state.
bool	IsExiting [get, set]
	There are two possible reasons why a screen might be transitioning off. It could be temporarily going away to make room for another screen that is on top of it, or it could be going away for good. This property indicates whether the screen is exiting for real: if set, the screen will automatically remove itself as soon as the transition finishes.
bool	IsActive [get]
	Checks whether this screen is active and can respond to user input.
bool	otherScreenHasFocus [get, set]
bool	IsFirstLoop [get]
	Gets a value indicating whether this T:VerticesEngine.vxGameBaseScreen is first loop.
bool	IsLoadingFile [get, set]
	Returns whether we're currently loading a file or not.
PlayerIndex?	ControllingPlayer [get, set]
	Gets the index of the player who is currently controlling this screen, or null if it is accepting input from any player. This is used to lock the game to a specific player profile. The main menu responds to input from any connected gamepad, but whichever player makes a selection from this menu is given control over all subsequent screens, so other gamepads are inactive until the controlling player returns to the main menu.
bool	IsContentLoaded [get, set]
	Has all the content been loaded yet?
bool	coveredByOtherScreen [get, set]
Events inherited from VerticesEngine.UI.MessageBoxs.vxMessageBox
EventHandler< PlayerIndexEventArgs >	Apply
	Occurs when apply. This can also act as a Miscelanous third button.
EventHandler< PlayerIndexEventArgs >	Accepted
	Occurs when accepted.
EventHandler< PlayerIndexEventArgs >	Cancelled
	Occurs when cancelled.

Detailed Description

The save busy screen for 3D Scene.

Member Function Documentation

SaveFile()

override string VerticesEngine.vxSaveBusyScreen3D.SaveFile ( vxGameplaySceneBase CurrentScene, bool IsWorkshop = false )

virtual

Saves the file and returns the file path.

Returns

The file.

Parameters

CurrentScene	Current scene.
IsWorkshop	If set to true is workshop.

Reimplemented from VerticesEngine.vxSaveBusyScreen.

---

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

• /github/workspace/src/VerticesEngine/src.shared/UI/Dialogs/Dialogs Async/vxSaveBusyScreen3D.cs