Class TextData

文字列を描画する時の情報を保持するクラス

Constructors

constructor

Properties

_anchor _template _text _text_break_margin

Accessors

height height_str_new_line width width_str_new_line

Methods

anchor color copy draw draw_color_tag draw_new_line draw_new_line_color_tag equals font opacity outline_color outline_thickness shadow_color shadow_thickness template text text_break_margin

Constructors

constructor

Properties

Private Readonly _anchor

_anchor: Vector2

文字列を描画する座標の基準となる位置

Private _template

_template: text_data_template_t

値が設定されていないときに使用するテンプレート

Private _text

_text: string

描画する文字列

Private _text_break_margin

_text_break_margin: number

改行を含む文字列を描画するときの行間

Accessors

height

height_str_new_line

  • get height_str_new_line(): number

  • 改行を考慮してフォントを適応した文字の高さ

    Returns number

width

width_str_new_line

  • get width_str_new_line(): number

  • 改行を考慮してフォントを適応した文字の横幅

    Returns number

Methods

anchor

color

copy

draw

  • draw(ctx, x, y): void

  • テキストデータを描画する

    Parameters

    • ctx: CanvasRenderingContext2D

      描画する CanvasRenderingContext2D

    • x: number

      基準となる x 座標

    • y: number

      基準となる y 座標

    Returns void

draw_color_tag

  • draw_color_tag(ctx, x, y): void

  • 文字列内にカラーコードがあるテキストデータを描画する

    Parameters

    • ctx: CanvasRenderingContext2D

      描画する CanvasRenderingContext2D

    • x: number

      基準となる x 座標

    • y: number

      基準となる y 座標

    Returns void

draw_new_line

  • draw_new_line(ctx, x, y): void

  • テキストデータを描画し、改行文字で改行する

    Parameters

    • ctx: CanvasRenderingContext2D

      描画する CanvasRenderingContext2D

    • x: number

      基準となる x 座標

    • y: number

      基準となる y 座標

    Returns void

draw_new_line_color_tag

  • draw_new_line_color_tag(ctx, x, y): void

  • 文字列内にカラーコードがあるテキストデータを描画し、改行文字で改行する

    Parameters

    • ctx: CanvasRenderingContext2D

      描画する CanvasRenderingContext2D

    • x: number

      基準となる x 座標

    • y: number

      基準となる y 座標

    Returns void

equals

  • equals(text_data): boolean

  • テキストデータが完全に同じかどうかを比較する

    Parameters

    • text_data: TextData

      比較対象のテキストデータ

    Returns boolean

    完全に同じテキストデータの場合は true

font

opacity

outline_color

outline_thickness

  • outline_thickness(): number

  • アウトラインの太さを取得する

    Returns number

    アウトラインの太さ

  • outline_thickness(outline_thickness): TextData

  • アウトラインの太さを設定する

    Parameters

    • outline_thickness: number

      アウトラインの太さ

    Returns TextData

    渡された値を設定したテキストデータ

shadow_color

shadow_thickness

  • shadow_thickness(): number

  • 影の太さを取得する

    Returns number

    影の太さ

  • shadow_thickness(shadow_thickness): TextData

  • 影の太さを設定する

    Parameters

    • shadow_thickness: number

      影の太さ

    Returns TextData

    渡された値を設定したテキストデータ

template

text

  • text(): string

  • 描画するテキストを取得する

    Returns string

    描画する文字列

  • text(text): TextData

  • 描画するテキストを設定する

    Parameters

    • text: string

      描画する文字列

    Returns TextData

    渡された値を設定したテキストデータ

text_break_margin

  • text_break_margin(): number

  • 改行を含む文字列を描画するときの行間を取得する

    Returns number

    行間

  • text_break_margin(text_break_margin): TextData

  • 改行を含む文字列を描画するときの行間を設定する

    Parameters

    • text_break_margin: number

      行間

    Returns TextData

    渡された値を設定したテキストデータ

Settings

Member Visibility

Theme

On This Page

constructor_anchor_template_text_text_break_marginheightheight_str_new_linewidthwidth_str_new_lineanchorcolorcopydrawdraw_color_tagdraw_new_linedraw_new_line_color_tagequalsfontopacityoutline_coloroutline_thicknessshadow_colorshadow_thicknesstemplatetexttext_break_margin