各種パラメータを指定して Label のインスタンスを生成する。
このエンティティに対するパラメータ
Private _cacheこのエンティティの内部キャッシュ。
Private _cache描画されるキャッシュサイズ。 このサイズは _cache のサイズよりも小さくなる場合がある。
Private _has子にtouchableなものが含まれているかどうかを表す。
Private _line自動改行を行う幅。
widthAutoAdjust が有効の場合、this.width は値が不定になるため、
代わりに自動改行の幅を定める。
this.width を変更した場合、この値も同じ値に更新される。
Private _linesPrivate _matrix変換行列のキャッシュ。 Object2D は状態に変更があった時、本値の_modifiedをtrueにする必要がある。
初期値は undefined であり、 getMatrix() によって必要な時に生成されるため、
if (this._matrix) this._matrix._modified = true という式で記述する必要がある。
エンジンに組み込まれているSprite等のエンティティ群は、
すでに本処理を組み込んでいるため通常ゲーム開発者はこの値を意識する必要はない。
Object2D を継承したクラスを新たに作る場合には、本フィールドを適切に操作しなければならない。
Private _renderedこのエンティティを最後に描画した時のCamrera。
Private _rendererPrivate _shouldエンジンが子孫を描画すべきであればtrue、でなければfalseを本クラスを継承したクラスがセットする。
デフォルト値はtrueとなる。
オブジェクトのアンカーの横位置。アンカーについては以下の通り。
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() を呼び出す必要がある。
描画に利用されるフォント。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
フォントサイズ。
0 以上の数値でなければならない。
初期値は this.font.size である。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
このオブジェクトの縦幅。
初期値は 0 である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
このエンティティに割り振られる Game 単位で一意のID。(ただし local が真である場合を除く)
自動改行を行うかどうか。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
禁則処理の挙動を指定する関数。
行間サイズ。
初期値は0である。
-1 * fontSize 以上の数値でなければならない。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
このエンティティがローカルであるか否か。 コンストラクタで真が指定された時、または属するシーンがローカルシーンまたはローカルティック補間シーンである時、この値は真である。
この値が真である場合、このエンティティに対する point イベントはこのゲームインスタンスにのみ通知され、
他の参加者・視聴者には通知されない。また真である場合、 id の値の一意性は保証されない。
この値は参照のためにのみ公開されている。ゲーム開発者はこの値を直接変更してはならない。
0～1でオブジェクトの不透明度を表す。
初期値は 1 である。本値が0の場合、Rendererは描画処理を省略する。
E においてこの値を変更した場合、 modified() を呼び出す必要がある。
親。
ルビを使うかどうか。
初期値は真である。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
ルビのレイアウト設定。
個別のルビに this.rubyOptions の各プロパティと同名のプロパティが存在する場合、個別のルビの設定が優先される。
rubyFontSize: ルビのフォントサイズ。初期値は this.fontSize / 2 である。
rubyFont: ルビのビットマップフォント。初期値は this.font である。
rubyGap: ルビと本文の行間。初期値は0である。
rubyAlign: ルビのレイアウト。初期値は RubyAlign.SpaceAround である。
これらの値を変更した場合、 this.invalidate() を呼び出す必要がある。
ルビを解釈するパーサ。
初期値は DefaultRubyParser.ts で定義している parse() 関数である。
任意の文法でルビを記述する場合、この値に適切な関数を指定する必要がある。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
オブジェクトの横方向の倍率。
初期値は 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" である。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
文字列の描画色をCSS Color形式で指定する。
元の描画色に重ねて表示されるため、アルファ値を指定した場合は元の描画色が透けて表示される。
初期値は undefined となり、 描画色の変更を行わない。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
フォントの上端にある余白を描画するかどうか。
真の場合、文字の描画内容が崩れない範囲で余白を詰めて描画される。
初期値は偽である。
この値を変更した場合、 this.invalidate() を呼び出す必要がある。
このオブジェクトの横幅。
初期値は 0 である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。
E や Camera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。
width プロパティを this.text の描画に必要な幅の値に自動的に更新するかを表す。
width プロパティの更新は this.invalidate() を呼び出した後のタイミングで行われる。
textAlign を "left" 以外にする場合、この値は false にすべきである。
textAlign が "left" 以外かつ、 この値が 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イベント。
時間経過イベント。本イベントの一度のfireにつき、常に1フレーム分の時間経過が起こる。
このエンティティのpoint downイベント。
非推奨である。将来的に削除される。代わりに onPointDown を利用すること。
このエンティティのpoint moveイベント。
非推奨である。将来的に削除される。代わりに onPointMove を利用すること。
このエンティティのpoint upイベント。
非推奨である。将来的に削除される。代わりに onPointUp を利用すること。
プレイヤーにとって触れられるオブジェクトであるかを表す。
この値が偽である場合、ポインティングイベントの対象にならない。
初期値は false である。
E の他のプロパティと異なり、この値の変更後に this.modified() を呼び出す必要はない。
時間経過イベント。本イベントの一度のfireにつき、常に1フレーム分の時間経過が起こる。
非推奨である。将来的に削除される。代わりに onUpdate を利用すること。
Private _addPrivate _breakPrivate _calcPrivate _calcPrivate _calculatePrivate _calculatePrivate
このエンティティの座標系を、指定された祖先エンティティ (またはシーン) の座標系に変換する行列を求める。
指定されたエンティティが、このエンティティの祖先でない時、その値は無視される。 指定されたシーンが、このエンティティの属するシーン出ない時、その値は無視される。
Optional target: Scene | E座標系の変換先エンティティまたはシーン。省略した場合、このエンティティの属するシーン(グローバル座標系への変換行列になる)
Private _createPrivate _createPrivate _createPrivate _destroyPrivate _disablePrivate _dividePrivate _drawPrivate _drawPrivate _drawPrivate _enablePrivate _feedPrivate _findPrivate _flushPrivate _invalidatePrivate _isPrivate _isPrivate _needPrivate _updatePrivate _update自身と自身の子孫の中で、その座標に反応する PointSource を返す。
戻り値は、対象が見つかった場合、 target に見つかったエンティティを持つ PointSource である。
対象が見つからなかった場合、 undefined である。戻り値が undefined でない場合、その target プロパティは次を満たす:
this) またはその子孫であるE#touchable が真である対象の座標
Optional m: Matrixthis に適用する変換行列。省略された場合、単位行列
Optional force: booleantouchable指定を無視する場合真を指定する。省略された場合、偽
このエンティティに対する変更をエンジンに通知する。
このメソッドの呼び出し後、 this に対する変更が各 Renderer の描画に反映される。
ただし逆は真ではない。すなわち、再描画は他の要因によって行われることもある。
ゲーム開発者は、このメソッドを呼び出していないことをもって再描画が行われていないことを仮定してはならない。
本メソッドは、このオブジェクトの Object2D 由来のプロパティ (x, y, angle など) を変更した場合にも呼びだす必要がある。
本メソッドは、描画キャッシュの無効化処理を含まない。描画キャッシュを持つエンティティは、このメソッドとは別に invalidate() を提供している。
描画キャッシュの無効化も必要な場合は、このメソッドではなくそちらを呼び出す必要がある。
Optional _isBubbling: booleanオブジェクトを移動する。
このメソッドは x と y を同時に設定するためのユーティリティメソッドである。
E や Camera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。
X座標
Y座標
オブジェクトを移動する。
このメソッドは x と y を同時に設定するためのユーティリティメソッドである。
E や Camera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。
X,Y座標
オブジェクトのサイズを設定する。
このメソッドは width と height を同時に設定するためのユーティリティメソッドである。
E や Camera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。
幅
高さ
オブジェクトのサイズを設定する。
このメソッドは width と height を同時に設定するためのユーティリティメソッドである。
E や Camera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。
幅と高さ
Generated using TypeDoc
複数行のテキストを描画するエンティティ。 文字列内の"\r\n"、"\n"、"\r"を区切りとして改行を行う。 また、自動改行が有効な場合はエンティティの幅に合わせて改行を行う。 本クラスの利用にはg.Fontが必要となる。