Space Engineers
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | List of all members
Sandbox.Game.Gui.MyGuiBlueprintScreenBase Class Reference
Inheritance diagram for Sandbox.Game.Gui.MyGuiBlueprintScreenBase:
Sandbox.Game.Gui.MyGuiScreenDebugBase Sandbox.Graphics.GUI.MyGuiScreenBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner Sandbox.Game.Gui.MyGuiBlueprintScreen Sandbox.Game.Gui.MyGuiBlueprintTextDialog Sandbox.Game.Gui.MyGuiDetailScreenBase Sandbox.Game.Gui.MyGuiDetailScreenScriptLocal Sandbox.Game.Gui.MyGuiDetailScreenDefault Sandbox.Game.Gui.MyGuiDetailScreenLocal Sandbox.Game.Gui.MyGuiDetailScreenSteam

Public Member Functions

 MyGuiBlueprintScreenBase (Vector2 position, Vector2 size, Vector4 backgroundColor, bool isTopMostScreen)
 
override bool CloseScreen ()
 
virtual void RefreshBlueprintList (bool fromTask=false)
 
- Public Member Functions inherited from Sandbox.Game.Gui.MyGuiScreenDebugBase
override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
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 HideScreen ()
 
virtual bool UnhideScreen ()
 
virtual void CloseScreenNow ()
 
virtual bool Update (bool hasFocus)
 
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 void RecreateControls (bool constructor)
 
virtual int GetTransitionOpeningTime ()
 
virtual int GetTransitionClosingTime ()
 
virtual void OnRemoved ()
 Called when [show]. More...
 

Static Public Member Functions

static void Publish (MyObjectBuilder_Definitions prefab, string blueprintName, Action< ulong > publishCallback=null)
 
static MyObjectBuilder_Definitions LoadWorkshopPrefab (string archive, ulong?publishedItemId)
 
static MyObjectBuilder_Definitions LoadPrefab (string filePath)
 

Static Public Attributes

static string m_localBlueprintFolder = Path.Combine(MyFileSystem.UserDataPath, "Blueprints", "local")
 
static string m_workshopBlueprintFolder = Path.Combine(MyFileSystem.UserDataPath, "Blueprints", "workshop")
 
static string m_defaultBlueprintFolder = Path.Combine(MyFileSystem.ContentPath, "Data", "Blueprints")
 
static readonly string m_workshopBlueprintSuffix = ".sbb"
 

Protected Member Functions

MyGuiControlButton CreateButton (float usableWidth, StringBuilder text, Action< MyGuiControlButton > onClick, bool enabled=true, MyStringId?tooltip=null, float textScale=1f)
 
MyGuiControlCompositePanel AddCompositePanel (MyGuiCompositeTexture texture, Vector2 position, Vector2 size, MyGuiDrawAlignEnum panelAlign)
 
MyGuiControlLabel MakeLabel (String text, Vector2 position, float textScale=1.0f)
 
bool DeleteBlueprint (string name)
 
- Protected Member Functions inherited from Sandbox.Game.Gui.MyGuiScreenDebugBase
 MyGuiScreenDebugBase (Vector4?backgroundColor=null, bool isTopMostScreen=false)
 
 MyGuiScreenDebugBase (Vector2 position, Vector2?size, Vector4?backgroundColor, bool isTopMostScreen)
 
MyGuiControlMultilineText AddMultilineText (Vector2?size=null, Vector2?offset=null, float textScale=1.0f, bool selectable=false)
 
MyGuiControlCheckbox AddCheckBox (String text, MyDebugComponent component, List< MyGuiControlBase > controlGroup=null, Vector4?color=null, Vector2?checkBoxOffset=null)
 
MyGuiControlCheckbox AddCheckBox (MyStringId textEnum, bool checkedState, Action< MyGuiControlCheckbox > checkBoxChange, bool enabled=true, List< MyGuiControlBase > controlGroup=null, Vector4?color=null, Vector2?checkBoxOffset=null)
 
MyGuiControlCheckbox AddCheckBox (String text, bool checkedState, Action< MyGuiControlCheckbox > checkBoxChange, bool enabled=true, List< MyGuiControlBase > controlGroup=null, Vector4?color=null, Vector2?checkBoxOffset=null)
 
MyGuiControlCheckbox AddCheckBox (MyStringId textEnum, Func< bool > getter, Action< bool > setter, bool enabled=true, List< MyGuiControlBase > controlGroup=null, Vector4?color=null, Vector2?checkBoxOffset=null)
 
