Show / Hide Table of Contents

Namespace WeaverCore.Settings

Classes

ConfigButton

The main button on the main menu and pause menu for opening up the Weaver Settings Menu

CustomFunctionAccessor

Used for accessing a function on a GlobalSettings object

CustomPropertyAccessor_Base

CustomPropertyAccessor<T>

Used for accessing a property on a GlobalSettings object, where the getter and setters can be customized

FieldAccessor

Used for accessing a field on a GlobalSettings object

GlobalSettings

Store global information about a mod, and creates a panel in the Settings Menu where they can be changed

Inherit from this class to create a custom panel in the settings menu, then use RegisterPanel<T>() to register the panel and make it show up in the settings menu

LangSettingDescriptionAttribute

Used to describe a method, field, or property on a GlobalSettings object, but also uses GetString(string, string, string) to translate it

LangSettingFieldAttribute

This attribute will cause a field, property, or function to show up in the Weaver Settings Screen, but also uses GetString(string, string, string) to translate it

LangSettingHeaderAttribute

Displays a large header over a settings element. Useful for grouping elements together

It also uses GetString(string, string, string) to translate it

MethodAccessor

Used for accessing a method on a GlobalSettings object

PropertyAccessor

Used for accessing a property on a GlobalSettings object

SaveSpecificSettings

Used for storing save file specific settings.

SaveSpecificSettings_Extensions

SettingDescriptionAttribute

Used to describe a method, field, or property on a GlobalSettings object

SettingDescriptionAttribute_BASE

SettingFieldAttribute

This attribute will cause a field, property or function to show up in the Weaver Settings Screen

SettingFieldAttribute_BASE

SettingHeaderAttribute

Displays a large header over a settings element. Useful for grouping elements together

SettingHeaderAttribute_BASE

SettingOrderAttribute

Determines the order a UI Element will be displayed in. The lower the number, the higher up it will be displayed in the Settings Menu

SettingRangeAttribute

Limits a numerical field or property to a limited range

SettingSpaceAttribute

Used to insert a space between two UI Elements in the Settings Menu

SettingsScreen

Represents the screen in-game where WeaverCore related mods can have their settings changed. See GlobalSettings for more info

Tab

Represents a tab button at the top of the settings menu screen

Interfaces

IAccessor

Base class for "Accessors", which are types that act as links between UIElement and properties in a GlobalSettings class

Enums

EnabledType

Applied to a UI Element to determine whether it's visible in certain conditions

☀
☾
In this article
Back to top
Generated by DocFX
☀
☾