本リファレンスで使用する用語と型一覧。
用語/型については独自に定義しているもので、正式な表現とは異なるものもあります。
| クラス | メソッドとプロパティをまとめたオブジェクトのひな形 |
| メソッド | 処理・手続き(メンバー関数) |
| プロパティ | 情報・データ・属性 |
| bool | 論理値 |
| int | 整数値 |
| float | 倍精度浮動小数点数値 |
| float2 | float2つのタプル/リスト |
| float3 | float3つのタプル/リスト |
| float4 | float4つのタプル/リスト |
| vec3 | 座標値(x, y, z)のfloatのタプル/リスト |
| string | 文字列 |
| file_path | ファイルへのパス |
| ms | ミリセコンド(1000ms = 1sec) |
| rgb | RGBカラー。(R,G,B)のfloatのタプル/リスト |
| radian | 円周率(3.1415926535898) |
| quaternion | クォータニオン。(w, x, y, z)のfloatのタプル/リスト |
| mat4 | 行列。float4個のタプル/リストが4個並んだタプル/リスト |
| size | 縦横サイズ。(width, height)のintのタプル/リスト |
| rectangle | 矩形(left, top, right, bottom)のタプル/リスト |
| uuid | Universal Unique Identifier、128ビットの数値 |
ルートからのファイルパス。
ファイルパスを正しく指定するために、本リファレンスのサンプルコードでは dialog クラスの ask_path メソッドでファイルダイアログを開き、ファイルパスを取得する方式を紹介している。
汎用一意識別子、Universal Unique Identifier
任意の数の任意の数値でも動作はするが、プラグインのuuidと衝突するおそれもあるので、下記の方法で取得・設定するのが望ましい。