Class BaseComment

コメントの描画を行うクラスの基底クラス

Hierarchy (View Summary)

BaseComment
- FlashComment
- HTML5Comment

Implements

IComment

Constructors

constructor

new BaseComment(
    comment: {
        content: string;
        date: number;
        date_usec: number;
        id: number;
        is_my_post: boolean;
        layer: number;
        mail: string[];
        owner: boolean;
        premium: boolean;
        user_id: number;
        vpos: number;
    },
    renderer: IRenderer,
    index: number,
    ctx: CommentInstanceContext,
): BaseComment
コンストラクタ
Parameters
- comment: {
      content: string;
      date: number;
      date_usec: number;
      id: number;
      is_my_post: boolean;
      layer: number;
      mail: string[];
      owner: boolean;
      premium: boolean;
      user_id: number;
      vpos: number;
  }
  処理対象のコメント
- renderer: IRenderer
  描画対象のレンダラークラス
- index: number
  コメントのインデックス
- ctx: CommentInstanceContext
  インスタンスコンテキスト
Returns BaseComment
- Defined in src/comments/BaseComment.ts:97

Properties

`Optional`buttonImage

buttonImage?: IRenderer | null

`Protected`cacheKey

cacheKey: string

`Optional`image

image?: IRenderer | null

index

index: number

`Readonly`pluginName

pluginName: string = "BaseComment"

pos

pos: { x: number; y: number }

posY

posY: number

`Protected` `Readonly`renderer

renderer: IRenderer

Accessors

content

get content(): string
Returns string
Implementation of IComment.content
- Defined in src/comments/BaseComment.ts:143
set content(_: string): void
Parameters
- _: string
Returns void
Implementation of IComment.content
- Defined in src/comments/BaseComment.ts:146

flash

get flash(): boolean
Returns boolean
Implementation of IComment.flash
- Defined in src/comments/BaseComment.ts:131

height

get height(): number
Returns number
Implementation of IComment.height
- Defined in src/comments/BaseComment.ts:128

invisible

get invisible(): boolean
Returns boolean
Implementation of IComment.invisible
- Defined in src/comments/BaseComment.ts:113

layer

get layer(): number
Returns number
Implementation of IComment.layer
- Defined in src/comments/BaseComment.ts:134

loc

get loc(): "ue" | "naka" | "shita"
Returns "ue" | "naka" | "shita"
Implementation of IComment.loc
- Defined in src/comments/BaseComment.ts:116

long

get long(): number
Returns number
Implementation of IComment.long
- Defined in src/comments/BaseComment.ts:119

mail

get mail(): string[]
Returns string[]
Implementation of IComment.mail
- Defined in src/comments/BaseComment.ts:140

owner

get owner(): boolean
Returns boolean
Implementation of IComment.owner
- Defined in src/comments/BaseComment.ts:137

vpos

get vpos(): number
Returns number
Implementation of IComment.vpos
- Defined in src/comments/BaseComment.ts:122

width

get width(): number
Returns number
Implementation of IComment.width
- Defined in src/comments/BaseComment.ts:125

Methods

`Protected`_cacheImage

_cacheImage(image: IRenderer): void
画像をキャッシュする
Parameters
- image: IRenderer
  キャッシュ対象の画像
Returns void
- Defined in src/comments/BaseComment.ts:436

`Protected`_draw

_draw(posX: number, posY: number, cursor?: Position): void
コメント本体を描画する
Parameters
- posX: number
  描画位置
- posY: number
  描画位置
- Optionalcursor: Position
  カーソルの位置
Returns void
- Defined in src/comments/BaseComment.ts:265

`Protected`_drawBackgroundColor

_drawBackgroundColor(posX: number, posY: number): void
コメントの背景を描画する
Parameters
- posX: number
  描画位置
- posY: number
  描画位置
Returns void
- Defined in src/comments/BaseComment.ts:324

`Protected`_drawCollision

_drawCollision(posX: number, posY: number, showCollision: boolean): void
コメントの当たり判定を描画する
Parameters
- posX: number
  描画位置
- posY: number
  描画位置
- showCollision: boolean
  当たり判定を表示するかどうか
Returns void
- Defined in src/comments/BaseComment.ts:365

`Protected`_drawDebugInfo

_drawDebugInfo(posX: number, posY: number): void
コメントのメタデータを描画する
Parameters
- posX: number
  描画位置
- posY: number
  描画位置
Returns void
- Defined in src/comments/BaseComment.ts:346

`Protected`_drawRectColor

_drawRectColor(posX: number, posY: number): void
枠コマンドで指定されている場合に枠を描画する
Parameters
- posX: number
  描画位置
- posY: number
  描画位置
Returns void
- Defined in src/comments/BaseComment.ts:302

`Protected`_generateTextImage

_generateTextImage(): IRenderer
コメントの画像を実際に生成する

Returns IRenderer
- Defined in src/comments/BaseComment.ts:427

`Protected`canGenerateTextImage

canGenerateTextImage(): boolean
Returns boolean
- Defined in src/comments/BaseComment.ts:480

`Protected`convertComment

convertComment(
    comment: {
        content: string;
        date: number;
        date_usec: number;
        id: number;
        is_my_post: boolean;
        layer: number;
        mail: string[];
        owner: boolean;
        premium: boolean;
        user_id: number;
        vpos: number;
    },
): FormattedCommentWithSize
サイズ計測などを行うためのラッパー関数
Parameters
- comment: {
      content: string;
      date: number;
      date_usec: number;
      id: number;
      is_my_post: boolean;
      layer: number;
      mail: string[];
      owner: boolean;
      premium: boolean;
      user_id: number;
      vpos: number;
  }
  コンストラクタで受け取ったコメント
