Class FontFamily

Hierarchy

Font
- FontFamily

Index

Constructors

constructor

Properties

Accessors

shadow

Methods

Constructors

constructor

new FontFamily(): FontFamily

- Defined in src/ui/Font/FontFamily.ts:33
Returns FontFamily

Properties

bold

bold: boolean = false

family

family: string = "Arial"

italic

italic: boolean = false

size

size: number = 14

texture

texture: FontTexture

Accessors

shadow

set shadow(shadow: FontShadow | undefined): void

- Defined in src/ui/Font/FontFamily.ts:15
Parameters
- shadow: FontShadow | undefined
Returns void

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/FontFamily.ts:90
Returns void

getHeight

getHeight(): number

Overrides Font.getHeight
- Defined in src/ui/Font/FontFamily.ts:63
Returns number

getTexture

getTexture(): FontTexture

Overrides Font.getTexture
- Defined in src/ui/Font/FontFamily.ts:55
Returns FontTexture

getWidth

getWidth(): number

Overrides Font.getWidth
- Defined in src/ui/Font/FontFamily.ts:59
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

Inherited from Font.isLoaded
- Defined in src/ui/Font/Font.ts:26
Returns boolean

prepareForRendering

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

Overrides Font.prepareForRendering
- Defined in src/ui/Font/FontFamily.ts:85
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/FontFamily.ts:51
Parameters
- alignment: number
Returns void

setProperty

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

Overrides SerializableObject.setProperty
- Defined in src/ui/Font/FontFamily.ts:68
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/FontFamily.ts:47
Parameters
- text: string
Returns void

upgrade

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

Inherited from SerializableObject.upgrade
- Defined in src/core/SerializableObject.ts:50
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject