TextBox | Anywhere Teacher Activity Project Documentation

Hierarchy

TextBox

Index

Constructors

constructor

Methods

Constructors

constructor

new TextBox(game: Game, options: ITextBoxOptions): TextBox

- Defined in src/widget/TextBox.ts:161
Parameters
- game: Game
- options: ITextBoxOptions
Returns TextBox

Accessors

animation

get animation(): Tween
set animation(value: Tween): void

- Defined in src/widget/TextBox.ts:309
Returns Tween
- Defined in src/widget/TextBox.ts:313
Parameters
- value: Tween
Returns void

backgroundAlpha

get backgroundAlpha(): number
set backgroundAlpha(backgroundAlpha: number): void

- Defined in src/widget/TextBox.ts:285
Returns number
- Defined in src/widget/TextBox.ts:289
Parameters
- backgroundAlpha: number
Returns void

backgroundColor

get backgroundColor(): number
set backgroundColor(backgroundColor: number): void

- Defined in src/widget/TextBox.ts:277
Returns number
- Defined in src/widget/TextBox.ts:281
Parameters
- backgroundColor: number
Returns void

borderInstance

get borderInstance(): Image
set borderInstance(borderInstance: Image): void

- Defined in src/widget/TextBox.ts:301
Returns Image
- Defined in src/widget/TextBox.ts:305
Parameters
- borderInstance: Image
Returns void

boxHeight

get boxHeight(): number
set boxHeight(height: number): void

- Defined in src/widget/TextBox.ts:237
Returns number
- Defined in src/widget/TextBox.ts:241
Parameters
- height: number
Returns void

boxInstance

get boxInstance(): Image
set boxInstance(boxInstance: Image): void

- Defined in src/widget/TextBox.ts:293
Returns Image
- Defined in src/widget/TextBox.ts:297
Parameters
- boxInstance: Image
Returns void

boxLineColor

get boxLineColor(): number
set boxLineColor(lineColor: number): void

- Defined in src/widget/TextBox.ts:253
Returns number
- Defined in src/widget/TextBox.ts:257
Parameters
- lineColor: number
Returns void

boxLineWidth

get boxLineWidth(): number
set boxLineWidth(lineWidth: number): void

- Defined in src/widget/TextBox.ts:245
Returns number
- Defined in src/widget/TextBox.ts:249
Parameters
- lineWidth: number
Returns void

boxPadding

get boxPadding(): number
set boxPadding(padding: number): void

- Defined in src/widget/TextBox.ts:261
Returns number
- Defined in src/widget/TextBox.ts:265
Parameters
- padding: number
Returns void

boxPositionX

get boxPositionX(): number
set boxPositionX(pos: number): void

- Defined in src/widget/TextBox.ts:213
Returns number
- Defined in src/widget/TextBox.ts:217
Parameters
- pos: number
Returns void

boxPositionY

get boxPositionY(): number
set boxPositionY(pos: number): void

- Defined in src/widget/TextBox.ts:221
Returns number
- Defined in src/widget/TextBox.ts:225
Parameters
- pos: number
Returns void

boxWidth

get boxWidth(): number
set boxWidth(width: number): void

- Defined in src/widget/TextBox.ts:229
Returns number
- Defined in src/widget/TextBox.ts:233
Parameters
- width: number
Returns void

context

get context(): any
set context(value: any): void

- Defined in src/widget/TextBox.ts:373
Returns any
- Defined in src/widget/TextBox.ts:377
Parameters
- value: any
Returns void

fontMetrics

get fontMetrics(): any
set fontMetrics(value: any): void

- Defined in src/widget/TextBox.ts:381
Returns any
- Defined in src/widget/TextBox.ts:385
Parameters
- value: any
Returns void

game

get game(): Game
set game(value: Game): void

- Defined in src/widget/TextBox.ts:205
Returns Game
- Defined in src/widget/TextBox.ts:209
Parameters
- value: Game
Returns void

shouldFillBoxBackground

get shouldFillBoxBackground(): boolean
set shouldFillBoxBackground(backgroundColor: boolean): void

- Defined in src/widget/TextBox.ts:269
Returns boolean
- Defined in src/widget/TextBox.ts:273
Parameters
- backgroundColor: boolean
Returns void

shouldShowTrash

get shouldShowTrash(): boolean
set shouldShowTrash(value: boolean): void

- Defined in src/widget/TextBox.ts:389
Returns boolean
- Defined in src/widget/TextBox.ts:393
Parameters
- value: boolean
Returns void

textColor

get textColor(): number
set textColor(textColor: number): void

- Defined in src/widget/TextBox.ts:333
Returns number
- Defined in src/widget/TextBox.ts:337
Parameters
- textColor: number
Returns void

textFont

get textFont(): string
set textFont(value: string): void

- Defined in src/widget/TextBox.ts:349
Returns string
- Defined in src/widget/TextBox.ts:353
Parameters
- value: string
Returns void

textFontSize