MyGuiControlCheckbox AddCheckBox (String text, Func< bool > getter, Action< bool > setter, bool enabled=true, List< MyGuiControlBase > controlGroup=null, Vector4?color=null, Vector2?checkBoxOffset=null)
 
MyGuiControlCheckbox AddCheckBox (String text, object instance, MemberInfo memberInfo, bool enabled=true, List< MyGuiControlBase > controlGroup=null, Vector4?color=null, Vector2?checkBoxOffset=null)
 
virtual void ValueChanged (MyGuiControlBase sender)
 
MyGuiControlSlider AddSlider (String text, float value, float valueMin, float valueMax, Action< MyGuiControlSlider > valueChange, Vector4?color=null)
 
MyGuiControlSlider AddSlider (String text, float valueMin, float valueMax, Func< float > getter, Action< float > setter, Vector4?color=null)
 
MyGuiControlSliderBase AddSlider (String text, MyGuiSliderProperties properties, Func< float > getter, Action< float > setter, Vector4?color=null)
 
MyGuiControlSlider AddSlider (String text, float valueMin, float valueMax, object instance, MemberInfo memberInfo, Vector4?color=null)
 
MyGuiControlTextbox AddTextbox (String value, Action< MyGuiControlTextbox > onTextChanged, Vector4?color=null, float scale=1.0f, MyGuiControlTextboxType type=MyGuiControlTextboxType.Normal, List< MyGuiControlBase > controlGroup=null, string font=MyFontEnum.Debug, MyGuiDrawAlignEnum originAlign=MyGuiDrawAlignEnum.HORISONTAL_RIGHT_AND_VERTICAL_TOP)
 
MyGuiControlLabel AddLabel (String text, Vector4 color, float scale, List< MyGuiControlBase > controlGroup=null, string font=MyFontEnum.Debug)
 
MyGuiControlLabel AddSubcaption (MyStringId textEnum, Vector4?captionTextColor=null, Vector2?captionOffset=null, float captionScale=MyGuiConstants.DEFAULT_TEXT_SCALE)
 
MyGuiControlLabel AddSubcaption (String text, Vector4?captionTextColor=null, Vector2?captionOffset=null, float captionScale=MyGuiConstants.DEFAULT_TEXT_SCALE)
 
MyGuiControlColor AddColor (String text, Func< Color > getter, Action< Color > setter)
 
MyGuiControlColor AddColor (String text, Color value, Action< MyGuiControlColor > setter)
 
MyGuiControlColor AddColor (String text, object instance, MemberInfo memberInfo)
 
MyGuiControlButton AddButton (string text, Action< MyGuiControlButton > onClick, List< MyGuiControlBase > controlGroup=null, Vector4?textColor=null, Vector2?size=null)
 
MyGuiControlButton AddButton (StringBuilder text, Action< MyGuiControlButton > onClick, List< MyGuiControlBase > controlGroup=null, Vector4?textColor=null, Vector2?size=null)
 
MyGuiControlCombobox AddCombo (List< MyGuiControlBase > controlGroup=null, Vector4?textColor=null, Vector2?size=null, int openAreaItemsCount=10)
 
MyGuiControlCombobox AddCombo< TEnum > (TEnum selectedItem, Action< TEnum > valueChanged, bool enabled=true, int openAreaItemsCount=10, List< MyGuiControlBase > controlGroup=null, Vector4?color=null)
 
MyGuiControlCombobox AddCombo< TEnum > (object instance, MemberInfo memberInfo, bool enabled=true, int openAreaItemsCount=10, List< MyGuiControlBase > controlGroup=null, Vector4?color=null)
 
void AddShareFocusHint ()
 
- 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

static void SavePrefabToFile (MyObjectBuilder_Definitions prefab, string name, bool replace=false, MyBlueprintTypeEnum type=MyBlueprintTypeEnum.LOCAL)
 
- Static Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
static string MakeScreenFilepath (string name)
 

Additional Inherited Members

- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnLoadingAction
 
readonly MyGuiControls Elements
 
- Protected Attributes inherited from Sandbox.Game.Gui.MyGuiScreenDebugBase
Vector2 m_currentPosition
 
float m_scale = 1.0f
 
float m_buttonXOffset = 0
 
float m_sliderDebugScale = 1f
 
float Spacing = 0
 
