Winter Cardinal UI - v0.457.0 / DTextPiece

Interface: DTextPiece<VALUE>

Type parameters

Name
VALUE

Hierarchy

• EventEmitter

  ↳ DTextPiece

Implemented by

• DTextPieceImpl

Table of contents

Properties

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

Methods

• addListener
• compute
• destroy
• emit
• eventNames
• getValue
• hide
• isShown
• listenerCount
• listeners
• off
• on
• once
• removeAllListeners
• removeListener
• setValue
• show

Properties

align

• Readonly align: DTextPieceAlign

Defined in

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

---

alpha

• alpha: DStateAwareOrValueMightBe<number>

Defined in

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

---

color

• color: DStateAwareOrValueMightBe<number>

Defined in

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

---

computed

• Readonly computed: undefined | VALUE

Defined in

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

---

formatter

• formatter: DTextPieceFormatter<VALUE>

Defined in

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

---

object

• Readonly object: undefined | null | DDynamicText

Defined in

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

---

style

• Readonly style: DTextPieceStyle

Defined in

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

---

value

• value: DStateAwareOrValueMightBe<VALUE>

Defined in

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

Methods

addListener

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

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

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

Defined in

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

---

destroy

▸ destroy(): this

Returns

this

Defined in

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

---

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.

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)[]

Inherited from

utils.EventEmitter.eventNames

Defined in

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

---

getValue

▸ getValue(): DStateAwareOrValueMightBe<VALUE>

Returns

DStateAwareOrValueMightBe<VALUE>

Defined in

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

---

hide

▸ hide(): this

Returns

this

Defined in

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

---

isShown

▸ isShown(): boolean

Returns

boolean

Defined in

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

---

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

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[]

Inherited from

utils.EventEmitter.listeners

Defined in

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

---

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

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.

Inherited from

utils.EventEmitter.on

Defined in

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

---

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.

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.

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.

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

Defined in

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

---

show

▸ show(): this

Returns

this

Defined in

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

Edit this page.