get textFontSize(): number
set textFontSize(textFontSize: number): void

- Defined in src/widget/TextBox.ts:325
Returns number
- Defined in src/widget/TextBox.ts:329
Parameters
- textFontSize: number
Returns void

textInstance

get textInstance(): Text
set textInstance(textInstance: Text): void

- Defined in src/widget/TextBox.ts:317
Returns Text
- Defined in src/widget/TextBox.ts:321
Parameters
- textInstance: Text
Returns void

textLineSpacing

get textLineSpacing(): number
set textLineSpacing(value: number): void

- Defined in src/widget/TextBox.ts:365
Returns number
- Defined in src/widget/TextBox.ts:369
Parameters
- value: number
Returns void

textStatic

get textStatic(): string
set textStatic(textStatic: string): void

- Defined in src/widget/TextBox.ts:341
Returns string
- Defined in src/widget/TextBox.ts:345
Parameters
- textStatic: string
Returns void

textWeight

get textWeight(): string
set textWeight(value: string): void

- Defined in src/widget/TextBox.ts:357
Returns string
- Defined in src/widget/TextBox.ts:361
Parameters
- value: string
Returns void

trashCan

get trashCan(): Sprite
set trashCan(value: Sprite): void

- Defined in src/widget/TextBox.ts:397
Returns Sprite
- Defined in src/widget/TextBox.ts:401
Parameters
- value: Sprite
Returns void

trashCanColor

get trashCanColor(): number
set trashCanColor(value: number): void

- Defined in src/widget/TextBox.ts:421
Returns number
- Defined in src/widget/TextBox.ts:425
Parameters
- value: number
Returns void

trashCanImage

get trashCanImage(): ITrashCanImage
set trashCanImage(value: ITrashCanImage): void

- Defined in src/widget/TextBox.ts:405
Returns ITrashCanImage
- Defined in src/widget/TextBox.ts:409
Parameters
- value: ITrashCanImage
Returns void

trashCanOnInputDown

get trashCanOnInputDown(): Function
set trashCanOnInputDown(value: Function): void

- Defined in src/widget/TextBox.ts:429
Returns Function
- Defined in src/widget/TextBox.ts:433
Parameters
- value: Function
Returns void

trashCanScale

get trashCanScale(): number
set trashCanScale(value: number): void

- Defined in src/widget/TextBox.ts:413
Returns number
- Defined in src/widget/TextBox.ts:417
Parameters
- value: number
Returns void

Methods

createText

createText(initialText?: string): void

- Defined in src/widget/TextBox.ts:530
Create the Text instance and add to the game world

Parameters
- Default value initialText: string = ""
Returns void

createTextBoundingBox

createTextBoundingBox(): void

- Defined in src/widget/TextBox.ts:456
Create the Text Bounding Box instance and add to the game world
- create a background box with optional configurable fill and no border
- create a border box with a configurable line border and no background fill
- place border box over the top of the background box to create a bordered bounding box
- maintain discrete access to both instances for manipulation
Returns void

destroy

destroy(): void

- Defined in src/widget/TextBox.ts:628
Destroy ALL Phaser instances that are associated to the TextBox object

Use the destroy method on the instance to fully remove it and its allocations and clear the reference to the instance in the TextBox object.

Returns void

getContext

getContext(): any

- Defined in src/widget/TextBox.ts:650
Get the HTML5 Canvas 2D context

Returns any

canvas context

getFontMetrics

getFontMetrics(): any

- Defined in src/widget/TextBox.ts:681
Get the PIXI.IFontMetrics for the rendered font

interface PIXI.IFontMetrics { ascent: number, descent: number, fontSize: number }

Returns any

PIXI.IFontMetrics from the Phaser Font Cache

getFontString

getFontString(): string

- Defined in src/widget/TextBox.ts:667
Build a font identifier string
- uses the font based on the set TextBox properties
  - textWeight
  - text.textFontSize
  - textFont
for example: "bold 24px 'Arial'"
Returns string

font ID string

getTextInfo

getTextInfo(): { width: number }

- Defined in src/widget/TextBox.ts:691
Calculate the pixel length of the textInstance.text string
- based on the current font set in the 2D canvas context
Returns { width: number }

object: width in pixels of the current textInstance.text
- width: number

pause

pause(): void

- Defined in src/widget/TextBox.ts:581
Pause TextBox
- when trashCan is present disable its input handler and hide it
- stop the animation
Returns void

resume

resume(): void

- Defined in src/widget/TextBox.ts:565
Resume TextBox
- when trashCan is present enable its input handler and show it
- start the animation
Returns void

tintBackgroundOff

tintBackgroundOff(): void

- Defined in src/widget/TextBox.ts:606
Turn off tint which is by setting it numeric white (0xFFFFFF)

Returns void

tintBackgroundOn

tintBackgroundOn(tintColor: number): void

- Defined in src/widget/TextBox.ts:599
Tint the background fill give numeric color

Parameters
- tintColor: number
  
  numeric color
Returns void