Appearance

Debology.Debby ​

DebbySettings Class ​

The main settings for Debby. A DebbySettings object is created automatically when the Debby package is imported and should always be kept in the Resources folder.

When initializing Debby manually with Initialize(Action<DebbySettings>), you can tweak the settings in the callback. The parameter passed in is a copy of the asset in Resources.

csharp
public class DebbySettings

Inheritance UnityEngine.ScriptableObject 🡒 DebbySettings

Fields ​

DebbySettings.AdjustConsoleCommandLine Field ​

Enables or disables the commandline in the Console module for triggering / setting adjustables.

csharp
public bool AdjustConsoleCommandLine;

Field Value ​

System.Boolean

DebbySettings.AdjustModule Field ​

Indicates whether the adjust module is enabled.

csharp
public bool AdjustModule;

Field Value ​

System.Boolean

DebbySettings.AdjustSuppressSliderTypeWarning Field ​

Whether to display the type warning for non-float / int adjust sliders.

csharp
public bool AdjustSuppressSliderTypeWarning;

Field Value ​

System.Boolean

DebbySettings.AdjustUpdateInterval Field ​

The update interval for values in the adjust module in milliseconds.

csharp
public int AdjustUpdateInterval;

Field Value ​

System.Int32

DebbySettings.AutoLoad Field ​

Indicates whether to automatically load Debby at startup.

csharp
public bool AutoLoad;

Field Value ​

System.Boolean

DebbySettings.BackgroundOpacity Field ​

The opacity of the background behind the module body.

csharp
public float BackgroundOpacity;

Field Value ​

System.Single

DebbySettings.CollapsedSidebar Field ​

Indicates whether the sidebar is collapsed by default.

csharp
public bool CollapsedSidebar;

Field Value ​

System.Boolean

DebbySettings.ConsoleLogStyle Field ​

The visual style of log messages in the console.

csharp
public ConsoleLogStyle ConsoleLogStyle;

Field Value ​

ConsoleLogStyle

DebbySettings.ConsoleLogStylePinned Field ​

The visual style of log messages in the console when pinned.

csharp
public ConsoleLogStyle ConsoleLogStylePinned;

Field Value ​

ConsoleLogStyle

DebbySettings.ConsoleModule Field ​

Indicates whether the console module is enabled.

csharp
public bool ConsoleModule;

Field Value ​

System.Boolean

DebbySettings.CustomStyle Field ​

Custom stylesheet to attach.

csharp
public StyleSheet CustomStyle;

Field Value ​

UnityEngine.UIElements.StyleSheet

DebbySettings.DesktopLayoutAutoOpen Field ​

If Debby should automatically open in the Desktop layout mode.

csharp
public bool DesktopLayoutAutoOpen;

Field Value ​

System.Boolean

DebbySettings.DesktopLayoutReferenceScale Field ​

How much to scale the reference resolution for the desktop layout. Higher number = smaller layout.

csharp
public float DesktopLayoutReferenceScale;

Field Value ​

System.Single

DebbySettings.ForceDesktopLayoutInEditor Field ​

If we should force the Desktop layout mode when running in editor.

csharp
public bool ForceDesktopLayoutInEditor;

Field Value ​

System.Boolean

DebbySettings.HierarchyModule Field ​

Indicates whether the hierarchy module is enabled.

csharp
public bool HierarchyModule;

Field Value ​

System.Boolean

DebbySettings.HierarchyUpdateInterval Field ​

The update interval for values in the adjust module in milliseconds.

csharp
public int HierarchyUpdateInterval;

Field Value ​

System.Int32

DebbySettings.Layout Field ​

The layout mode for the application.

csharp
public LayoutMode Layout;

Field Value ​

LayoutMode

DebbySettings.OpenButtonPosition Field ​

The position of the open button.

csharp
public ButtonPosition OpenButtonPosition;

Field Value ​

ButtonPosition

DebbySettings.OpenMode Field ​

Indicates whether to show the open button.

csharp
public OpenButtonMode OpenMode;

Field Value ​

OpenButtonMode

DebbySettings.ProfileMaxDataPoints Field ​

The maximum number of data points to display in the built-in profiler graphs.

csharp
public int ProfileMaxDataPoints;

Field Value ​

System.Int32

DebbySettings.ProfileModule Field ​

Indicates whether the profiler module is enabled.

csharp
public bool ProfileModule;

Field Value ​

System.Boolean

DebbySettings.ProfileUpdateInterval Field ​

The update interval for profiler graphs in milliseconds.

csharp
public int ProfileUpdateInterval;

Field Value ​

System.Int32

DebbySettings.ReportModeType Field ​

Which report adapter to use, or Manual if you'll provide your own.

csharp
public ReportMode ReportModeType;

Field Value ​

ReportMode

DebbySettings.ReportModule Field ​

Indicates whether the report module is enabled.

csharp
public bool ReportModule;

Field Value ​

System.Boolean

DebbySettings.SlackBotToken Field ​

The Slack bot token for API access (starts with xoxb-).

csharp
public string SlackBotToken;

Field Value ​

System.String

DebbySettings.SlackChannel Field ​

The Slack channel ID for OAuth integration.

csharp
public string SlackChannel;

Field Value ​

System.String

DebbySettings.SlackWebhookUrl Field ​

The Slack incoming webhook URL for sending messages.

csharp
public string SlackWebhookUrl;

Field Value ​

System.String

DebbySettings.SystemModule Field ​

Indicates whether the system module is enabled.

csharp
public bool SystemModule;

Field Value ​

System.Boolean

DebbySettings.UGSModule Field ​

Indicates whether the UGS module is enabled.

csharp
public bool UGSModule;

Field Value ​

System.Boolean

Methods ​

DebbySettings.SetCustomReportAdapter(IDebbyReportAdapter) Method ​

Sets a custom report adapter and switches Report module to Manual if it is not already. This can be used if you want to send reports to a service / endpoint not supported by Debby.

csharp
public void SetCustomReportAdapter(Debology.Debby.Modules.Report.IDebbyReportAdapter adapter);

Parameters ​

adapter IDebbyReportAdapter

The adapter to use for sending reports.