Class MyGuiModHelpers

Inheritance

System.Object

MyGuiModHelpers

Implements

IMyGui

Namespace: Sandbox.ModAPI

Assembly: Sandbox.Game.dll

Syntax

public class MyGuiModHelpers : Object, IMyGui

Constructors

MyGuiModHelpers()

Declaration

public MyGuiModHelpers()

Properties

ActiveGamePlayScreen

Declaration

public string ActiveGamePlayScreen { get; }

Property Value

Type	Description
System.String

ChatEntryVisible

Declaration

public bool ChatEntryVisible { get; }

Property Value

Type	Description
System.Boolean

GetCurrentScreen

Declaration

public MyTerminalPageEnum GetCurrentScreen { get; }

Property Value

Type	Description
MyTerminalPageEnum

InteractedEntity

Declaration

public IMyEntity InteractedEntity { get; }

Property Value

Type	Description
IMyEntity

IsCursorVisible

Declaration

public bool IsCursorVisible { get; }

Property Value

Type	Description
System.Boolean

Methods

ChangeInteractedEntity(IMyEntity, Boolean)

Declaration

public void ChangeInteractedEntity(IMyEntity interactedEntity, bool isRemote)

Parameters

Type	Name	Description
IMyEntity	interactedEntity
System.Boolean	isRemote

ShowTerminalPage(MyTerminalPageEnum, IMyCharacter, IMyEntity, Boolean)

Declaration

public void ShowTerminalPage(MyTerminalPageEnum page, IMyCharacter user, IMyEntity interactedEntity = null, bool isRemote = false)

Parameters

Type	Name	Description
MyTerminalPageEnum	page
IMyCharacter	user
IMyEntity	interactedEntity
System.Boolean	isRemote

Events

GuiControlCreated

Declaration

public event Action<object> GuiControlCreated

Event Type

Type	Description
System.Action<System.Object>

GuiControlRemoved

Declaration

public event Action<object> GuiControlRemoved

Event Type

Type	Description
System.Action<System.Object>

Implements

IMyGui