Akashic Engine
    Preparing search index...

    Class Label

    単一行のテキストを描画するエンティティ。 本クラスの利用には BitmapFont または DynamicFont が必要となる。

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    anchorX: null | number

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

    • アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
    • 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。 初期値は 0 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

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

    anchorY: null | number

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

    • アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
    • 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。 初期値は 0 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

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

    angle: number

    オブジェクトの回転。度数 (時計回り) で指定する。 初期値は 0 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

    children: undefined | E[]

    このエンティティの全子エンティティ。 子エンティティが存在しない場合、本フィールドの値は undefined または空配列である。

    compositeOperation: undefined | CompositeOperationString | CompositeOperation

    描画時の合成方法を指定する。 初期値は undefined となり、合成方法を指定しないことを意味する。 E においてこの値を変更した場合、 modified() を呼び出す必要がある。

    font: Font

    描画に利用されるフォント。 この値を変更した場合、 this.invalidate() を呼び出す必要がある。

    fontSize: number

    フォントサイズ。 0 以上の数値でなければならない。そうでない場合、動作は不定である。 この値を変更した場合、 this.invalidate() を呼び出す必要がある。

    Label#font.size
    
    glyphs: Glyph[]

    キャッシュされたグリフ情報。 通常、ゲーム開発者がこのプロパティを参照する必要はない。

    height: number

    このオブジェクトの縦幅。 初期値は 0 である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

    id: number

    このエンティティに割り振られる Game 単位で一意のID。(ただし local が真である場合を除く)

    local: boolean

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

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

    この値は参照のためにのみ公開されている。ゲーム開発者はこの値を直接変更してはならない。

    maxWidth: undefined | number

    このラベルの最大幅。 この値を変更した場合、 this.invalidate() を呼び出す必要がある。

    opacity: number

    0~1でオブジェクトの不透明度を表す。 初期値は 1 である。本値が0の場合、Rendererは描画処理を省略する。 E においてこの値を変更した場合、 modified() を呼び出す必要がある。

    parent: undefined | Scene | E

    親。

    scaleX: number

    オブジェクトの横方向の倍率。 初期値は 1 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

    scaleY: number

    オブジェクトの縦方向の倍率。 初期値は 1 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

    scene: Scene

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

    shaderProgram: undefined | null | ShaderProgram

    このエンティティの描画時に利用されるシェーダプログラム。 isSupportedShaderProgram() が偽を返す g.Rendere で描画される時、 g.Renderer#setShaderProgram() は呼ばれないことに注意。

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

    この値が undefined である場合、親のシェーダプログラムが利用される。 この値が null である場合、明示的にデフォルトのシェーダプログラムが利用される。

    この値を変更した場合、 this.modified() を呼び出す必要がある。

    様々な状態を表すビットフラグ。

    tag: any

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

    text: string

    描画する文字列。 この値を変更した場合、 this.invalidate() を呼び出す必要がある。

    文字列の描画位置。 "left" (または非推奨の旧称 TextAlign.Left) 以外にする場合、 widthAutoAdjustfalse にすべきである。(widthAutoAdjust の項を参照) この値を変更した場合、 this.invalidate() を呼び出す必要がある。

    TextAlign.Left

    textColor: undefined | string

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

    width: number

    このオブジェクトの横幅。 初期値は 0 である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

    widthAutoAdjust: boolean

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

    この値を変更した場合、 this.invalidate() を呼び出す必要がある。

    x: number

    このオブジェクトの横位置。 初期値は 0 である。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

    y: number

    このオブジェクトの縦位置。 初期値は 0 である。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

    Accessors

    • get onUpdate(): Trigger<void>

      時間経過イベント。本イベントの一度のfireにつき、常に1フレーム分の時間経過が起こる。

      Returns Trigger<void>

    • get touchable(): boolean

      プレイヤーにとって触れられるオブジェクトであるかを表す。

      この値が偽である場合、ポインティングイベントの対象にならない。 初期値は false である。

      E の他のプロパティと異なり、この値の変更後に this.modified() を呼び出す必要はない。

      Returns boolean

    • set touchable(v: boolean): void

      Parameters

      • v: boolean

      Returns void

    • get update(): Trigger<void>

      時間経過イベント。本イベントの一度のfireにつき、常に1フレーム分の時間経過が起こる。

      Returns Trigger<void>

      非推奨である。将来的に削除される。代わりに onUpdate を利用すること。

    Methods

    • widthtextAlign を設定し、 widthAutoAdjustfalse に設定する。

      このメソッドは this.textAlign を設定するためのユーティリティである。 textAlign"left" (または非推奨の旧称 TextAlign.Left) 以外に設定する場合には、 通常 widthwidthAutoAdjust も設定する必要があるため、それらをまとめて行う。 このメソッドの呼び出し後、 this.invalidate() を呼び出す必要がある。

      Parameters

      Returns void

    • オブジェクトのアンカーの位置を設定する。 このメソッドは anchorXanchorY を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

      Parameters

      • x: number
      • y: number

      Returns void

    • キャッシュのサイズを取得する。 本クラスを継承したクラスでエンティティのサイズと異なるサイズを利用する場合、このメソッドをオーバーライドする。 このメソッドはエンジンから暗黙に呼び出され、ゲーム開発者が呼び出す必要はない。 このメソッドから得られる値を変更した場合、 this.invalidate() を呼び出す必要がある。

      Returns CommonSize

    • このエンティティを破棄する。 利用している BitmapFont の破棄は行わないため、 BitmapFont の破棄はコンテンツ製作者が明示的に行う必要がある。

      Returns void

    • 自身と自身の子孫の中で、その座標に反応する PointSource を返す。

      戻り値は、対象が見つかった場合、 target に見つかったエンティティを持つ PointSource である。 対象が見つからなかった場合、 undefined である。戻り値が undefined でない場合、その target プロパティは次を満たす:

      • このエンティティ(this) またはその子孫である
      • E#touchable が真である

      Parameters

      • point: CommonOffset

        対象の座標

      • Optionalm: Matrix

        this に適用する変換行列。省略された場合、単位行列

      • Optionalforce: boolean

        touchable指定を無視する場合真を指定する。省略された場合、偽

      Returns undefined | PointSource

    • このEを非表示状態にする。

      this.show() が呼ばれるまでの間、このエンティティは各 Renderer によって描画されない。 また Game#findPointSource() で返されることもなくなる。 this#pointDown, pointMove, pointUp なども通常の方法ではfireされなくなる。

      Returns void

    • 子を挿入する。

      targetthis の子でない場合、append(e) と同じ動作となる。

      Parameters

      • e: E

        子エンティティとして追加するエンティティ

      • target: undefined | E

        挿入位置にある子エンティティ

      Returns void

    • このエンティティの描画キャッシュ無効化をエンジンに通知する。 このメソッドを呼び出し後、描画キャッシュの再構築が行われ、各 Renderer に描画内容の変更が反映される。

      Returns void

    • このエンティティに対する変更をエンジンに通知する。

      このメソッドの呼び出し後、 this に対する変更が各 Renderer の描画に反映される。 ただし逆は真ではない。すなわち、再描画は他の要因によって行われることもある。 ゲーム開発者は、このメソッドを呼び出していないことをもって再描画が行われていないことを仮定してはならない。

      本メソッドは、このオブジェクトの Object2D 由来のプロパティ (x, y, angle など) を変更した場合にも呼びだす必要がある。 本メソッドは、描画キャッシュの無効化処理を含まない。描画キャッシュを持つエンティティは、このメソッドとは別に invalidate() を提供している。 描画キャッシュの無効化も必要な場合は、このメソッドではなくそちらを呼び出す必要がある。

      Parameters

      • Optional_isBubbling: boolean

        通常ゲーム開発者が指定する必要はない。この変更通知が、(このエンティティ自身のみならず)子孫の変更の通知を含む場合、真を渡さなければならない。省略された場合、偽。

      Returns void

    • オブジェクトを相対的に移動する。 このメソッドは xy を同時に加算するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

      Parameters

      • x: number

        X座標に加算する値

      • y: number

        Y座標に加算する値

      Returns void

    • オブジェクトを移動する。 このメソッドは xy を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

      Parameters

      • x: number

        X座標

      • y: number

        Y座標

      Returns void

    • オブジェクトを移動する。 このメソッドは xy を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

      Parameters

      Returns void

    • 子を削除する。

      ethis の子でない場合、 AssertionError がthrowされる。 e === undefined であり親がない場合、 AssertionError がthrowされる。

      Parameters

      • Optionale: E

        削除する子エンティティ。省略された場合、自身を親から削除する

      Returns void

    • 自分自身と子孫の内容を描画する。

      このメソッドは、 Renderer#draw() からエンティティのツリー構造をトラバースする過程で暗黙に呼び出される。 通常、ゲーム開発者がこのメソッドを呼び出す必要はない。

      Parameters

      • renderer: Renderer

        描画先に対するRenderer

      • Optionalcamera: Camera

        対象のカメラ。省略された場合、undefined

      Returns void

    • キャッシュの描画が必要な場合にこのメソッドが呼ばれる。 本クラスを継承したエンティティはこのメソッド内でrendererに対してキャッシュの内容を描画しなければならない。 このメソッドはエンジンから暗黙に呼び出され、ゲーム開発者が呼び出す必要はない。

      Parameters

      Returns void

    • オブジェクトのサイズを相対的に変更する。 このメソッドは widthheight を同時に加算するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

      Parameters

      • width: number

        加算する幅

      • height: number

        加算する高さ

      Returns void

    • オブジェクトのサイズを設定する。 このメソッドは widthheight を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

      Parameters

      • width: number

      • height: number

        高さ

      Returns void

    • オブジェクトのサイズを設定する。 このメソッドは widthheight を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

      Parameters

      Returns void

    • オブジェクトの拡大率を設定する。 このメソッドは scaleXscaleY に同じ値を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

      Parameters

      • scale: number

        拡大率

      Returns void

    • このメソッドは、 E#findPointSourceByPoint() 内で子孫の探索をスキップすべきか判断するために呼ばれる。 通常、子孫の描画方法をカスタマイズする一部のサブクラスにおいて、与えられた座標に対する子孫の探索を制御する場合に利用する。 ゲーム開発者がこのメソッドを呼び出す必要はない。

      戻り値は、子孫の探索をスキップすべきであれば偽、でなければ真である。

      Parameters

      • _point: CommonOffset

        このエンティティ(this)の位置を基準とした相対座標

      Returns boolean

    • このEを表示状態にする。

      this.hide() によって非表示状態にされたエンティティを表示状態に戻す。 生成直後のエンティティは表示状態であり、 hide() を呼び出さない限りこのメソッドを呼び出す必要はない。

      Returns void