Interface LabelParameterObject

Label のコンストラクタに渡すことができるパラメータ。 各メンバの詳細は Label の同名メンバの説明を参照すること。

Hierarchy

Properties

anchorX?: null | number

オブジェクトのアンカーの横位置。アンカーについては以下の通り。

  • アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
  • 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。 初期値は 0 である。

NOTE: anchorX または anchorY のどちらかを明示的に null に指定した場合、 このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 x, y は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。 これは前バージョンとの後方互換性のために存在する。 *

Default

0

anchorY?: null | number

オブジェクトのアンカーの縦位置。アンカーについては以下の通り。

  • アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
  • 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。 初期値は 0 である。

NOTE: anchorX または anchorY のどちらを明示的に null に指定した場合、 このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 x, y は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。 これは前バージョンとの後方互換性のために存在する。 *

Default

0

angle?: number

オブジェクトの回転。度数で指定する。

Default

0

children?: E[]

このエンティティの全子エンティティ。

Default

undefined

描画時の合成方法を指定する。 省略された場合、合成方法を指定しない(親の合成方法を利用する)。 なお CompositeOperation での指定は非推奨である。 CompositeOperationString を利用すること。

Default

undefined

font: Font

描画に利用されるフォント。

fontSize?: number

フォントサイズ。 0 以上の数値でなければならない。そうでない場合、動作は不定である。

これは LabelParameterObject#font で 与えられたフォントを fontSize フォントサイズ相当で描画するよう指示する値である。 歴史的経緯によりフォントサイズと説明されているが、実際には拡大縮小率を求めるため に用いられている。

Default

LabelParameterObject#font.size

height?: number

このオブジェクトの縦幅。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。

Default

0

hidden?: boolean

このエンティティの表示状態。

Default

false

id?: number

このエンティティに割り振られる E#id の値。 エンジンが一意の ID を設定するため、通常指定する必要はない。 この値は、スナップショットローダがエンティティを復元する際にのみ指定されるべきである。

Default

undefined

local?: boolean

このエンティティがローカルであるか否か。 コンストラクタで真が指定された時、または属するシーンがローカルシーンまたはローカルティック補間シーンである時、この値は真である。

この値が真である場合、このエンティティに対する point イベントはこのゲームインスタンスにのみ通知され、 他の参加者・視聴者には通知されない。また真である場合、 id の値の一意性は保証されない。

Default

false

maxWidth?: number

このラベルの最大幅。

Default

undefined

opacity?: number

0~1でオブジェクトの不透明度を表す。 この値が0の場合、Rendererは描画処理を省略する。

Default

1

parent?: E | Scene

このエンティティの親

Default

undefined

scaleX?: number

オブジェクトの横方向の倍率。

Default

1

scaleY?: number

オブジェクトの縦方向の倍率。

Default

1

scene: Scene

このエンティティが属するシーン。

shaderProgram?: ShaderProgram

このエンティティの描画時に利用されるシェーダプログラム。 このエンティティの renderer#isSupportedShaderProgram() が偽を返した場合、 renderer#setShaderProgram() は呼ばれないことに注意。

また g.FilledRect やその親エンティティに本値を指定した場合、対象の g.FilledRect の描画結果は不定である。 これは実装上の制限に基づく現バージョンの仕様である。

この値に undefined を指定した場合、親のシェーダプログラムを利用する。 この値に null を指定した場合、明示的にデフォルトのシェーダプログラムを利用する。

Default

undefined

tag?: any

ゲーム開発者向けのタグ情報管理コンテナ。 この値はゲームエンジンのロジックからは使用されず、ゲーム開発者は任意の目的に使用してよい。

Default

undefined

text: string

描画する文字列。

文字列の描画位置。 "left" (または非推奨の旧称 g.TextAlign.Left) 以外にする場合、 widthAutoAdjustfalse にすべきである。(widthAutoAdjust の項を参照)

Default

TextAlign.Left

textColor?: string

文字列の描画色をCSS Color形式で指定する。 元の描画色に重ねて表示されるため、アルファ値を指定した場合は元の描画色が透けて表示される。 省略された場合、この場合描画色の変更を行わない。

Default

undefined

touchable?: boolean

プレイヤーにとって触れられるオブジェクトであるかを表す。 この値が偽である場合、ポインティングイベントの対象にならない。

Default

false

width?: number

このオブジェクトの横幅。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。

Default

0

widthAutoAdjust?: boolean

width プロパティを this.text の描画に必要な幅で自動的に更新するかを表す。 textAlign"left" (または非推奨の旧称 g.TextAlign.Left) 以外にする場合、この値は false にすべきである。 (textAlignwidth を元に描画位置を調整するため、 true の場合左寄せで右寄せでも描画結果が変わらなくなる)

Default

true

x?: number

このオブジェクトの横位置。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。

Default

0

y?: number

このオブジェクトの縦位置。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。

Default

0

Generated using TypeDoc