ソースコードのフォントサイズを変える
settingsInit 関数
var mySet = settingsInit(filename);
新しい Settings Object を作成します。
ユーザー設定ファイルが存在しない場合 filename で指定したデフォルト設定ファイルを複写してユーザー設定ファイルにします。
引数を省略すると一部のメソッドだけを提供する簡易ファイルアクセスライブラリとして機能します。
- 引数 filename : 設定ファイルのファイル名を指定します。拡張子不要
- 戻り値 mySet : Settings Object
Settings Object
settingsInit 関数を実行すると新しい Settings オブジェクトが変数にセットされます。
Settings オブジェクトには以下のメソッドがあります。
- パス取得関数
- mySet.getFilePath - 設定ファイルのパスを取得
- mySet.getFolderPath - 設定フォルダのパスを取得
- 値取得関数
- mySet.defaultValue - 規定値の取得
- mySet.get - ユーザー値の取得
- mySet.getAll - 現在の設定をすべて取得
- 調査、初期化関数
- mySet.checkDefault - 現在の設定が規定値か調べる
- mySet.checkSyntax - 任意の値がその設定の値として適正か調べる
- mySet.reset - 設定を規定値に戻す
- mySet.resetAll - 設定をすべて規定値に戻す
- 設定変更関数
- mySet.set - 設定ファイルに変更を与える
- 引数指定なしでも使える関数
- mySet.getVersion - Settings Library のバージョンを返します。
- mySet.loadXML - XML を読み込む
- mySet.loadText - テキストファイルを読み込む
- mySet.saveText - 文字列をファイルに保存
- mySet.jsonEncoding - オブジェクトを JSON に変換
パス取得関数
getFilePath メソッド
mySet.getFilePath(n)
設定ファイルのフルパスを返します。
- 引数 n : 以下が指定できます。省略した場合は 0 と同等
- 0 = ユーザー設定ファイル({sleipnir}\settings\{user}\scriptsettings\{filename})
- 1 = デフォルト設定ファイル({sleipnir}\resources\scriptsettings\{filename})
- 戻り値 : パスを含む文字列
getFolderPath メソッド
mySet.getFolderPath(n)
設定ファイルのフルパスを返します。
- 引数 n : 以下が指定できます。省略した場合は 0 と同等
- 0 = ユーザー設定フォルダ({sleipnir}\settings\{user}\scriptsettings\)
- 1 = デフォルト設定フォルダ({sleipnir}\resources\scriptsettings\)
- 戻り値 : パスを含む文字列
値取得関数
defaultValue メソッド
mySet.defaultValue(key)
設定項目の規定値を取得します。
- 引数 key : 取得したい設定項目の NodeName
- 戻り値 : 設定項目の規定値
get メソッド
mySet.get(key)
設定項目のユーザー設定値を取得します。ユーザー設定値に書式違反があった場合
- syntax type が一致しない場合
- 規定値を返します。
- syntax max より大きい場合
- max の値を返します。
- syntax min より小さい場合
- min の値を返します。
- syntax round が true なら
- 四捨五入された値を返します。
- 引数 key : 取得したい設定項目の NodeName
- 戻り値 : 設定項目のユーザー設定値
getAll メソッド
mySet.getAll()
mySet.getAll(true)
現在の設定をすべて連想配列か文字列として返します。
ユーザー設定ファイルにキーが不足している場合デフォルト設定ファイルの値が入ります。
ユーザー設定ファイルにデフォルト設定ファイルには存在しないキーが含まれている場合無視されます。
- 引数 : 真偽値、true にすると戻り値が文字列になります。
- 戻り値 : 連想配列,文字列
調査、初期化関数
checkDefault メソッド
mySet.check(key)
設定項目の値が規定値かどうかを調べます
- 引数 key : 調べたい設定項目の NodeName
- 戻り値 : 真偽値
checkSyntax メソッド
mySet.checkSyntax(key,value)
任意の値が設定項目の値として適正かどうかを調べます。
- 引数 key : 調べたい設定項目の NodeName
- 引数 value : 適正かどうか調べる値
- 戻り値 : 真偽値
reset メソッド
mySet.reset(key)
設定項目の値を規定値に戻します。
- 引数 key : 規定値に戻したい設定項目の NodeName
- 戻り値 : 真偽値
resetAll メソッド
mySet.resetAll()
すべての設定項目の値を規定値に戻します。
設定変更関数
set メソッド
mySet.set(key, value)
設定を変更し変更をユーザー設定ファイルに書き込みます。
ユーザー設定値に書式違反があった場合 変更は行いません。
- 引数 key : 変更したい設定項目の NodeName
- 引数 value : 変更する値
- 戻り値 : 真偽値
引数指定なしでも使える関数
loadXML メソッド
mySet.loadXML(filename [,n])
XML ファイルを読み込み内容文字列を返します。
- 引数 filename : 読み込みたいファイル名を拡張子も含めて指定します。
- 引数 n : 以下が指定できます。
- 0 = {sleipnir}\settings\{user}\scriptSettings\{filename})
- 1 = {sleipnir}\resources\scriptSettings\{filename}
- 省略した場合、ユーザー設定フォルダから探しなければデフォルト設定フォルダを探します。
- 戻り値：xml Object
loadText メソッド
mySet.loadText(filename [,n])
テキストファイルを読み込み内容文字列を返します。
- 引数 filename : 読み込みたいファイル名を拡張子も含めて指定します。
- 引数 n : 以下が指定できます。
- 0 = {sleipnir}\settings\{user}\scriptSettings\{filename})
- 1 = {sleipnir}\resources\scriptSettings\{filename}
- 省略した場合、ユーザー設定フォルダから探しなければデフォルト設定フォルダを探します。
- 戻り値：読み込んだファイルの内容の文字列
saveText メソッド
mySet.saveText(filename, text)
文字列をテキストファイルに書き出します。
文字列を任意のテキストファイルに書き出します。
ファイルを保存するフォルダは {sleipnir}\settings\{user}\scriptSettings 固定です。
指定パスにすでにファイルがあった場合上書きされます。
filename に \\ が含まれる場合フォルダの作成も行います。最終的にファイルの書き出しに失敗してもフォルダは作成されるので注意してください。
filename に \\ で終わる文字列を渡すと何も行わず false を返します。
- 引数 filename : 保存するファイル名を拡張子も含めて指定します。
- 引数 text : ファイルに保存したい文字列
- 引数 n : 以下が指定できます。
- 戻り値：真偽値。保存が成功したら true, 失敗したら false を返します。
jsonEncoding メソッド
mySet.jsonEncoding(obj, accurate)
引数を JSON 形式の文字列に変換します。
引数を JSON で扱えない型にすると undefined を返します。
- 引数 obj : 変換したい値
- 引数 accurate : 真偽値、文字列を \uXXXX 形式に変換する厳密な変換を行います。
- 戻り値：JSON 形式の文字列