MultiLineLabel | @akashic/akashic-engine

Hierarchy

CacheableE
- MultiLineLabel

Implements

Index

Constructors

constructor

Properties

Constructors

constructor

new MultiLineLabel(scene: Scene, text: string, font: BitmapFont, fontSize: number, width: number, lineBreak?: boolean): MultiLineLabel
new MultiLineLabel(param: MultiLineLabelParameterObject): MultiLineLabel

Overrides CacheableE.constructor
- Defined in lib/main.d.ts:6345
Parameters
- scene: Scene
- text: string
- font: BitmapFont
- fontSize: number
- width: number
- Optional lineBreak: boolean
Returns MultiLineLabel
Overrides CacheableE.constructor
- Defined in lib/main.d.ts:6356
Parameters
- param: MultiLineLabelParameterObject
Returns MultiLineLabel

Properties

Private _beforeBitmapFont

_beforeBitmapFont: BitmapFont

Private _beforeFontSize

_beforeFontSize: number

Private _beforeLineBreak

_beforeLineBreak: boolean

Private _beforeText

_beforeText: string

Private _beforeTextAlign

_beforeTextAlign: TextAlign

Private _beforeWidth

_beforeWidth: number

Private _cache

_cache: Surface

Private _cacheSize

_cacheSize: CommonSize

Private _hasTouchableChildren

_hasTouchableChildren: boolean

Private _matrix

_matrix: Matrix

Private _renderedCamera

_renderedCamera: Camera

Private _renderer

_renderer: Renderer

Private _shouldRenderChildren

_shouldRenderChildren: boolean

Private _targetCameras

_targetCameras: Camera[]

angle

angle: number

bitmapFont

bitmapFont: BitmapFont

children

children: E[]

compositeOperation

compositeOperation: CompositeOperation

height

height: number

id

id: number

lineBreak

lineBreak: boolean

lineGap

lineGap: number

local

local: boolean

message

message: Trigger<MessageEvent>

opacity

opacity: number

parent

parent: E | Scene

scaleX

scaleX: number

scaleY

scaleY: number

scene

scene: Scene

state

state: EntityStateFlags

tag

tag: any

targetCameras

targetCameras: Camera[]

text

text: string

textAlign

textAlign: TextAlign

textColor

textColor: string

touchable

touchable: boolean

update

update: Trigger<void>

width

width: number

x

x: number

y

y: number

Static Private PADDING

PADDING: number

Methods

Private _calculateBoundingRect

_calculateBoundingRect(m?: Matrix, c?: Camera): CommonRect

Inherited from E._calculateBoundingRect
- Defined in lib/main.d.ts:2156
Parameters
- Optional m: Matrix
- Optional c: Camera
Returns CommonRect

Private _disableTouchPropagation

_disableTouchPropagation(): void

Inherited from E._disableTouchPropagation
- Defined in lib/main.d.ts:2164
Returns void

Private _enableTouchPropagation

_enableTouchPropagation(): void

Inherited from E._enableTouchPropagation
- Defined in lib/main.d.ts:2160
Returns void

Private _isTargetOperation

_isTargetOperation(e: PointEvent): boolean

Inherited from E._isTargetOperation
- Defined in lib/main.d.ts:2168
Parameters
- e: PointEvent
Returns boolean

Private _lineBrokenText

_lineBrokenText(): string[]

- Defined in lib/main.d.ts:6380
Returns string[]

Private _offsetX

_offsetX(width: number): number

- Defined in lib/main.d.ts:6376
Parameters
- width: number
Returns number

Private _updateMatrix

_updateMatrix(): void

Inherited from Object2D._updateMatrix
- Defined in lib/main.d.ts:1851
Returns void

append

append(e: E): void

Inherited from E.append
- Defined in lib/main.d.ts:2060
Parameters
- e: E
Returns void

calculateBoundingRect

calculateBoundingRect(c?: Camera): CommonRect

Inherited from E.calculateBoundingRect
- Defined in lib/main.d.ts:2152
Parameters
- Optional c: Camera
Returns CommonRect

calculateCacheSize

calculateCacheSize(): CommonSize

Inherited from CacheableE.calculateCacheSize
- Defined in lib/main.d.ts:2258
Returns CommonSize

destroy

destroy(): void

Implementation of Destroyable.destroy

Overrides CacheableE.destroy
- Defined in lib/main.d.ts:6372
Returns void

destroyed

destroyed(): boolean

Implementation of Destroyable.destroyed

Inherited from E.destroyed
- Defined in lib/main.d.ts:2089
Returns boolean

findPointSourceByPoint

findPointSourceByPoint(point: CommonOffset, m?: Matrix, force?: boolean, camera?: Camera): PointSource

Inherited from E.findPointSourceByPoint
- Defined in lib/main.d.ts:2127
Parameters
- point: CommonOffset
- Optional m: Matrix
- Optional force: boolean
- Optional camera: Camera
Returns PointSource

