Class TimbnGuiWindow

Namespace

Timbn.GraveyardKeeperTwo.Core.Framework

Assembly

Timbn.GraveyardKeeperTwo.Core.dll

An IMGUI box for a plugin's debug or cheat menu, opened and closed with a key from the plugin's config. Core draws the box, a title line that names the key to close it, and a "load a save" note while no save is loaded, so the plugin only draws what goes inside. Get one from the plugin's UI.DebugWindow.

public sealed class TimbnGuiWindow

Inheritance

object

TimbnGuiWindow

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

var menu = UI.CreateDebugWindow("Timbn Cheats", DrawCheats, PluginConfig.ToggleMenu);
menu.Area = new Rect(20, 20, 420, 640);

Properties

AnchorRight

Measures the box's x from the right edge of the screen, for a window that sits on the right.

public bool AnchorRight { get; set; }

Property Value

bool

Area

Where the box is drawn and how big it is, in screen pixels. With AnchorRight the x is measured from the right edge instead of the left.

public Rect Area { get; set; }

Property Value

Rect

InGameOnly

Whether the contents need a loaded save. While on, the box shows only its title and a note asking the player to load a save until one is loaded. Turn it off for a window that also works on the main menu.

public bool InGameOnly { get; set; }

Property Value

bool

IsVisible

Whether the window is on screen. The toggle key flips it, and the plugin can set it too.

public bool IsVisible { get; set; }

Property Value

bool