Winter Cardinal UI - v0.457.0 / DTextPieceImpl

Class: DTextPieceImpl<VALUE>

Type parameters

Name
VALUE

Hierarchy

• EventEmitter

  ↳ DTextPieceImpl

Implements

• DTextPiece<VALUE>

Table of contents

Constructors

• constructor

Properties

• _align
• _alpha
• _color
• _computed
• _dstyle
• _formatter
• _isVisible
• _object
• _parent
• _style
• _theme
• _value

Accessors

• align
• alpha
• color
• computed
• formatter
• object
• style
• value
• visible

Methods

• addListener
• compute
• destroy
• emit
• eventNames
• getValue
• hide
• isShown
• listenerCount
• listeners
• newAlpha
• newColor
• newComputed
• newObject
• off
• on
• onColorChange
• onComputedChange
• onValueChange
• once
• removeAllListeners
• removeListener
• setValue
• show
• update
• updateObject

Constructors

constructor

• new DTextPieceImpl<VALUE>(parent, theme, options?): DTextPieceImpl<VALUE>

Type parameters

Name
VALUE

Parameters

Name	Type
parent	DTextPieceImplParent
theme	DThemeTextPiece<VALUE>
options?	DTextPieceOptions<VALUE>

Returns

DTextPieceImpl<VALUE>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:43

Properties

_align

• Protected _align: DTextPieceAlign

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:39

---

_alpha

• Protected _alpha: DStateAwareOrValueMightBe<number>

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:36

---

_color

• Protected _color: DStateAwareOrValueMightBe<number>

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:35

---

_computed

• Protected Optional _computed: VALUE

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:34

---

_dstyle

• Protected _dstyle: DDynamicTextStyle

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:38

---

_formatter

• Protected _formatter: DTextPieceFormatter<VALUE>

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:40

---

_isVisible

• Protected _isVisible: boolean

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:41

---

_object

• Protected Optional _object: null | DDynamicText

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:32

---

_parent

• Protected _parent: DTextPieceImplParent

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:30

---

_style

• Protected _style: DTextPieceStyleImpl

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:37

---

_theme

• Protected _theme: DThemeTextPiece<VALUE>

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:31

---

_value

• Protected Optional _value: DStateAwareOrValueMightBe<VALUE>

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:33

Accessors

align

• get align(): DTextPieceAlign

Returns

DTextPieceAlign

Implementation of

DTextPiece.align

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:160

---

alpha

• get alpha(): DStateAwareOrValueMightBe<number>

Returns

DStateAwareOrValueMightBe<number>

Implementation of

DTextPiece.alpha

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:133

• set alpha(alpha): void

Parameters

Name	Type
alpha	DStateAwareOrValueMightBe<number>

Returns

void

Implementation of

DTextPiece.alpha

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:137

---

color

• get color(): DStateAwareOrValueMightBe<number>

Returns

DStateAwareOrValueMightBe<number>

Implementation of

DTextPiece.color

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:122

• set color(color): void

Parameters

Name	Type
color	DStateAwareOrValueMightBe<number>

Returns

void

Implementation of

DTextPiece.color

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:126

---

computed

• get computed(): undefined | VALUE

Returns

undefined | VALUE

Implementation of

DTextPiece.computed

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:107

---

formatter

• get formatter(): DTextPieceFormatter<VALUE>

Returns

DTextPieceFormatter<VALUE>

Implementation of

DTextPiece.formatter

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:111

• set formatter(formatter): void

Parameters

Name	Type
formatter	DTextPieceFormatter<VALUE>

Returns

void

Implementation of

DTextPiece.formatter

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:115

---

object

• get object(): undefined | null | DDynamicText

Returns

undefined | null | DDynamicText

Implementation of

DTextPiece.object

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:168

---

style

• get style(): DTextPieceStyle

Returns

DTextPieceStyle

Implementation of

DTextPiece.style

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:164

---

value

• get value(): DStateAwareOrValueMightBe<VALUE>

Returns

DStateAwareOrValueMightBe<VALUE>

Implementation of

DTextPiece.value

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:68

• set value(value): void

Parameters

Name	Type
value	DStateAwareOrValueMightBe<VALUE>

Returns

void

Implementation of

DTextPiece.value

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:72

---

visible

• get visible(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:278

• set visible(visible): void

Parameters

Name	Type
visible	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:286

Methods

addListener

▸ addListener(event, fn, context?): this

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Implementation of

DTextPiece.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25495

---

compute

▸ compute(forcibly?): void

Parameters

Name	Type
forcibly?	boolean

Returns

void

Implementation of

DTextPiece.compute

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:103

---

destroy

▸ destroy(): this

Returns

this

Implementation of

DTextPiece.destroy

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:312

---

emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
...args	any[]	Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Implementation of

DTextPiece.emit

Inherited from

utils.EventEmitter.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441

---

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Implementation of

DTextPiece.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415

---

getValue

▸ getValue(): DStateAwareOrValueMightBe<VALUE>

Returns

DStateAwareOrValueMightBe<VALUE>

Implementation of

DTextPiece.getValue

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:79

---

hide

▸ hide(): this

Returns

this

Implementation of

DTextPiece.hide

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:299

---

isShown

▸ isShown(): boolean

Returns

boolean

Implementation of

DTextPiece.isShown

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:304

---

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

number

Implementation of

DTextPiece.listenerCount

Inherited from

utils.EventEmitter.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432

---

listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

Function[]

Implementation of

DTextPiece.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

---

newAlpha

▸ newAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:259

---

newColor

▸ newColor(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:244

---

newComputed

▸ newComputed(): undefined | VALUE

Returns

undefined | VALUE

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:229

---

newObject

▸ newObject(): DDynamicText

Returns

DDynamicText

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:274

---

off

▸ off(event, fn?, context?, once?): this

Alias method for removeListener

Parameters

Name	Type
event	string | symbol
fn?	Function
context?	any
once?	boolean

Returns

this

Implementation of

DTextPiece.off

Inherited from

utils.EventEmitter.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25489

---

on

▸ on(event, fn, context?): this

Add a listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Implementation of

DTextPiece.on

Inherited from

utils.EventEmitter.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25452

---

onColorChange

▸ onColorChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:144

---

onComputedChange

▸ onComputedChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:308

---

onValueChange

▸ onValueChange(forcibly?): void

Parameters

Name	Type
forcibly?	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:90

---

once

▸ once(event, fn, context?): this

Add a one-time listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Implementation of

DTextPiece.once

Inherited from

utils.EventEmitter.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25463

---

removeAllListeners

▸ removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name	Type	Description
event?	string | symbol	The event name.

Returns

this

this.

Implementation of

DTextPiece.removeAllListeners

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25483

---

removeListener

▸ removeListener(event, fn?, context?, once?): this

Remove the listeners of a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn?	Function	Only remove the listeners that match this function.
context?	any	Only remove the listeners that have this context.
once?	boolean	Only remove one-time listeners.

Returns

this

this.

Implementation of

DTextPiece.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25475

---

setValue

▸ setValue(value, forcibly?): void

Parameters

Name	Type
value	DStateAwareOrValueMightBe<VALUE>
forcibly?	boolean

Returns

void

Implementation of

DTextPiece.setValue

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:83

---

show

▸ show(): this

Returns

this

Implementation of

DTextPiece.show

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:294

---

update

▸ update(layouter): void

Parameters

Name	Type
layouter	DImagePieceLayouter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:172

---

updateObject

▸ updateObject(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-text-piece-impl.ts:196

Edit this page.