Skip to content

Debology.Debby

Debby Class

The main entry point to interact with Debby.

csharp
public static class Debby

Inheritance System.Object 🡒 Debby

Properties

Debby.Adjust Property

The Adjust module API.

csharp
public static Debology.Debby.Modules.Adjust.IAdjustModule Adjust { get; }

Property Value

IAdjustModule

Debby.Console Property

The Console module API.

csharp
public static Debology.Debby.Modules.Console.IConsoleModule Console { get; }

Property Value

IConsoleModule

Debby.Hierarchy Property

The Hierarchy module API.

csharp
public static Debology.Debby.Modules.Hierarchy.IHierarchyModule Hierarchy { get; }

Property Value

IHierarchyModule

Debby.IsOpen Property

If the main Debby UI is open. Note that in Desktop mode, the sidebar is considered the main UI, so this will return true even if none of the modules is opened (but the sidebar is visible)

csharp
public static bool IsOpen { get; }

Property Value

System.Boolean

Debby.Profile Property

The Profile module API.

csharp
public static Debology.Debby.Modules.Profile.IProfileModule Profile { get; }

Property Value

IProfileModule

Debby.Report Property

The Report module API.

csharp
public static Debology.Debby.Modules.Report.IReportModule Report { get; }

Property Value

IReportModule

Debby.System Property

The System module API.

csharp
public static Debology.Debby.Modules.System.ISystemModule System { get; }

Property Value

ISystemModule

Methods

Debby.Close() Method

Manually closes the Debby UI.

csharp
public static void Close();

Debby.Destroy() Method

Disposes / destroys Debby. You can initialize her again by calling Initialize().

csharp
public static void Destroy();

Debby.Initialize(Action<DebbySettings>) Method

Initializes Debby manually. DebbySettings must still be present in the Resources folder.

csharp
public static void Initialize(System.Action<Debology.Debby.DebbySettings> configure=null);

Parameters

configure System.Action<DebbySettings>

DebbySettings configuration callback.

Debby.Open() Method

Manually opens the Debby UI.

csharp
public static void Open();

Debby.RegisterCustomModule<T>() Method

Registers a custom module and creates the instance immediately.

csharp
public static void RegisterCustomModule<T>()
    where T : Debology.Debby.Modules.DebbyModule, new();

Type parameters

T

The type of module to register

Debby.RegisterCustomModule<T>(T) Method

Registers a custom module with the provided instance.

csharp
public static void RegisterCustomModule<T>(T instance)
    where T : Debology.Debby.Modules.DebbyModule;

Type parameters

T

The type of module to register

Parameters

instance T

The instance to register

Debby.ShowToast(DebbyToastType, string, float) Method

Shows a toast message

csharp
public static void ShowToast(Debology.Debby.DebbyToastType type, string message, float duration=3f);

Parameters

type DebbyToastType

The type of the toast message

message System.String

The message

duration System.Single

The duration of the toast message should be visible for (seconds)