概要
Inspector上でパラメーター調整できるようにする方法。 Unityでいう SerializeField に該当するもの。
PlayCanvaseでは Attribute と呼ばれる。
実装例
sample.js
var Sample = pc.createScript('sample');
// 第一引数に変数名、第二引数にその名前に紐づける設定をObjectで指定する
Sample.attributes.add('param', {type: 'number', default: 0});
第二引数での設定項目
第二引数に様々な設定を記述したObjectを渡すことでAttributeを設定するが、その設定項目は16個もある。
その中でもそこそこ多めに使用するであろう項目だけピックアップする。
type
実際に使用する型を宣言する項目、全項目はAPIリファレンスに記載されているので省略する。
default
初期値を設定する。typeで設定した型と同じ型でなければならない。
placeholder
項目内に表示されるテキストを設定できる。
用途としては距離などの単位を設定する事が多い。
title
Inspector上に表示する名前を設定できる。
デフォルトでは第一引数で設定した名前が表示されるが、それが好ましくない場合に使用する。
日本語は使えない。(2020/9/24)
description
作成したAttributeにInspector上でフォーカスした時に表示される説明文を記載できる。
min max
typeで指定した型がnumberの時のみ使用可能な項目。
最小値と最大値を設定が可能で片方だけの設定も可能だが、両方設定すればスライダーが表示される。
array
項目を配列にするか否かのフラグ。
trueにする事で複数の値を保存できるようになる。
size
arrayがtrueに場合のみ使用する。
配列の上限数を設定する。
enum schema
値の入力ではなく、ドロップダウンでパラメータを設定できる様にしたい場合に使用する。
内部の値はtypeで設定した型と同じでなければならない。
schemaはtypeでjsonを指定した場合のみ使用する。