Window.d overview

Table of contents

• utils
  • Window (class)
    • destroy (method)
    • update (method)
    • move (method)
    • isOpen (method)
    • isClosed (method)
    • setCursorRect (method)
    • moveCursorBy (method)
    • moveInnerChildrenBy (method)
    • setTone (method)
    • addChildToBack (method)
    • addInnerChild (method)
    • updateTransform (method)
    • drawShape (method)
    • _createAllParts (method)
    • _createContainer (method)
    • _createBackSprite (method)
    • _createFrameSprite (method)
    • _createClientArea (method)
    • _createContentsBackSprite (method)
    • _createCursorSprite (method)
    • _createContentsSprite (method)
    • _createArrowSprites (method)
    • _createPauseSignSprites (method)
    • _onWindowskinLoad (method)
    • _refreshAllParts (method)
    • _refreshBack (method)
    • _refreshFrame (method)
    • _refreshCursor (method)
    • _setRectPartsGeometry (method)
    • _refreshArrows (method)
    • _refreshPauseSign (method)
    • _updateClientArea (method)
    • _updateFrame (method)
    • _updateContentsBack (method)
    • _updateCursor (method)
    • _makeCursorAlpha (method)
    • _updateContents (method)
    • _updateArrows (method)
    • _updatePauseSign (method)
    • _updateFilterArea (method)
    • _isWindow (property)
    • _windowskin (property)
    • _width (property)
    • _height (property)
    • _cursorRect (property)
    • _openness (property)
    • _animationCount (property)
    • _padding (property)
    • _margin (property)
    • _colorTone (property)
    • _innerChildren (property)
    • _container (property)
    • _backSprite (property)
    • _frameSprite (property)
    • _contentsBackSprite (property)
    • _cursorSprite (property)
    • _contentsSprite (property)
    • _downArrowSprite (property)
    • _upArrowSprite (property)
    • _pauseSignSprite (property)
    • _clientArea (property)
    • origin (property)
    • active (property)
    • frameVisible (property)
    • cursorVisible (property)
    • downArrowVisible (property)
    • upArrowVisible (property)
    • pause (property)

utils

Window (class)

The window in the game.

Signature

export declare class Window {
  constructor()
}

destroy (method)

Destroys the window.

Signature

destroy(_options?: PIXIDestroyOptions): void

update (method)

Updates the window for each frame.

Signature

update(): void

move (method)

Sets the x, y, width, and height all at once.

Signature

move(x: number, y: number, width: number, height: number): void

isOpen (method)

Checks whether the window is completely open (openness == 255).

Signature

isOpen(): boolean

isClosed (method)

Checks whether the window is completely closed (openness == 0).

Signature

isClosed(): boolean

setCursorRect (method)

Sets the position of the command cursor.

Signature

setCursorRect(x: number, y: number, width: number, height: number): void

moveCursorBy (method)

Moves the cursor position by the given amount.

Signature

moveCursorBy(x: number, y: number): void

moveInnerChildrenBy (method)

Moves the inner children by the given amount.

Signature

moveInnerChildrenBy(x: number, y: number): void

setTone (method)

Changes the color of the background.

Signature

setTone(r: number, g: number, b: number): void

addChildToBack (method)

Adds a child between the background and contents.

Signature

addChildToBack(child: PIXI.DisplayObject): PIXI.DisplayObject

addInnerChild (method)

Adds a child to the client area.

Signature

addInnerChild(child: PIXI.DisplayObject): PIXI.DisplayObject

updateTransform (method)

Updates the transform on all children of this container for rendering.

Signature

updateTransform(): void

drawShape (method)

Draws the window shape into PIXI.Graphics object. Used by WindowLayer.

Signature

drawShape(graphics: PIXI.Graphics): void

_createAllParts (method)

Signature

_createAllParts(): void

_createContainer (method)

Signature

_createContainer(): void

_createBackSprite (method)

Signature

_createBackSprite(): void

_createFrameSprite (method)

Signature

_createFrameSprite(): void

_createClientArea (method)

Signature

_createClientArea(): void

_createContentsBackSprite (method)

Signature

_createContentsBackSprite(): void

_createCursorSprite (method)

Signature

_createCursorSprite(): void

_createContentsSprite (method)

Signature

_createContentsSprite(): void

_createArrowSprites (method)

Signature

_createArrowSprites(): void

_createPauseSignSprites (method)

Signature

_createPauseSignSprites(): void

_onWindowskinLoad (method)

Signature

_onWindowskinLoad(): void

_refreshAllParts (method)

Signature

_refreshAllParts(): void

_refreshBack (method)

Signature

_refreshBack(): void

_refreshFrame (method)

Signature

_refreshFrame(): void

_refreshCursor (method)

Signature

_refreshCursor(): void

_setRectPartsGeometry (method)

Signature

_setRectPartsGeometry(sprite: Sprite<null>, srect: Rectangle, drect: Rectangle, m: number): void

_refreshArrows (method)

Signature

_refreshArrows(): void

_refreshPauseSign (method)

Signature

_refreshPauseSign(): void

_updateClientArea (method)

Signature

_updateClientArea(): void

_updateFrame (method)

Signature

_updateFrame(): void

_updateContentsBack (method)

Signature

_updateContentsBack(): void

_updateCursor (method)

Signature

_updateCursor(): void

_makeCursorAlpha (method)

Signature

_makeCursorAlpha(): number

_updateContents (method)

Signature

_updateContents(): void

_updateArrows (method)

Signature

_updateArrows(): void

_updatePauseSign (method)

Signature

_updatePauseSign(): void

_updateFilterArea (method)

Signature

_updateFilterArea(): void

_isWindow (property)

Signature

_isWindow: boolean

_windowskin (property)

Signature

_windowskin: Bitmap

_width (property)

Signature

_width: number

_height (property)

Signature

_height: number

_cursorRect (property)

Signature

_cursorRect: Rectangle

_openness (property)

Signature

_openness: number

_animationCount (property)

Signature

_animationCount: number

_padding (property)

Signature

_padding: number

_margin (property)

Signature

_margin: number

_colorTone (property)

Signature

_colorTone: Color

_innerChildren (property)

Signature

_innerChildren: any[]

_container (property)

Signature

_container: any

_backSprite (property)

Signature

_backSprite: Sprite<Bitmap>

_frameSprite (property)

Signature

_frameSprite: Sprite<null>

_contentsBackSprite (property)

Signature

_contentsBackSprite: Sprite<Bitmap>

_cursorSprite (property)

Signature

_cursorSprite: Sprite<null>

_contentsSprite (property)

Signature

_contentsSprite: Sprite<Bitmap>

_downArrowSprite (property)

Signature

_downArrowSprite: Sprite<Bitmap>

_upArrowSprite (property)

Signature

_upArrowSprite: Sprite<Bitmap>

_pauseSignSprite (property)

Signature

_pauseSignSprite: Sprite<Bitmap>

_clientArea (property)

Signature

_clientArea: Sprite<null>

origin (property)

The origin point of the window for scrolling.

Signature

origin: Point

active (property)

The active state for the window.

Signature

active: boolean

frameVisible (property)

The visibility of the frame.

Signature

frameVisible: boolean

cursorVisible (property)

The visibility of the cursor.

Signature

cursorVisible: boolean

downArrowVisible (property)

The visibility of the down scroll arrow.

Signature

downArrowVisible: boolean

upArrowVisible (property)

The visibility of the up scroll arrow.

Signature

upArrowVisible: boolean

pause (property)

The visibility of the pause sign.

Signature

pause: boolean