Class OnixSettingInfo

Namespace

OnixRuntime.Api.OnixClient.Settings

Assembly

OnixRuntime.dll

Adds basically text as a setting.

public sealed class OnixSettingInfo : OnixSetting, IDisposable

Inheritance

object

SharedMemoryAddressContainer

OnixSetting

OnixSettingInfo

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)

Constructors

OnixSettingInfo(OnixModule?, string, string, float, SettingChangedDelegate?)

Creates a new setting info.

public OnixSettingInfo(OnixModule? parentModule, string name, string description = "", float scale = 0.7, OnixSetting.SettingChangedDelegate? onSettingChanged = null)

Parameters

parentModule OnixModule

The module to add this setting to or null.

name string

The text of the setting.

description string

The text that shows when you hover the setting.

scale float

The scale of the setting's text in the UI.

onSettingChanged OnixSetting.SettingChangedDelegate

Gets called before rendering, you could use this to update the text before the user sees it, keep in mind it is a Direct2D thread calling this.

Properties

Scale

How large that setting is.

public float Scale { get; set; }

Property Value

float

Text

The text of the setting.

public string Text { get; set; }

Property Value

string

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.