Class LUIStyleText

Hierarchy

LUIStyleElement
- LUIStyleText

Constructors

constructor

new LUIStyleText(): LUIStyleText
Returns LUIStyleText
Inherited from LUIStyleElement.constructor
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/lui/LUIStyle.ts:90

Properties

`Protected` _cacheId

_cacheId: string

blendMode

blendMode: BlendMode = BlendMode.BM_NORMAL

enabled

enabled: boolean = true

mixColor

mixColor: Color = ...

onDrawAfter

onDrawAfter: ((renderer: FatRenderer, rect: LUIRect, x: number, y: number, width: number, height: number) => void)

Type declaration

- (renderer: FatRenderer, rect: LUIRect, x: number, y: number, width: number, height: number): void
- Parameters
  - renderer: FatRenderer
  - rect: LUIRect
  - x: number
  - y: number
  - width: number
  - height: number
  Returns void

onDrawBefore

onDrawBefore: ((renderer: FatRenderer, rect: LUIRect, x: number, y: number, width: number, height: number) => void)

Type declaration

- (renderer: FatRenderer, rect: LUIRect, x: number, y: number, width: number, height: number): void
- Parameters
  - renderer: FatRenderer
  - rect: LUIRect
  - x: number
  - y: number
  - width: number
  - height: number
  Returns void

onPaddingSpace

onPaddingSpace: boolean = false

Set to true so the style will be rendered on Padding space.

pixelOutlineColor

pixelOutlineColor: Color = null

if not null => text is rendered with an outline.

The result is the standard simple pixel-art outline (no fancy options atm).

pixelOutlineOffset

pixelOutlineOffset: number = 1

pixelShadowColor

pixelShadowColor: Color = null

if not null => text is rendered twice first with shadow color, second with mixColor

pixelShadowDistanceX

pixelShadowDistanceX: number = 1

pixelShadowDistanceY

pixelShadowDistanceY: number = 1

textOffsetX

textOffsetX: number = 0

textOffsetY

textOffsetY: number = 0

`Static` `Protected` _globalCacheId

_globalCacheId: number = 0

Methods

directDraw

directDraw(label: LUITextBox, renderer: FatRenderer, rect: LUIRect, blendMode: BlendMode): void
Parameters
- label: LUITextBox
- renderer: FatRenderer
- rect: LUIRect
- blendMode: BlendMode
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/lui/styles/LUIStyleText.ts:73

`Private` drawLetterLines

drawLetterLines(label: LUITextBox, renderer: FatRenderer, font: SpriteSheetFont, rect: LUIRect, startY: number, blendMode: BlendMode, offsetX: number, offsetY: number, forceColor: Color): void
Parameters
- label: LUITextBox
- renderer: FatRenderer
- font: SpriteSheetFont
- rect: LUIRect
- startY: number
- blendMode: BlendMode
- offsetX: number
- offsetY: number
- forceColor: Color
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/lui/styles/LUIStyleText.ts:205

internRender

internRender(e: LUIElement, renderer: FatRenderer, rect: LUIRect): void
Here one needs to do the actual render part of the style element.
Parameters
- e: LUIElement
  
  is for context. do not use it for layout
- renderer: FatRenderer
  
  the renderer object. context is already taken care of.
- rect: LUIRect
  
  is the layouted rectangle in screen coordinates of the given element. Use this for layout!
Returns void
Overrides LUIStyleElement.internRender
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/lui/styles/LUIStyleText.ts:66

render

render(e: LUIElement, renderer: FatRenderer, rect: LUIRect, noPaddingRect: LUIRect): void
Parameters
- e: LUIElement
- renderer: FatRenderer
- rect: LUIRect
- noPaddingRect: LUIRect
Returns void
Inherited from LUIStyleElement.render
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/lui/LUIStyle.ts:94

replaceRenderFunction

replaceRenderFunction(drawer: RenderAllText): void
Parameters
- drawer: RenderAllText
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/lui/styles/LUIStyleText.ts:62

setPixelShadow

setPixelShadow(color: Color, distX?: number, distY?: number): void
Parameters
- color: Color
- distX: number = 1
- distY: number = 1
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/lui/styles/LUIStyleText.ts:55

Class LUIStyleText

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns LUIStyleText

Properties

Protected _cacheId

blendMode

enabled

mixColor

onDrawAfter

Type declaration

Parameters

renderer: FatRenderer

rect: LUIRect

x: number

y: number

width: number

height: number

Returns void

onDrawBefore

Type declaration

Parameters

renderer: FatRenderer

rect: LUIRect

x: number

y: number

width: number

height: number

Returns void

onPaddingSpace

pixelOutlineColor

pixelOutlineOffset

pixelShadowColor

pixelShadowDistanceX

pixelShadowDistanceY

textOffsetX

textOffsetY

Static Protected _globalCacheId

Methods

directDraw

Parameters

label: LUITextBox

renderer: FatRenderer

rect: LUIRect

blendMode: BlendMode

Returns void

Private drawLetterLines

Parameters

label: LUITextBox

renderer: FatRenderer

font: SpriteSheetFont

rect: LUIRect

startY: number

blendMode: BlendMode

offsetX: number

offsetY: number

forceColor: Color

Returns void

internRender

Parameters

e: LUIElement

renderer: FatRenderer

rect: LUIRect

Returns void

render

Parameters

e: LUIElement

renderer: FatRenderer

rect: LUIRect

noPaddingRect: LUIRect

Returns void

replaceRenderFunction

Parameters

drawer: RenderAllText

Returns void

`Protected` _cacheId

`Static` `Protected` _globalCacheId

`Private` drawLetterLines