Class OnixSettingCategory

Namespace

OnixRuntime.Api.OnixClient.Settings

Assembly

OnixRuntime.dll

Represents an Onix setting category, allowing grouping of settings with control over included count and open state.

public sealed class OnixSettingCategory : OnixSetting, IDisposable

Inheritance

object

SharedMemoryAddressContainer

OnixSetting

OnixSettingCategory

Implements

IDisposable

Inherited Members

OnixSetting.Dispose()

OnixSetting.Name

OnixSetting.SaveName

OnixSetting.Description

OnixSetting.Type

OnixSetting.ParentModule

OnixSetting.IsHidden

OnixSetting.IsLocked

OnixSetting.RemoveFromParent(bool)

OnixSetting.Save()

OnixSetting.Load(JsonNode)

SharedMemoryAddressContainer.Equals(object)

SharedMemoryAddressContainer.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OnixSettingCategory(OnixModule?, string, string, int, bool)

Initializes a new instance of the OnixSettingCategory class with the specified parent module, name, description, included count, and open state.

public OnixSettingCategory(OnixModule? parentModule, string name, string description = "", int included = 2147483647, bool isOpen = true)

Parameters

parentModule OnixModule

The parent Onix module.

name string

The name of the category.

description string

The description of the category.

included int

The number of settings included in this category.

isOpen bool

Whether the category is open by default.

Properties

IncludedCount

Gets or sets the number of settings included in this category.

public int IncludedCount { get; set; }

Property Value

int

IncludesEverythingUntilNextCategory

Gets a value indicating whether this category includes everything until the next category.

public bool IncludesEverythingUntilNextCategory { get; }

Property Value

bool

IsOpen

Gets or sets a value indicating whether the category is open.

public bool IsOpen { get; set; }

Property Value

bool