Class: Game_Screen

Game_Screen()

new Game_Screen()

The game object class for screen effect data, such as changes in color tone and flashes. Use as global variable $gameScreen
Properties:
Name Type Description
_shake Number
_shakePower Number
_shakeSpeed Number
_shakeDuration Number
_shakeDirection Number
_zoomX Number _zoomX property of the game screen.
_zoomY Number _zoomY property of the game screen.
_zoomScale Number
_zoomScaleTarget Number
_zoomDuration Number
_weatherType String
_weatherPower Number
_weatherPowerTarget Number
_weatherDuration Number
_brightness Number The _brightness property of the game screen; returned when calling the brightness method.
_fadeOutDuration Number
_fadeInDuration Number
_tone Array.<Number>
_toneTarget Array.<Number>
_toneDuration Number
_flashColor Array.<Number>
_flashDuration Number
_pictures Array.<Game_Picture> The array of Game_Pictures that are attached to the game screen.

Methods

brightness() → {Number}

Returns the brightness of the game screen.
Returns:
Type
Number

changeWeather(type, power, duration)

Parameters:
Name Type Description
type String
power Number
duration Number

clear()

clearFade()

Clears the screen fade.

clearFlash()

Clears the screen flash.

clearPictures()

Clears the pictures set on the game screen.

clearShake()

Clears the screen shake.

clearTone()

Clears the screen tone.

clearWeather()

Clears the screen weather.

clearZoom()

Clears the screen zoom.

eraseBattlePictures()

Erases the battle pictures.

erasePicture(pictureId)

Erases a picture from the screen given the respected picture id.
Parameters:
Name Type Description
pictureId Number

flashColor() → {Array.<number>}

Returns:
Type
Array.<number>

initialize()

maxPictures() → {Number}

Returns the maximum number of pictures set on the game screen.
Returns:
Type
Number

movePicture(pictureId, origin, x, y, scaleX, scaleY, opacity, blendMode, duration)

Parameters:
Name Type Description
pictureId Number
origin Number
x Number
y Number
scaleX Number
scaleY Number
opacity Number
blendMode Number
duration Number

onBattleStart()

Handler for when the battle starts in game; prepares the screen for the battle scene.

picture(pictureId) → {Game_Picture}

Returns the specified picture given the picture id.
Parameters:
Name Type Description
pictureId Number
Returns:
Type
Game_Picture

realPictureId(pictureId) → {Number}

Returns the real picture id, given the picture id.
Parameters:
Name Type Description
pictureId Number
Returns:
Type
Number

rotatePicture(pictureId, speed)

Parameters:
Name Type Description
pictureId Number
speed Number

setZoom(x, y, scale)

Parameters:
Name Type Description
x Number
y Number
scale Number

shake() → {Number}

Returns:
Type
Number

showPicture(pictureId, name, origin, x, y, scaleX, scaleY, opacity, blendMode)

Parameters:
Name Type Description
pictureId Number
name String
origin Number
x Number
y Number
scaleX Number
scaleY Number
opacity Number
blendMode Number

startFadeIn(duration)

Parameters:
Name Type Description
duration Number

startFadeOut(duration)

Parameters:
Name Type Description
duration Number

startFlash(color, duration)

Parameters:
Name Type Description
color Array.<number>
duration Number

startFlashForDamage()

startShake(power, speed, duration)

Parameters:
Name Type Description
power Number
speed Number
duration Number

startTint(tone, duration)

Parameters:
Name Type Description
tone Array.<number>
duration Number

startZoom(x, y, scale, duration)

Parameters:
Name Type Description
x Number
y Number
scale Number
duration Number

tintPicture(pictureId, tone, duration)

Parameters:
Name Type Description
pictureId Number
tone Array.<number>
duration Number

tone() → {Array.<number>}

Returns:
Type
Array.<number>

update()

Updates the game screen.

updateFadeIn()

Updates the screen fade in.

updateFadeOut()

Updates the screen fade out.

updateFlash()

Update the screen flash.

updatePictures()

Update the screen pictures.

updateShake()

Update the screen shake.

updateTone()

Updates the screen tone.

updateWeather()

Update the screen weather.

updateZoom()

Update the screen zoom.

weatherPower() → {Number}

Returns the weather power.
Returns:
Type
Number

weatherType() → {String}

Returns the current weather type.
Returns:
Type
String

zoomScale() → {Number}

Returns the zoom scale of the screen.
Returns:
Type
Number

zoomX() → {Number}

Returns the zoom x coordinate of the screen.
Returns:
Type
Number

zoomY() → {Number}

Returns the zoom y coordiante of the screen.
Returns:
Type
Number