各種パラメータを指定して Label のインスタンスを生成する。
このエンティティに指定するパラメータ
Private _cacheこのエンティティの内部キャッシュ。
Private _cache描画されるキャッシュサイズ。 このサイズは _cache のサイズよりも小さくなる場合がある。
Private _has子にtouchableなものが含まれているかどうかを表す。
Private _matrix変換行列のキャッシュ。 Object2D は状態に変更があった時、本値の_modifiedをtrueにする必要がある。
初期値は undefined であり、 getMatrix() によって必要な時に生成されるため、
if (this._matrix) this._matrix._modified = true という式で記述する必要がある。
エンジンに組み込まれているSprite等のエンティティ群は、
すでに本処理を組み込んでいるため通常ゲーム開発者はこの値を意識する必要はない。
Object2D を継承したクラスを新たに作る場合には、本フィールドを適切に操作しなければならない。
Private _overhang最初の文字が描画の基準点から左にはみだす量。
Private _overhang最後の文字が glyph.advanceWidth から右にはみだす量。
Private _realPrivate _renderedこのエンティティを最後に描画した時のCamrera。
Private _rendererPrivate _shouldエンジンが子孫を描画すべきであればtrue、でなければfalseを本クラスを継承したクラスがセットする。
デフォルト値はtrueとなる。
Private _textオブジェクトのアンカーの横位置。アンカーについては以下の通り。
0 である。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。NOTE: anchorX または anchorY のどちらを明示的に null に指定した場合、
このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 x, y は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。
これは前バージョンとの後方互換性のために存在する。
オブジェクトのアンカーの縦位置。アンカーについては以下の通り。
0 である。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。NOTE: anchorX または anchorY のどちらを明示的に null に指定した場合、
このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 x, y は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。
これは前バージョンとの後方互換性のために存在する。
オブジェクトの回転。度数 (時計回り) で指定する。
初期値は 0 である。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
このエンティティの全子エンティティ。
子エンティティが存在しない場合、本フィールドの値は undefined または空配列である。
描画時の合成方法を指定する。
初期値は undefined となり、合成方法を指定しないことを意味する。
E においてこの値を変更した場合、 modified() を呼び出す必要がある。
描画に利用されるフォント。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
フォントサイズ。
0 以上の数値でなければならない。そうでない場合、動作は不定である。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
Label#font.size
キャッシュされたグリフ情報。 通常、ゲーム開発者がこのプロパティを参照する必要はない。
このオブジェクトの縦幅。
初期値は 0 である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
このエンティティに割り振られる Game 単位で一意のID。(ただし local が真である場合を除く)
このエンティティがローカルであるか否か。 コンストラクタで真が指定された時、または属するシーンがローカルシーンまたはローカルティック補間シーンである時、この値は真である。
この値が真である場合、このエンティティに対する point イベントはこのゲームインスタンスにのみ通知され、
他の参加者・視聴者には通知されない。また真である場合、 id の値の一意性は保証されない。
この値は参照のためにのみ公開されている。ゲーム開発者はこの値を直接変更してはならない。
このラベルの最大幅。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
0～1でオブジェクトの不透明度を表す。
初期値は 1 である。本値が0の場合、Rendererは描画処理を省略する。
E においてこの値を変更した場合、 modified() を呼び出す必要がある。
親。
オブジェクトの横方向の倍率。
初期値は 1 である。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
オブジェクトの縦方向の倍率。
初期値は 1 である。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
このエンティティが属するシーン。
このエンティティの描画時に利用されるシェーダプログラム。
isSupportedShaderProgram() が偽を返す g.Rendere で描画される時、 g.Renderer#setShaderProgram() は呼ばれないことに注意。
また g.FilledRect やその親エンティティに本値を指定した場合、対象の g.FilledRect の描画結果は不定である。
これは実装上の制限に基づく現バージョンの仕様である。
この値が undefined である場合、親のシェーダプログラムが利用される。
この値が null である場合、明示的にデフォルトのシェーダプログラムが利用される。
この値を変更した場合、 this.modified() を呼び出す必要がある。
様々な状態を表すビットフラグ。
ゲーム開発者向けのタグ情報管理コンテナ。 この値はゲームエンジンのロジックからは使用されず、ゲーム開発者は任意の目的に使用してよい。
描画する文字列。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
文字列の描画位置。
"left" (または非推奨の旧称 TextAlign.Left) 以外にする場合、
widthAutoAdjust を false にすべきである。(widthAutoAdjust の項を参照)
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
TextAlign.Left
文字列の描画色をCSS Color形式で指定する。
元の描画色に重ねて表示されるため、アルファ値を指定した場合は元の描画色が透けて表示される。
初期値は undefined となり、 描画色の変更を行わない。
このオブジェクトの横幅。
初期値は 0 である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
width プロパティを this.text の描画に必要な幅で自動的に更新するかを表す。
初期値は true である。
textAlign を "left" (または非推奨の旧称 g.TextAlign.Left) 以外にする場合、この値は false にすべきである。
(textAlign は width を元に描画位置を調整するため、 true の場合左寄せで右寄せでも描画結果が変わらなくなる)
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
このオブジェクトの横位置。
初期値は 0 である。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
このオブジェクトの縦位置。
初期値は 0 である。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
Static Private PADDING_cache のパディングサイズ。
このエンティティのmessageイベント。
非推奨である。将来的に削除される。代わりに onMessage を利用すること。
このエンティティのmessageイベント。
このエンティティのpoint downイベント。
このエンティティのpoint moveイベント。
このエンティティのpoint upイベント。
このエンティティのpoint downイベント。
非推奨である。将来的に削除される。代わりに onPointDown を利用すること。
このエンティティのpoint moveイベント。
非推奨である。将来的に削除される。代わりに onPointMove を利用すること。
このエンティティのpoint upイベント。
非推奨である。将来的に削除される。代わりに onPointUp を利用すること。
プレイヤーにとって触れられるオブジェクトであるかを表す。
この値が偽である場合、ポインティングイベントの対象にならない。
初期値は false である。
E の他のプロパティと異なり、この値の変更後に this.modified() を呼び出す必要はない。
Private _calculatePrivate
Optional m: MatrixPrivate _calculatePrivate _disablePrivate _enablePrivate _findPrivate _invalidatePrivate _isPrivate
Private _outputPrivate _updatewidth と textAlign を設定し、 widthAutoAdjust を false に設定する。
このメソッドは this.textAlign を設定するためのユーティリティである。
textAlign を "left" (または非推奨の旧称 TextAlign.Left) 以外に設定する場合には、
通常 width や widthAutoAdjust も設定する必要があるため、それらをまとめて行う。
このメソッドの呼び出し後、 this.invalidate() を呼び出す必要がある。
幅
テキストの描画位置
子を追加する。
子エンティティとして追加するエンティティ
このEの包含矩形を計算する。
キャッシュのサイズを取得する。
本クラスを継承したクラスでエンティティのサイズと異なるサイズを利用する場合、このメソッドをオーバーライドする。
このメソッドはエンジンから暗黙に呼び出され、ゲーム開発者が呼び出す必要はない。
このメソッドから得られる値を変更した場合、 this.invalidate() を呼び出す必要がある。
自身と自身の子孫の中で、その座標に反応する PointSource を返す。
戻り値は、対象が見つかった場合、 target に見つかったエンティティを持つ PointSource である。
対象が見つからなかった場合、 undefined である。戻り値が undefined でない場合、その target プロパティは次を満たす:
this) またはその子孫であるE#touchable が真である対象の座標
Optional m: Matrixthis に適用する変換行列。省略された場合、単位行列
Optional force: booleantouchable指定を無視する場合真を指定する。省略された場合、偽
ゲームの左上端を基準とした座標をこのEの位置を基準とした相対座標に変換する。
ゲームの左上端を基準とした座標
このEの位置を基準とした相対座標をゲームの左上端を基準とした座標に変換する。
Eの位置を基準とした相対座標
このエンティティに対する変更をエンジンに通知する。
このメソッドの呼び出し後、 this に対する変更が各 Renderer の描画に反映される。
ただし逆は真ではない。すなわち、再描画は他の要因によって行われることもある。
ゲーム開発者は、このメソッドを呼び出していないことをもって再描画が行われていないことを仮定してはならない。
本メソッドは、このオブジェクトの Object2D 由来のプロパティ (x, y, angle など) を変更した場合にも呼びだす必要がある。
本メソッドは、描画キャッシュの無効化処理を含まない。描画キャッシュを持つエンティティは、このメソッドとは別に invalidate() を提供している。
描画キャッシュの無効化も必要な場合は、このメソッドではなくそちらを呼び出す必要がある。
Optional _isBubbling: booleanオブジェクトを移動する。
このメソッドは x と y を同時に設定するためのユーティリティメソッドである。
E や Camera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。
X座標
Y座標
オブジェクトを移動する。
このメソッドは x と y を同時に設定するためのユーティリティメソッドである。
E や Camera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。
X,Y座標
子を削除する。
e が this の子でない場合、 AssertionError がthrowされる。
e === undefined であり親がない場合、 AssertionError がthrowされる。
Optional e: E削除する子エンティティ。省略された場合、自身を親から削除する
キャッシュの描画が必要な場合にこのメソッドが呼ばれる。
本クラスを継承したエンティティはこのメソッド内でrendererに対してキャッシュの内容を描画しなければならない。
このメソッドはエンジンから暗黙に呼び出され、ゲーム開発者が呼び出す必要はない。
Label自身の描画を行う。
オブジェクトのサイズを設定する。
このメソッドは width と height を同時に設定するためのユーティリティメソッドである。
E や Camera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。
幅
高さ
オブジェクトのサイズを設定する。
このメソッドは width と height を同時に設定するためのユーティリティメソッドである。
E や Camera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。
幅と高さ
このメソッドは、 E#findPointSourceByPoint() 内で子孫の探索をスキップすべきか判断するために呼ばれる。
通常、子孫の描画方法をカスタマイズする一部のサブクラスにおいて、与えられた座標に対する子孫の探索を制御する場合に利用する。
ゲーム開発者がこのメソッドを呼び出す必要はない。
戻り値は、子孫の探索をスキップすべきであれば偽、でなければ真である。
Generated using TypeDoc
単一行のテキストを描画するエンティティ。 本クラスの利用には
BitmapFontまたはDynamicFontが必要となる。