BasicPerk

継承:Perk セクション名:basic 優先度:0

概要

BasicPerkはユニットに基本的な機能を付与します。ただし、このパークでは処理に必要なイベントをトリガーするのみで、実際の処理はその他のパークやイベントハンドラによって行われます。

設定

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

書式-ユニット固有設定

{
    "basic": {
        "options": {
            "autoClear": Boolean,
            "autoFetch": Boolean,
            "autoFill": Boolean,
            "autoRefresh": Boolean,
            "autoRestart": Boolean,
            "autoSetup": Boolean,
            "autoTransform": Boolean,
        }
    }
}

"autoClear"

型:Boolean デフォルト:True

Trueの場合、refreshスペルを使うと、自動的にclearスペルも呼び出されます。

"autoFetch"

型:Boolean デフォルト:True

Trueの場合、refreshスペルを使うと、自動的にfetchスペルも呼び出されます。

"autoFill"

型:Boolean デフォルト:True

Trueの場合、refreshスペルを使うと、自動的にfillスペルも呼び出されます。

"autoRefresh"

型:Boolean デフォルト:True

Trueの場合、スタート処理中に自動的にrefreshスペルが呼び出されます。

"autoRestart"

型:Boolean デフォルト:False

Trueの場合、ユニットがノードに接続された時(ConnectedCallback時)に、すでに初期化済みであっても再度スタート処理を行います。

"autoSetup"

型:Boolean デフォルト:True

Trueの場合、トランスフォーム中に自動的にsetupスペルが呼び出されます。

"autoTransform"

型:Boolean デフォルト:True

Trueの場合、スタート処理中に自動的にtransformスペルが呼び出されます。

ユニットプロパティ

uniqueId

型:String 対象:プロトタイプ get

ユニットのインスタンスごとに割り当てられるユニークなIDです。自動的に生成されます。

unitRoot

型:HTMLElement 対象:プロトタイプ get/set

ユニットのルートとなるノードです。Shadow DOMの場合、attachShadow()の戻り値となります。Shadow DOMでない場合は、“this”となります。ただし、トランスフォーム中はTemplateノードのクローンがセットされます。

ユニットメソッド

get(assetName, key, defaultValue)

型:* 対象:プロトタイプ

ユニットのアセットから値を取得します。

パラメータ

パラメータ	型	説明
assetName `必須`	String	取得元のアセット名を指定します。
key `必須`	String	取得する値のアセット内のキー名を指定します。
defaultValue	*	アセット内に指定されたキーが無い場合に、この値を返します。

戻り値

アセットから取得した値です。

has(assetName, key)

型:Boolean 対象:プロトタイプ

ユニットのアセットが指定されたキーの値を持っているか返します。

パラメータ

パラメータ	型	説明
assetName `必須`	String	取得元のアセット名を指定します。
key `必須`	String	アセット内のキー名を指定します。

戻り値

キーが存在すればTrue、存在しなければFalseを返します。

set(assetName, key, value)

型:Undefined 対象:プロトタイプ

ユニットのアセットに値を設定します。

パラメータ

パラメータ	型	説明
assetName `必須`	String	設定するアセット名を指定します。
key `必須`	String	設置するアセット内のキー名を指定します。
value	*	設定する値です。

戻り値

なし。

use(assetName, key, ..args)

型:* 対象:プロトタイプ

ユニットのアセット内の関数を呼び出します。

パラメータ

パラメータ	型	説明
assetName `必須`	String	使用するアセット名を指定します。
key `必須`	String	使用するアセット内のキー名を指定します。
…args	*	関数に渡す引数です。