SettingPerk

継承:Perk セクション名:setting 優先度:10

SettingPerkはユニットの設定に関する機能を付与します。

全ユニットに共通な設定はグローバル設定の“system.setting”セクションに記述します。

{
    "system": {
        "setting": {
            "options": {
                "path": String,
                "settingFormat": "js"|"json",
                "settingsRef": Boolean|String,
            }
        }
    }
}

各ユニット固有の設定は“setting”セクションに記述します。

{
    "setting": {
        "options": {
            "autoLoad": String,
            "fileName": String,
            "path": String,
            "settingFormat": "js"|"json",
            "settingsRef": Boolean|String,
        }
    }
}

いくつかの設定は、タグ属性で指定することもできます。

<my-unit
    bm-autoload=String
    bm-filename=String
    bm-options=String
    bm-path=String
    bm-settingref=Empty|String|"false"
></my-unit>

型:String デフォルト:False

ユニットに必要なファイルを自動的にロードすることを示します。本来はUnitPerkの設定ですが、ここにURLが指定されている場合、SettingPerkでは設定ファイルのパスとファイル名として使用します。

型:String

JSON形式で設定を記述します。ここで指定された設定は、ユニット設定の“options”セクションにマージされます。

型:String デフォルト:<タグ名>

設定のファイル名を指定します。拡張子は不要です。

優先順は高い順に、“setting.options.fileName”、"unit.options.fileName"で、いずれも指定がない場合はタグ名がファイル名として使われます。

ファイル名に拡張子“settings.js”を付けたファイルをロードします。

型:String

設定ファイルのパスを指定します。グローバル設定のパスと、ユニット固有設定のパスを連結したものが、最終的なパスとして使われます。

グローバル設定は“system.setting.options.path”、“system.unit.options.path”の優先順で使用され、ユニット固有設定は“setting.options.path”、“unit.options.path”の優先順で使用されます。

型:String デフォルト:“json”

設定ファイルのフォーマットを指定します。“js”または“json”を指定できます。指定がない場合は、JSONファイルとして扱われます。

型:Boolean|String デフォルト:False

ユニットの設定ファイルへのURLを指定します。Trueの場合は、デフォルトのURLが使用されます。設定は非同期に読み込まれ、ユニットの設定にマージされます。

bm-settingsref属性を指定した場合、値が指定されていればファイルへのURL、値が指定されてなければTrueとみなされます。Falseを指定したい場合は、“false”という文字列を指定してください。

型:ChainableStore 対象:インスタンス

このユニットの設定を保持するアセットです。

型:* 対象:Unit

設定を設定アセットから取得します。

指定されたキーの値です。キーの値が見つからない場合、defalutValueパラメータが指定されていればその値、指定されてない時はUndefinedを返します。

型:Undefined 対象:Unit

設定をマージします。

なし。

型:Undefined 対象:Unit

設定を設定アセットにセットします。

なし。

型:Undefined 対象:Unit

設定を適用するためのイベントをトリガーします。また、“beforeApplySettings”と“doApplySettings”の間で"perk.attachPerks"スペルを使い、必要なパークをアタッチさせます。

なし。

• beforeApplySettings
• doApplySettings
• afterApplySettings

型:Undefined 対象:Unit

ユニットの外部設定ファイルをロードします。ロードした設定は、ユニットの設定にマージされます。ロードするファイルはsettingsRef/bm-settingsrefで指定します。

設定フォーマットがJavascriptオブジェクトの場合、ユニットがオブジェクトにバインドされるため、設定内で“this”はユニットを指します。

なし。

なし。

• setting.options.settingRef/bm-settingsref
• setting.options.settingFormat/system.setting.options.settingFormat
• system.unit.options.path
• unit.options.path
• unit.options.fileName
• unit.options.query