Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Game_Screen

The game object class for screen effect data, such as changes in color tone and flashes. aliased as $gameScreen.

class

Game_Screen

Hierarchy

  • Game_Screen

Index

Properties

Protected _brightness

_brightness: number

The _brightness property of the game screen; returned when calling the brightness method.

type

{number}

memberof

Game_Screen

Protected _fadeInDuration

_fadeInDuration: number

Protected _fadeOutDuration

_fadeOutDuration: number

Protected _flashColor

_flashColor: Array<number>

Protected _flashDuration

_flashDuration: number

Protected _pictures

_pictures: Array<Game_Picture>

The array of Game_Pictures that are attached to the game screen.

type

{Array}

memberof

Game_Screen

Protected _shake

_shake: number

Protected _shakeDirection

_shakeDirection: number

Protected _shakeDuration

_shakeDuration: number

Protected _shakePower

_shakePower: number

Protected _shakeSpeed

_shakeSpeed: number

Protected _tone

_tone: Array<number>

Protected _toneDuration

_toneDuration: number

Protected _toneTarget

_toneTarget: Array<number>

Protected _weatherDuration

_weatherDuration: number

Protected _weatherPower

_weatherPower: number

Protected _weatherPowerTarget

_weatherPowerTarget: number

Protected _weatherType

_weatherType: string

Protected _zoomDuration

_zoomDuration: number

Protected _zoomScale

_zoomScale: number

Protected _zoomScaleTarget

_zoomScaleTarget: number

Protected _zoomX

_zoomX: number

_zoomX property of the game screen.

type

{number}

memberof

Game_Screen

Protected _zoomY

_zoomY: number

_zoomY property of the game screen.

type

{number}

memberof

Game_Screen

Methods

brightness

  • brightness(): number

changeWeather

  • changeWeather(type: string, power: number, duration: number): void

clear

  • clear(): void

clearFade

  • clearFade(): void

clearFlash

  • clearFlash(): void

clearPictures

  • clearPictures(): void

clearShake

  • clearShake(): void

clearTone

  • clearTone(): void

clearWeather

  • clearWeather(): void

clearZoom

  • clearZoom(): void

eraseBattlePictures

  • eraseBattlePictures(): void

erasePicture

  • erasePicture(pictureId: number): void
  • Erases a picture from the screen given the respected picture id.

    memberof

    Game_Screen

    Parameters

    • pictureId: number

    Returns void

flashColor

  • flashColor(): Array<number>

maxPictures

  • maxPictures(): number

movePicture

  • movePicture(pictureId: number, origin: number, x: number, y: number, scaleX: number, scaleY: number, opacity: number, blendMode: number, duration: number): void
  • Parameters

    • pictureId: number
    • origin: number
    • x: number
    • y: number
    • scaleX: number
    • scaleY: number
    • opacity: number
    • blendMode: number
    • duration: number

    Returns void

onBattleStart

  • onBattleStart(): void

picture

realPictureId

  • realPictureId(pictureId: number): number

rotatePicture

  • rotatePicture(pictureId: number, speed: number): void

setZoom

  • setZoom(x: number, y: number, scale: number): void

shake

  • shake(): number

showPicture

  • showPicture(pictureId: number, name: string, origin: number, x: number, y: number, scaleX: number, scaleY: number, opacity: number, blendMode: number): void
  • Parameters

    • pictureId: number
    • name: string
    • origin: number
    • x: number
    • y: number
    • scaleX: number
    • scaleY: number
    • opacity: number
    • blendMode: number

    Returns void

startFadeIn

  • startFadeIn(duration: number): void

startFadeOut

  • startFadeOut(duration: number): void

startFlash

  • startFlash(color: Array<number>, duration: number): void

startFlashForDamage

  • startFlashForDamage(): void

startShake

  • startShake(power: number, speed: number, duration: number): void

startTint

  • startTint(tone: Array<number>, duration: number): void

startZoom

  • startZoom(x: number, y: number, scale: number, duration: number): void

tintPicture

  • tintPicture(pictureId: number, tone: Array<number>, duration: number): void

tone

  • tone(): Array<number>

update

  • update(): void

updateFadeIn

  • updateFadeIn(): void

updateFadeOut

  • updateFadeOut(): void

updateFlash

  • updateFlash(): void

updatePictures

  • updatePictures(): void

updateShake

  • updateShake(): void

updateTone

  • updateTone(): void

updateWeather

  • updateWeather(): void

updateZoom

  • updateZoom(): void

weatherPower

  • weatherPower(): number

weatherType

  • weatherType(): string

zoomScale

  • zoomScale(): number

zoomX

  • zoomX(): number

zoomY

  • zoomY(): number

Generated using TypeDoc