alpha

alpha: number

alwaysUpdate

alwaysUpdate: boolean

ancestor

anchorPoint

autoTransform

autoTransform: boolean

blendMode

blendMode: string

body

currentTransform

edges

floating

floating: boolean

GUID

GUID: string

indices

indices: number[]

isDirty

isDirty: boolean

isKinematic

isKinematic: boolean

isPersistent

isPersistent: boolean

lineHeight

lineHeight: number

mask

metrics

name

name: string

onVisibilityChange

onVisibilityChange: Function

points

pos

shader

shader: any

textAlign

textAlign: string

textBaseline

textBaseline: string

type

type: string = "Rectangle"

updateWhenPaused

updateWhenPaused: boolean

wordWrapWidth

wordWrapWidth: number

bottom

• get bottom(): number

  Returns number

centerX

• get centerX(): number

  Returns number

• set centerX(value: number): void

  Returns void

centerY

• get centerY(): number

  Returns number

• set centerY(value: number): void

  Returns void

depth

• get depth(): number

  Returns number

• set depth(value: number): void

  Returns void

fillStyle

• get fillStyle(): Color

• set fillStyle(value: Color): void

  Returns void

height

• get height(): number

  Returns number

• set height(value: number): void

  Returns void

inViewport

• get inViewport(): boolean

  Returns boolean

• set inViewport(value: boolean): void

  Returns void

isFlippedX

• get isFlippedX(): boolean

  Returns boolean

isFlippedY

• get isFlippedY(): boolean

  Returns boolean

isFloating

• get isFloating(): boolean

  Returns boolean

left

• get left(): number

  Returns number

parentApp

• Returns Application

  the parent application or undefined if not attached to any container/app

right

• get right(): number

  Returns number

tint

• set tint(value: Color): void

  Returns void

top

• get top(): number

  Returns number

width

• get width(): number

  Returns number

• set width(value: number): void

  Returns void

angleTo

• angleTo(target: any): number

  Returns number

  angle in radians

centerOn

• Parameters

  • x: number
  • y: number

  Returns BitmapText

  this rectangle

clone

• Returns Rect

  new rectangle

contains

• contains(x: number, y: number): boolean

  Parameters

  • x: number
  • y: number

  Returns boolean

  True if the polygon contain the point, otherwise false

• Returns boolean

  True if the polygon contain the point, otherwise false

containsRectangle

• containsRectangle(rectangle: Rect): boolean

  Parameters

  • rectangle: Rect

  Returns boolean

  True if the rectangle contain the given rectangle, otherwise false

copy

distanceTo

• distanceTo(target: any): number

draw

• draw(renderer: any, text?: string, x?: number, y?: number): void

  Parameters

  • renderer: any
  • Optionaltext: string
  • Optionalx: number
  • Optionaly: number

  Returns void

equals

• equals(rect: Rect): boolean

  Returns boolean

  true if equals

flipX

• Parameters

  • Optionalflip: boolean = true

  Returns Renderable

  Reference to this object for method chaining

flipY

• Parameters

  • Optionalflip: boolean = true

  Returns Renderable

  Reference to this object for method chaining

getAbsolutePosition

• getAbsolutePosition(): Vector2d

  Returns Vector2d

getBounds

• Returns Bounds

  bounding box Rectangle object

getIndices

• Returns number[]

  an array of vertex indices for all triangles forming this polygon.

getOpacity

• Returns number

  current opacity value between 0 and 1

isConvex

• isConvex(): boolean | null

  Returns boolean | null

  true if the vertices are convex, false if not, null if not computable

isFinite

• Returns boolean

  false if all coordinates are positive or negative Infinity or NaN; otherwise, true.

lookAt

• Returns Renderable

  Reference to this object for method chaining

measureText

• measureText(text?: string): TextMetrics

  Parameters

  • Optionaltext: string = ...

  Returns TextMetrics

  a TextMetrics object with two properties: width and height, defining the output dimensions

onCollision

• Returns boolean

  true if the object should respond to the collision (its position and velocity will be corrected)

onDestroyEvent

• Returns void

overlaps

• overlaps(rect: Rect): boolean

  Returns boolean

  true if overlaps

postDraw

• postDraw(renderer: CanvasRenderer | WebGLRenderer): void

  Returns void

preDraw

• Returns void

recalc

• Returns BitmapText

  Reference to this object for method chaining

resize

rotate

• Parameters

  • angle: number
  • Optionalv: any

  Returns Renderable

  Reference to this object for method chaining

scale

• Parameters

  • x: number
  • Optionaly: number = x

  Returns Renderable

  Reference to this object for method chaining

scaleV

• Returns Renderable

  Reference to this object for method chaining

set

• set(textAlign: string, scale?: number): BitmapText

  Parameters

  • textAlign: string
  • Optionalscale: number

  Returns BitmapText

  this object for chaining

setOpacity

• setOpacity(alpha: number): void

  Returns void

setShape

• Returns BitmapText

  this instance for objecf chaining

setSize

• setSize(width: number, height: number): BitmapText

  Parameters

  • width: number
  • height: number

  Returns BitmapText

setText

• setText(value?: string | number | string[]): BitmapText

  Parameters

  • value: string | number | string[] = ""

  Returns BitmapText

  this object for chaining

setVertices

• Returns BitmapText

  this instance for objecf chaining

shift

• shift(x: number, y?: number): void

  Parameters

  • x: number
  • Optionaly: number

  Returns void

• Returns void

to2d

• Returns BitmapText

  Reference to this object for method chaining

toIso

• Returns BitmapText

  Reference to this object for method chaining

toPolygon

• Returns Polygon

  a new Polygon that represents this rectangle.

transform

• Returns Renderable

  Reference to this object for method chaining

translate

• translate(x: number, y?: number): Polygon

  Parameters

  • x: number
  • Optionaly: number

  Returns Polygon

  Reference to this object for method chaining

• Returns Polygon

  Reference to this object for method chaining

union

update

• update(dt: number): boolean

  Returns boolean

  true if the renderable is dirty

updateBounds

• updateBounds(absolute?: boolean): Bounds

  Parameters

  • Optionalabsolute: boolean = true

  Returns Bounds

  this Bitmap Text bounding box Rectangle object