- 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]
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
ScreenHandler Closed
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiScreenBaseDataLoading
 
Action< MyGuiScreenBaseDataUnloading
 

Detailed Description

Definition at line 42 of file MyGuiBlueprintBase.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyGuiBlueprintScreenBase.MyGuiBlueprintScreenBase ( Vector2  position,
Vector2  size,
Vector4  backgroundColor,
bool  isTopMostScreen 
)
inline

Definition at line 49 of file MyGuiBlueprintBase.cs.

Member Function Documentation

MyGuiControlCompositePanel Sandbox.Game.Gui.MyGuiBlueprintScreenBase.AddCompositePanel ( MyGuiCompositeTexture  texture,
Vector2  position,
Vector2  size,
MyGuiDrawAlignEnum  panelAlign 
)
inlineprotected

Definition at line 78 of file MyGuiBlueprintBase.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Reimplemented in Sandbox.Game.Gui.MyGuiBlueprintScreen.

Definition at line 285 of file MyGuiBlueprintBase.cs.

MyGuiControlButton Sandbox.Game.Gui.MyGuiBlueprintScreenBase.CreateButton ( float  usableWidth,
StringBuilder  text,
Action< MyGuiControlButton onClick,
bool  enabled = true,
MyStringId tooltip = null,
float  textScale = 1f 
)
inlineprotected

Definition at line 63 of file MyGuiBlueprintBase.cs.

bool Sandbox.Game.Gui.MyGuiBlueprintScreenBase.DeleteBlueprint ( string  name)
inlineprotected

Definition at line 271 of file MyGuiBlueprintBase.cs.

static MyObjectBuilder_Definitions Sandbox.Game.Gui.MyGuiBlueprintScreenBase.LoadPrefab ( string  filePath)
inlinestatic

Definition at line 257 of file MyGuiBlueprintBase.cs.

static MyObjectBuilder_Definitions Sandbox.Game.Gui.MyGuiBlueprintScreenBase.LoadWorkshopPrefab ( string  archive,
ulong?  publishedItemId 
)
inlinestatic

Definition at line 224 of file MyGuiBlueprintBase.cs.

MyGuiControlLabel Sandbox.Game.Gui.MyGuiBlueprintScreenBase.MakeLabel ( String  text,
Vector2  position,
float  textScale = 1.0f 
)
inlineprotected

Definition at line 92 of file MyGuiBlueprintBase.cs.

static void Sandbox.Game.Gui.MyGuiBlueprintScreenBase.Publish ( MyObjectBuilder_Definitions  prefab,
string  blueprintName,
Action< ulong >  publishCallback = null 
)
inlinestatic

Definition at line 156 of file MyGuiBlueprintBase.cs.

virtual void Sandbox.Game.Gui.MyGuiBlueprintScreenBase.RefreshBlueprintList ( bool  fromTask = false)
inlinevirtual

Reimplemented in Sandbox.Game.Gui.MyGuiBlueprintScreen.

Definition at line 289 of file MyGuiBlueprintBase.cs.

static void Sandbox.Game.Gui.MyGuiBlueprintScreenBase.SavePrefabToFile ( MyObjectBuilder_Definitions  prefab,
string  name,
bool  replace = false,
MyBlueprintTypeEnum  type = MyBlueprintTypeEnum.LOCAL 
)
inlinestaticprotected

Definition at line 97 of file MyGuiBlueprintBase.cs.

Member Data Documentation

string Sandbox.Game.Gui.MyGuiBlueprintScreenBase.m_defaultBlueprintFolder = Path.Combine(MyFileSystem.ContentPath, "Data", "Blueprints")
static

Definition at line 46 of file MyGuiBlueprintBase.cs.

string Sandbox.Game.Gui.MyGuiBlueprintScreenBase.m_localBlueprintFolder = Path.Combine(MyFileSystem.UserDataPath, "Blueprints", "local")
static

Definition at line 44 of file MyGuiBlueprintBase.cs.

string Sandbox.Game.Gui.MyGuiBlueprintScreenBase.m_workshopBlueprintFolder = Path.Combine(MyFileSystem.UserDataPath, "Blueprints", "workshop")
static

Definition at line 45 of file MyGuiBlueprintBase.cs.

readonly string Sandbox.Game.Gui.MyGuiBlueprintScreenBase.m_workshopBlueprintSuffix = ".sbb"
static

Definition at line 47 of file MyGuiBlueprintBase.cs.


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