gameforge - v0.0.19
    Preparing search index...

    Class TextStyle

    Hierarchy

    • TextStyle
      • TextStyle
    Index

    Constructors

    • Parameters

      • Optionalstyle: Partial<ITextStyle>

        TextStyle properties to be set on the text. See PIXI.TextStyle.defaultStyle for the default values.

      Returns TextStyle

    Properties

    _align: TextStyleAlign
    _breakWords: boolean
    _dropShadow: boolean
    _dropShadowAlpha: number
    _dropShadowAngle: number
    _dropShadowBlur: number
    _dropShadowColor: string | number
    _dropShadowDistance: number
    _fill: TextStyleFill
    _fillGradientStops: number[]
    _fillGradientType: TEXT_GRADIENT
    _fontFamily: string | string[]
    _fontSize: string | number
    _fontStyle: TextStyleFontStyle
    _fontVariant: TextStyleFontVariant
    _fontWeight: TextStyleFontWeight
    _leading: number
    _letterSpacing: number
    _lineHeight: number
    _lineJoin: TextStyleLineJoin
    _miterLimit: number
    _padding: number
    _stroke: string | number
    _strokeThickness: number
    _textBaseline: TextStyleTextBaseline
    _trim: boolean
    _whiteSpace: TextStyleWhiteSpace
    _wordWrap: boolean
    _wordWrapWidth: number
    styleID: number
    defaultStyle: ITextStyle

    Default style options used for all TextStyle instances.

    Accessors

    • get align(): TextStyleAlign

      Alignment for multiline text, does not affect single line text.

      Returns TextStyleAlign

    • set align(align: TextStyleAlign): void

      Alignment for multiline text, does not affect single line text

      Parameters

      • align: TextStyleAlign

      Returns void

    • get breakWords(): boolean

      Indicates if lines can be wrapped within words, it needs wordWrap to be set to true.

      Returns boolean

    • set breakWords(breakWords: boolean): void

      Indicates if lines can be wrapped within words, it needs wordWrap to be set to true

      Parameters

      • breakWords: boolean

      Returns void

    • get dropShadow(): boolean

      Set a drop shadow for the text.

      Returns boolean

    • set dropShadow(dropShadow: boolean): void

      Set a drop shadow for the text

      Parameters

      • dropShadow: boolean

      Returns void

    • get dropShadowAlpha(): number

      Set alpha for the drop shadow.

      Returns number

    • set dropShadowAlpha(dropShadowAlpha: number): void

      Set alpha for the drop shadow

      Parameters

      • dropShadowAlpha: number

      Returns void

    • get dropShadowAngle(): number

      Set a angle of the drop shadow.

      Returns number

    • set dropShadowAngle(dropShadowAngle: number): void

      Set a angle of the drop shadow

      Parameters

      • dropShadowAngle: number

      Returns void

    • get dropShadowBlur(): number

      Set a shadow blur radius.

      Returns number

    • set dropShadowBlur(dropShadowBlur: number): void

      Set a shadow blur radius

      Parameters

      • dropShadowBlur: number

      Returns void

    • get dropShadowColor(): string | number

      A fill style to be used on the dropshadow e.g., 'red', '#00FF00'.

      Returns string | number

    • set dropShadowColor(dropShadowColor: string | number): void

      A fill style to be used on the dropshadow e.g., 'red', '#00FF00'

      Parameters

      • dropShadowColor: string | number

      Returns void

    • get dropShadowDistance(): number

      Set a distance of the drop shadow.

      Returns number

    • set dropShadowDistance(dropShadowDistance: number): void

      Set a distance of the drop shadow

      Parameters

      • dropShadowDistance: number

      Returns void

    • get fillGradientStops(): number[]

      If fill is an array of colours to create a gradient, this array can set the stop points (numbers between 0 and 1) for the color, overriding the default behaviour of evenly spacing them.

      Returns number[]

    • set fillGradientStops(fillGradientStops: number[]): void

      If fill is an array of colours to create a gradient, this array can set the stop points (numbers between 0 and 1) for the color, overriding the default behaviour of evenly spacing them.

      Parameters

      • fillGradientStops: number[]

      Returns void

    • get fillGradientType(): TEXT_GRADIENT

      If fill is an array of colours to create a gradient, this can change the type/direction of the gradient.

      Returns TEXT_GRADIENT

    • set fillGradientType(fillGradientType: TEXT_GRADIENT): void

      If fill is an array of colours to create a gradient, this can change the type/direction of the gradient. See PIXI.TEXT_GRADIENT

      Parameters

      • fillGradientType: TEXT_GRADIENT

      Returns void

    • get fontFamily(): string | string[]

      The font family, can be a single font name, or a list of names where the first is the preferred font.

      Returns string | string[]

    • set fontFamily(fontFamily: string | string[]): void

      The font family, can be a single font name, or a list of names where the first is the preferred font.

      Parameters

      • fontFamily: string | string[]

      Returns void

    • get fontSize(): string | number

      The font size (as a number it converts to px, but as a string, equivalents are '26px','20pt','160%' or '1.6em')

      Returns string | number

    • set fontSize(fontSize: string | number): void

      The font size (as a number it converts to px, but as a string, equivalents are '26px','20pt','160%' or '1.6em')

      Parameters

      • fontSize: string | number

      Returns void

    • get fontStyle(): TextStyleFontStyle

      The font style.

      Returns TextStyleFontStyle

    • set fontStyle(fontStyle: TextStyleFontStyle): void

      The font style.

      Parameters

      • fontStyle: TextStyleFontStyle

      Returns void

    • get fontVariant(): TextStyleFontVariant

      The font variant.

      Returns TextStyleFontVariant

    • set fontVariant(fontVariant: TextStyleFontVariant): void

      The font variant.

      Parameters

      • fontVariant: TextStyleFontVariant

      Returns void

    • get fontWeight(): TextStyleFontWeight

      The font weight.

      Returns TextStyleFontWeight

    • set fontWeight(fontWeight: TextStyleFontWeight): void

      The font weight.

      Parameters

      • fontWeight: TextStyleFontWeight

      Returns void

    • get leading(): number

      The space between lines.

      Returns number

    • set leading(leading: number): void

      The height of the line, a number that represents the vertical space that a letter uses.

      Parameters

      • leading: number

      Returns void

    • get letterSpacing(): number

      The amount of spacing between letters, default is 0.

      Returns number

    • set letterSpacing(letterSpacing: number): void

      The amount of spacing between letters, default is 0

      Parameters

      • letterSpacing: number

      Returns void

    • get lineHeight(): number

      The line height, a number that represents the vertical space that a letter uses.

      Returns number

    • set lineHeight(lineHeight: number): void

      The line height, a number that represents the vertical space that a letter uses

      Parameters

      • lineHeight: number

      Returns void

    • get lineJoin(): TextStyleLineJoin

      The lineJoin property sets the type of corner created, it can resolve spiked text issues. Default is 'miter' (creates a sharp corner).

      Returns TextStyleLineJoin

    • set lineJoin(lineJoin: TextStyleLineJoin): void

      The lineJoin property sets the type of corner created, it can resolve spiked text issues. Possible values "miter" (creates a sharp corner), "round" (creates a round corner) or "bevel" (creates a squared corner).

      Parameters

      • lineJoin: TextStyleLineJoin

      Returns void

    • get miterLimit(): number

      The miter limit to use when using the 'miter' lineJoin mode.

      This can reduce or increase the spikiness of rendered text.

      Returns number

    • set miterLimit(miterLimit: number): void

      The miter limit to use when using the 'miter' lineJoin mode. This can reduce or increase the spikiness of rendered text.

      Parameters

      • miterLimit: number

      Returns void

    • get padding(): number

      Occasionally some fonts are cropped. Adding some padding will prevent this from happening by adding padding to all sides of the text.

      Returns number

    • set padding(padding: number): void

      Occasionally some fonts are cropped. Adding some padding will prevent this from happening by adding padding to all sides of the text.

      Parameters

      • padding: number

      Returns void

    • get stroke(): string | number

      A canvas fillstyle that will be used on the text stroke, e.g., 'blue', '#FCFF00'

      Returns string | number

    • set stroke(stroke: string | number): void

      A canvas fillstyle that will be used on the text stroke, e.g., 'blue', '#FCFF00'

      Parameters

      • stroke: string | number

      Returns void

    • get strokeThickness(): number

      A number that represents the thickness of the stroke.

      Returns number

      0
      
    • set strokeThickness(strokeThickness: number): void

      A number that represents the thickness of the stroke. A value of 0 will disable stroke.

      Parameters

      • strokeThickness: number

      Returns void

    • get textBaseline(): TextStyleTextBaseline

      The baseline of the text that is rendered.

      Returns TextStyleTextBaseline

    • set textBaseline(textBaseline: TextStyleTextBaseline): void

      The baseline of the text that is rendered.

      Parameters

      • textBaseline: TextStyleTextBaseline

      Returns void

    • get trim(): boolean

      Trim transparent borders.

      Returns boolean

    • set trim(trim: boolean): void

      Trim transparent borders

      Parameters

      • trim: boolean

      Returns void

    • get whiteSpace(): TextStyleWhiteSpace

      How newlines and spaces should be handled. Default is 'pre' (preserve, preserve).

      value New lines Spaces
      'normal' Collapse Collapse
      'pre' Preserve Preserve
      'pre-line' Preserve Collapse

      Returns TextStyleWhiteSpace

    • set whiteSpace(whiteSpace: TextStyleWhiteSpace): void

      Determines whether newlines & spaces are collapsed or preserved "normal" (collapse, collapse), "pre" (preserve, preserve) | "pre-line" (preserve, collapse). It needs wordWrap to be set to true.

      Parameters

      • whiteSpace: TextStyleWhiteSpace

      Returns void

    • get wordWrap(): boolean

      Indicates if word wrap should be used.

      Returns boolean

    • set wordWrap(wordWrap: boolean): void

      Indicates if word wrap should be used

      Parameters

      • wordWrap: boolean

      Returns void

    • get wordWrapWidth(): number

      The width at which text will wrap, it needs wordWrap to be set to true.

      Returns number

    • set wordWrapWidth(wordWrapWidth: number): void

      The width at which text will wrap, it needs wordWrap to be set to true

      Parameters

      • wordWrapWidth: number

      Returns void

    Methods

    • Creates a new TextStyle object with the same values as this one. Note that the only the properties of the object are cloned.

      Returns TextStyle

      New cloned TextStyle object

    • Resets all properties to the defaults specified in TextStyle.prototype._default

      Returns void

    • Generates a font style string to use for TextMetrics.measureFont().

      Returns string

      Font style string, for passing to TextMetrics.measureFont()