game

game(): Game

Inherited from E.game
- Defined in lib/main.d.ts:2054
Returns Game

getMatrix

getMatrix(): Matrix

Inherited from Object2D.getMatrix
- Defined in lib/main.d.ts:1846
Returns Matrix

hide

hide(): void

Inherited from E.hide
- Defined in lib/main.d.ts:2146
Returns void

insertBefore

insertBefore(e: E, target: E): void

Inherited from E.insertBefore
- Defined in lib/main.d.ts:2069
Parameters
- e: E
- target: E
Returns void

invalidate

invalidate(): void

Overrides CacheableE.invalidate
- Defined in lib/main.d.ts:6366
Returns void

modified

modified(isBubbling?: boolean): void

Inherited from E.modified
- Defined in lib/main.d.ts:2102
Parameters
- Optional isBubbling: boolean
Returns void

moveBy

moveBy(x: number, y: number): void

Inherited from Object2D.moveBy
- Defined in lib/main.d.ts:1812
Parameters
- x: number
- y: number
Returns void

moveTo

moveTo(x: number, y: number): void
moveTo(obj: CommonOffset): void

Inherited from Object2D.moveTo
- Defined in lib/main.d.ts:1797
Parameters
- x: number
- y: number
Returns void
Inherited from Object2D.moveTo
- Defined in lib/main.d.ts:1804
Parameters
- obj: CommonOffset
Returns void

remove

remove(e?: E): void

Inherited from E.remove
- Defined in lib/main.d.ts:2078
Parameters
- Optional e: E
Returns void

render

render(renderer: Renderer, camera?: Camera): void

Inherited from E.render
- Defined in lib/main.d.ts:2037
Parameters
- renderer: Renderer
- Optional camera: Camera
Returns void

renderCache

renderCache(renderer: Renderer): void

Overrides CacheableE.renderCache
- Defined in lib/main.d.ts:6367
Parameters
- renderer: Renderer
Returns void

renderSelf

renderSelf(renderer: Renderer, camera?: Camera): boolean

Inherited from CacheableE.renderSelf

Overrides E.renderSelf
- Defined in lib/main.d.ts:2236
Parameters
- renderer: Renderer
- Optional camera: Camera
Returns boolean

renderSelfFromCache

renderSelfFromCache(renderer: Renderer): void

Inherited from CacheableE.renderSelfFromCache
- Defined in lib/main.d.ts:2241
Parameters
- renderer: Renderer
Returns void

resizeBy

resizeBy(width: number, height: number): void

Inherited from Object2D.resizeBy
- Defined in lib/main.d.ts:1835
Parameters
- width: number
- height: number
Returns void

resizeTo

resizeTo(width: number, height: number): void
resizeTo(size: CommonSize): void

Inherited from Object2D.resizeTo
- Defined in lib/main.d.ts:1820
Parameters
- width: number
- height: number
Returns void
Inherited from Object2D.resizeTo
- Defined in lib/main.d.ts:1827
Parameters
- size: CommonSize
Returns void

scale

scale(scale: number): void

Inherited from Object2D.scale
- Defined in lib/main.d.ts:1842
Parameters
- scale: number
Returns void

shouldFindChildrenByPoint

shouldFindChildrenByPoint(point: CommonOffset): boolean

Inherited from E.shouldFindChildrenByPoint
- Defined in lib/main.d.ts:2112
Parameters
- point: CommonOffset
Returns boolean

show

show(): void

Inherited from E.show
- Defined in lib/main.d.ts:2138
Returns void

visible

visible(): boolean

Inherited from E.visible
- Defined in lib/main.d.ts:2131
Returns boolean

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

scene: Scene

text: string

font: BitmapFont

fontSize: number

width: number

Optional lineBreak: boolean

Returns MultiLineLabel

Parameters

param: MultiLineLabelParameterObject

Returns MultiLineLabel

Properties

Private _beforeBitmapFont

Private _beforeFontSize

Private _beforeLineBreak

Private _beforeText

Private _beforeTextAlign

Private _beforeWidth

Private _cache

Private _cacheSize

Private _hasTouchableChildren

Private _matrix

Private _renderedCamera

Private _renderer

Private _shouldRenderChildren

Private _targetCameras

angle

bitmapFont

children

compositeOperation

fontSize

height

id

lineBreak

lineGap

local

message

opacity

parent

pointDown

pointMove

pointUp

scaleX

scaleY

scene

state

tag

targetCameras

text

textAlign

textColor

touchable

update

width

x

y

Static Private PADDING

Methods

Private _calculateBoundingRect

Parameters

Optional m: Matrix

Optional c: Camera

Returns CommonRect

Private _disableTouchPropagation

Returns void

Private _enableTouchPropagation

Returns void

Private _isTargetOperation

Parameters

e: PointEvent

Returns boolean

Private _lineBrokenText