Class BitmapFont

Hierarchy

Font
- BitmapFont

Index

Properties

Accessors

version

Methods

Properties

lineHeight

lineHeight: number = 16

metrics

metrics: AssetReference<FontMetrics> = new AssetReference(FontMetrics)

spacing

spacing: number = 0

texture

texture: AssetReference<Texture2D> = new AssetReference(Texture2D)

Accessors

version

get version(): number

- Defined in src/ui/Font/BitmapFont.ts:39
Returns number

Methods

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Overrides SerializableObject.destroy
- Defined in src/ui/Font/BitmapFont.ts:96
Returns void

getHeight

getHeight(): number

Overrides Font.getHeight
- Defined in src/ui/Font/BitmapFont.ts:73
Returns number

getTexture

getTexture(): Texture

Overrides Font.getTexture
- Defined in src/ui/Font/BitmapFont.ts:65
Returns Texture

getWidth

getWidth(): number

Overrides Font.getWidth
- Defined in src/ui/Font/BitmapFont.ts:69
Returns number

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Overrides Font.isLoaded
- Defined in src/ui/Font/BitmapFont.ts:91
Returns boolean

prepareForRendering

prepareForRendering(screenScaleFactor: number, maxWidth: number): void

Overrides Font.prepareForRendering
- Defined in src/ui/Font/BitmapFont.ts:174
Parameters
- screenScaleFactor: number
- maxWidth: number
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setAlignment

setAlignment(alignment: number): void

Overrides Font.setAlignment
- Defined in src/ui/Font/BitmapFont.ts:84
Parameters
- alignment: number
Returns void

setProperty

setProperty(name: string, value: any): void

Overrides SerializableObject.setProperty
- Defined in src/ui/Font/BitmapFont.ts:157
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

setText

setText(text: string): void

Overrides Font.setText
- Defined in src/ui/Font/BitmapFont.ts:77
Parameters
- text: string
Returns void

tesselate

tesselate(pivotX: number, pivotY: number): VertexBuffer

- Defined in src/ui/Font/BitmapFont.ts:111
Parameters
- pivotX: number
- pivotY: number
Returns VertexBuffer

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/ui/Font/BitmapFont.ts:104
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject