ff14bot.Helpers.JsonSettings Class Reference

Main settings class for rebornbuddy. Inherit this if you want to make your own settings class. More...

Inheritance diagram for ff14bot.Helpers.JsonSettings:

Public Member Functions
void	Save ()
void	SaveAs (string file)

Static Public Member Functions
static string	GetSettingsFilePath (params string[] subPathParts)

Protected Member Functions
	JsonSettings (string path)
void	LoadFrom (string file)
void	OnPropertyChanged ([CallerMemberName] string? propertyName=null)
bool	SetField< T > (ref T field, T value, [CallerMemberName] string? propertyName=null)
	Call this function when updating an internal property to automatically raise the PropertyChanged event handler.

Properties
virtual Version	_revision [get]
	Override this field when you change the default values for a setting and use the UpdateDefaultValueAttribute attribute to updatethem.
static string	AssemblyPath [get]
static string	SettingsPath [get]
static string	ItemWeightsDirectory [get]
Version	Version [get, set]
string	FilePath [get, set]
static string	CharacterSettingsDirectory [get]

Events
EventHandler?	Reloaded
PropertyChangedEventHandler?	PropertyChanged

Detailed Description

Main settings class for rebornbuddy. Inherit this if you want to make your own settings class.

Constructor & Destructor Documentation

JsonSettings()

ff14bot.Helpers.JsonSettings.JsonSettings ( string path )

protected

Member Function Documentation

GetSettingsFilePath()

string ff14bot.Helpers.JsonSettings.GetSettingsFilePath ( params string[] subPathParts )

static

LoadFrom()

void ff14bot.Helpers.JsonSettings.LoadFrom ( string file )

protected

OnPropertyChanged()

void ff14bot.Helpers.JsonSettings.OnPropertyChanged ( [CallerMemberName] string? propertyName = null )

protected

Save()

void ff14bot.Helpers.JsonSettings.Save

(

)

SaveAs()

void ff14bot.Helpers.JsonSettings.SaveAs

(

string

file

)

SetField< T >()

bool ff14bot.Helpers.JsonSettings.SetField< T > ( ref T field, T value, [CallerMemberName] string? propertyName = null )

protected

Call this function when updating an internal property to automatically raise the PropertyChanged event handler.

Template Parameters

T

Parameters

field
value
propertyName

Returns

Property Documentation

_revision

virtual Version ff14bot.Helpers.JsonSettings._revision

getprotected

Override this field when you change the default values for a setting and use the UpdateDefaultValueAttribute attribute to updatethem.

AssemblyPath

string ff14bot.Helpers.JsonSettings.AssemblyPath

staticget

CharacterSettingsDirectory

string ff14bot.Helpers.JsonSettings.CharacterSettingsDirectory

staticget

FilePath

string ff14bot.Helpers.JsonSettings.FilePath

getset

ItemWeightsDirectory

string ff14bot.Helpers.JsonSettings.ItemWeightsDirectory

staticget

SettingsPath

string ff14bot.Helpers.JsonSettings.SettingsPath

staticget

Version

Version ff14bot.Helpers.JsonSettings.Version

getset

Event Documentation

PropertyChanged

PropertyChangedEventHandler? ff14bot.Helpers.JsonSettings.PropertyChanged

Reloaded

EventHandler? ff14bot.Helpers.JsonSettings.Reloaded