Class Key

A single key with a name.

Inheritance
Object
Key
Key<T>
Namespace: DaggerfallWorkshop.Game.Utility.ModSupport.ModSettings
Assembly: Assembly-CSharp.dll
Syntax
[fsObject("v1", new Type[]{})]
public abstract class Key

Properties

| Improve this Doc View Source

Description

Declaration
public string Description { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

KeyType

Declaration
public abstract KeyType KeyType { get; }
Property Value
Type Description
KeyType
| Improve this Doc View Source

Name

Declaration
[fsProperty]
public string Name { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

TextValue

The value of this key as a serialized string.

Declaration
public abstract string TextValue { get; set; }
Property Value
Type Description
String

Methods

| Improve this Doc View Source

Join<T>(T[])

Join values in a single string.

Declaration
protected static string Join<T>(params T[] args)
Parameters
Type Name Description
T[] args
Returns
Type Description
String
Type Parameters
Name Description
T
| Improve this Doc View Source

Make(KeyType)

Make a new instance of a key of the given type.

Declaration
public static Key Make(KeyType keyType = KeyType.Toggle)
Parameters
Type Name Description
KeyType keyType
Returns
Type Description
Key
| Improve this Doc View Source

OnRefreshWindow(BaseScreenComponent)

Sets value to a control.

Declaration
public abstract void OnRefreshWindow(BaseScreenComponent control)
Parameters
Type Name Description
BaseScreenComponent control
| Improve this Doc View Source

OnSaveWindow(BaseScreenComponent)

Save value from a control.

Declaration
public abstract void OnSaveWindow(BaseScreenComponent control)
Parameters
Type Name Description
BaseScreenComponent control
| Improve this Doc View Source

OnSaveWindow(BaseScreenComponent, out Boolean)

Save value from a control and checks if value has changed.

Declaration
public abstract void OnSaveWindow(BaseScreenComponent control, out bool hasChanged)
Parameters
Type Name Description
BaseScreenComponent control
Boolean hasChanged
| Improve this Doc View Source

OnWindow(ModSettingsWindow, Single, Single, ref Int32)

Draws a control on game window.

Declaration
public abstract BaseScreenComponent OnWindow(ModSettingsWindow window, float x, float y, ref int height)
Parameters
Type Name Description
ModSettingsWindow window
Single x
Single y
Int32 height
Returns
Type Description
BaseScreenComponent
| Improve this Doc View Source

ToObject()

The value of this key casted to object.

Declaration
public abstract object ToObject()
Returns
Type Description
Object
| Improve this Doc View Source

TrySplit<T>(String, Int32, out T[])

Get values from a string.

Declaration
protected static bool TrySplit<T>(string input, int count, out T[] items)
Parameters
Type Name Description
String input
Int32 count
T[] items
Returns
Type Description
Boolean
Type Parameters
Name Description
T