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

Public Member Functions

override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
 MyGuiBlueprintScreen (MyGridClipboard clipboard, bool allowCopyToClipboard)
 
void RefreshThumbnail ()
 
override void RecreateControls (bool constructor)
 
override void RefreshBlueprintList (bool fromTask=false)
 
void RefreshAndReloadBlueprintList ()
 
void TakeScreenshot (string name)
 
void CreateFromClipboard (bool withScreenshot=false, bool replace=false)
 
override bool Update (bool hasFocus)
 
override bool CloseScreen ()
 
override void HandleInput (bool receivedFocusInThisUpdate)
 
- Public Member Functions inherited from Sandbox.Game.Gui.MyGuiBlueprintScreenBase
 MyGuiBlueprintScreenBase (Vector2 position, Vector2 size, Vector4 backgroundColor, bool isTopMostScreen)
 
- 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 InputLost ()
 
virtual void HandleUnhandledInput (bool receivedFocusInThisUpdate)
 
virtual bool HandleInputAfterSimulation ()
 
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 ()
 
virtual int GetTransitionOpeningTime ()
 
virtual int GetTransitionClosingTime ()
 
virtual void OnRemoved ()
 Called when [show]. More...
 

Static Public Member Functions

static void ShareBlueprintRequest (ulong workshopId, string name, ulong sendToId, string senderName)
 
static bool CopyBlueprintPrefabToClipboard (MyObjectBuilder_Definitions prefab, MyGridClipboard clipboard, bool setOwner=true)
 
- Static Public Member Functions inherited from Sandbox.Game.Gui.MyGuiBlueprintScreenBase
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 Task Task
 
static List< MySteamWorkshop.SubscribedItemm_subscribedItemsList = new List<MySteamWorkshop.SubscribedItem>()
 
- Static Public Attributes inherited from Sandbox.Game.Gui.MyGuiBlueprintScreenBase
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

override void OnClosed ()
 Called when [show]. More...
 
- Protected Member Functions inherited from Sandbox.Game.Gui.MyGuiBlueprintScreenBase
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...
 
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 ()
 

Properties

static bool FirstTime [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.Game.Gui.MyGuiBlueprintScreenBase
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)
 
- 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
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
ScreenHandler Closed
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiScreenBaseDataLoading
 
Action< MyGuiScreenBaseDataUnloading
 

Detailed Description

Definition at line 71 of file MyGuiBlueprintScreen.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyGuiBlueprintScreen.MyGuiBlueprintScreen ( MyGridClipboard  clipboard,
bool  allowCopyToClipboard 
)
inline

Definition at line 158 of file MyGuiBlueprintScreen.cs.

Member Function Documentation

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

Reimplemented from Sandbox.Game.Gui.MyGuiBlueprintScreenBase.

Definition at line 1448 of file MyGuiBlueprintScreen.cs.

static bool Sandbox.Game.Gui.MyGuiBlueprintScreen.CopyBlueprintPrefabToClipboard ( MyObjectBuilder_Definitions  prefab,
MyGridClipboard  clipboard,
bool  setOwner = true 
)
inlinestatic

Definition at line 923 of file MyGuiBlueprintScreen.cs.

void Sandbox.Game.Gui.MyGuiBlueprintScreen.CreateFromClipboard ( bool  withScreenshot = false,
bool  replace = false 
)
inline

Definition at line 1308 of file MyGuiBlueprintScreen.cs.

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

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 153 of file MyGuiBlueprintScreen.cs.

override void Sandbox.Game.Gui.MyGuiBlueprintScreen.HandleInput ( bool  receivedFocusInThisUpdate)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 1453 of file MyGuiBlueprintScreen.cs.

override void Sandbox.Game.Gui.MyGuiBlueprintScreen.OnClosed ( )
inlineprotectedvirtual

Called when [show].

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 1412 of file MyGuiBlueprintScreen.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 249 of file MyGuiBlueprintScreen.cs.

void Sandbox.Game.Gui.MyGuiBlueprintScreen.RefreshAndReloadBlueprintList ( )
inline

Definition at line 592 of file MyGuiBlueprintScreen.cs.

override void Sandbox.Game.Gui.MyGuiBlueprintScreen.RefreshBlueprintList ( bool  fromTask = false)
inlinevirtual

Reimplemented from Sandbox.Game.Gui.MyGuiBlueprintScreenBase.

Definition at line 532 of file MyGuiBlueprintScreen.cs.

void Sandbox.Game.Gui.MyGuiBlueprintScreen.RefreshThumbnail ( )
inline

Definition at line 239 of file MyGuiBlueprintScreen.cs.

static void Sandbox.Game.Gui.MyGuiBlueprintScreen.ShareBlueprintRequest ( ulong  workshopId,
string  name,
ulong  sendToId,
string  senderName 
)
inlinestatic

Definition at line 124 of file MyGuiBlueprintScreen.cs.

void Sandbox.Game.Gui.MyGuiBlueprintScreen.TakeScreenshot ( string  name)
inline

Definition at line 1290 of file MyGuiBlueprintScreen.cs.

override bool Sandbox.Game.Gui.MyGuiBlueprintScreen.Update ( bool  hasFocus)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 1422 of file MyGuiBlueprintScreen.cs.

Member Data Documentation

List<MySteamWorkshop.SubscribedItem> Sandbox.Game.Gui.MyGuiBlueprintScreen.m_subscribedItemsList = new List<MySteamWorkshop.SubscribedItem>()
static

Definition at line 80 of file MyGuiBlueprintScreen.cs.

Task Sandbox.Game.Gui.MyGuiBlueprintScreen.Task
static

Definition at line 73 of file MyGuiBlueprintScreen.cs.

Property Documentation

bool Sandbox.Game.Gui.MyGuiBlueprintScreen.FirstTime
staticgetset

Definition at line 114 of file MyGuiBlueprintScreen.cs.


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