Returns FormattedCommentWithSize
描画サイズを含むコメント
- Defined in src/comments/BaseComment.ts:203

draw

draw(
    vpos: number,
    showCollision: boolean,
    cursor?: Position,
    frameActiveState?: FrameActiveState,
): void
コメントを描画する
Parameters
- vpos: number
  vpos
- showCollision: boolean
  当たり判定を表示するか
- Optionalcursor: Position
  カーソルの位置
- OptionalframeActiveState: FrameActiveState
  フレーム単位で計算済みの active state
Returns void
Implementation of IComment.draw
- Defined in src/comments/BaseComment.ts:217

`Protected`getButtonImage

getButtonImage(
    _posX: number,
    _posY: number,
    _cursor?: Position,
): IRenderer | undefined
Parameters
- _posX: number
- _posY: number
- Optional_cursor: Position
Returns IRenderer | undefined
- Defined in src/comments/BaseComment.ts:484

`Protected`getCacheKey

getCacheKey(): string
Returns string
- Defined in src/comments/BaseComment.ts:500

`Protected`getCommentSize

getCommentSize(parsedData: FormattedCommentWithFont): FormattedCommentWithSize
コメントの描画サイズを計算する
Parameters
- parsedData: FormattedCommentWithFont
  コメント
Returns FormattedCommentWithSize
描画サイズを含むコメント
- Defined in src/comments/BaseComment.ts:155

`Protected`getTextImage

getTextImage(): IRenderer | null
コメントの画像を生成する

Returns IRenderer | null
生成した画像
- Defined in src/comments/BaseComment.ts:379

isHovered

isHovered(_cursor?: Position, _posX?: number, _posY?: number): boolean
Parameters
- Optional_cursor: Position
- Optional_posX: number
- Optional_posY: number
Returns boolean
Implementation of IComment.isHovered
- Defined in src/comments/BaseComment.ts:492

`Protected`measureText

measureText(comment: MeasureTextInput): MeasureTextResult
context.measureTextの複数行対応版画面外にはみ出すコメントの縮小も行う
Parameters
- comment: MeasureTextInput
  独自フォーマットのコメントデータ
Returns MeasureTextResult
- 描画サイズとリサイズの情報
- Defined in src/comments/BaseComment.ts:193

`Protected`parseCommandAndNicoscript

parseCommandAndNicoscript(
    comment: {
        content: string;
        date: number;
        date_usec: number;
        id: number;
        is_my_post: boolean;
        layer: number;
        mail: string[];
        owner: boolean;
        premium: boolean;
        user_id: number;
        vpos: number;
    },
): FormattedCommentWithFont
コメントに含まれるニコスクリプトを処理する
Parameters
- comment: {
      content: string;
      date: number;
      date_usec: number;
      id: number;
      is_my_post: boolean;
      layer: number;
      mail: string[];
      owner: boolean;
      premium: boolean;
      user_id: number;
      vpos: number;
  }
  処理対象のコメント
Returns FormattedCommentWithFont
処理結果
- Defined in src/comments/BaseComment.ts:167

`Protected`parseContent

parseContent(comment: string): ParseContentResult
コメントの本文をパースする
Parameters
- comment: string
  処理対象のコメント本文
Returns ParseContentResult
処理結果
- Defined in src/comments/BaseComment.ts:182

Class BaseComment

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseComment

Properties

OptionalbuttonImage

ProtectedcacheKey

comment

Protected Readonlyconfig

Protected Readonlyctx

Optionalimage

index

ReadonlypluginName

pos

posY

Protected Readonlyrenderer

Accessors

content

Returns string

Parameters

Returns void

flash

Returns boolean

height

Returns number

invisible

Returns boolean

layer

Returns number

loc

Returns "ue" | "naka" | "shita"

long

Returns number

mail

Returns string[]

owner

Returns boolean

vpos

Returns number

width

Returns number

Methods

Protected_cacheImage

Parameters

Returns void

Protected_draw

Parameters

Returns void

Protected_drawBackgroundColor

Parameters

Returns void

Protected_drawCollision

Parameters

Returns void

Protected_drawDebugInfo

Parameters

Returns void

Protected_drawRectColor

Parameters

Returns void

Protected_generateTextImage

Returns IRenderer

ProtectedcanGenerateTextImage

Returns boolean

ProtectedconvertComment

Parameters

Returns FormattedCommentWithSize

draw

Parameters

Returns void

ProtectedgetButtonImage

Parameters

`Optional`buttonImage

`Protected`cacheKey

`Protected` `Readonly`config

`Protected` `Readonly`ctx

`Optional`image

`Readonly`pluginName

`Protected` `Readonly`renderer

`Protected`_cacheImage

`Protected`_draw

`Protected`_drawBackgroundColor

`Protected`_drawCollision

`Protected`_drawDebugInfo

`Protected`_drawRectColor

`Protected`_generateTextImage

`Protected`canGenerateTextImage

`Protected`convertComment

`Protected`getButtonImage

`Protected`getCacheKey

`Protected`getCommentSize

`Protected`getTextImage

`Protected`measureText

`Protected`parseCommandAndNicoscript

`Protected`parseContent