Class: Game_Screen

Game_Screen

new Game_Screen()

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

Methods

brightness()number

Get the brightness of the screen
Returns:
TypeDescription
numberThe brightness

changeWeather(type, power, duration)

Changes the weather effect for the given duration
NameTypeDescription
typestringThe weather type
powernumberThe weather power
durationnumberThe duration of the weather change
Clear screen effects
Clear fade effect

clearFlash()

Clear flash effect

clearPictures()

Clear pictures

clearShake()

Clear shake effect
Clear tone effect

clearWeather()

Clear weather effects
Clear zoom effect

eraseBattlePictures()

Erases battle pictures

erasePicture(pictureId)

Erases a picture by id
NameTypeDescription
pictureIdnumberThe picture id

flashColor()Array.<number>

Get the flash color of the screen
Returns:
TypeDescription
Array.<number>The flash color

initialize()

Initialize the screen

maxPictures()number

Get the max allowed amount of pictures
Returns:
TypeDescription
numberThe amount of pictures to allow at maximum

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

Moves the picture with the given id with options
NameTypeDescription
pictureIdnumberThe picture id to show
originnumberThe picture origin
xnumberThe picture x coordinate
ynumberThe picture y coordinate
scaleXnumberThe x (horizontal) scale of the picture
scaleYnumberThe y (vertical) scale of the picture
opacitynumberThe opacity of the picture
blendModenumberThe blend mode of the picture
durationnumberThe duration of the move
easingTypenumberThe easing type of the move

onBattleStart()

Processing when a battle starts
Get a picture by id
NameTypeDescription
pictureIdnumberThe picture id
Returns:
TypeDescription
Game_PictureThe picture object

realPictureId(pictureId)number

Get the real picture id of a picture
NameTypeDescription
pictureIdnumberThe picture id
Returns:
TypeDescription
numberThe real picture id

rotatePicture(pictureId, speed)

Rotates a picture by id at the given speed
NameTypeDescription
pictureIdnumberThe picture id to rotate
speednumberThe speed of the rotation

setZoom(x, y, scale)

Sets the zoom effect
NameTypeDescription
xnumberThe x coordinate of the zoom
ynumberThe y coordinate of the zoom
scalenumberThe scale of the zoom

shake()number

Get the shake effect of the screen
Returns:
TypeDescription
numberThe shake effect

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

Shows the picture with the given id at the given location with options
NameTypeDescription
pictureIdnumberThe picture id to show
namestringThe picture image file name
originnumberThe picture origin
xnumberThe picture x coordinate
ynumberThe picture y coordinate
scaleXnumberThe x (horizontal) scale of the picture
scaleYnumberThe y (vertical) scale of the picture
opacitynumberThe opacity of the picture
blendModenumberThe blend mode of the picture

startFadeIn(duration)

Starts a fade in effect for a given duration
NameTypeDescription
durationnumberThe duration of the fade in

startFadeOut(duration)

Starts a fade out effect for a given duration
NameTypeDescription
durationnumberThe duration of the fade out

startFlash(color, duration)

Starts a flash effect for a given duration
NameTypeDescription
colorArray.<number>The color
durationnumberThe duration of the flash

startFlashForDamage()

Starts a flash effect for damage

startShake(power, speed, duration)

Starts a shake effect for a given duration
NameTypeDescription
powernumberThe power of the shake effect
speednumberThe speed of the shake effect
durationnumberThe duration of the shake

startTint(tone, duration)

Starts a tint effect for a given duration
NameTypeDescription
toneArray.<number>The tone
durationnumberThe duration of the tint

startZoom(x, y, scale, duration)

Starts a zoom effect for a given duration
NameTypeDescription
xnumberThe x coordinate of the zoom
ynumberThe y coordinate of the zoom
scalenumberThe scale of the zoom
durationnumberThe duration of the shake

tintPicture(pictureId, tone, duration)

Tints a picture by id over a duration of time
NameTypeDescription
pictureIdnumberThe picture id to tint
toneArray.<number>The new tone of the picture
durationnumberThe duration of the tint

tone()Array.<number>

Get the tone of the screen
Returns:
TypeDescription
Array.<number>The tone
Update the screen

updateFadeIn()

Update the fade in effect

updateFadeOut()

Update the fade out effect

updateFlash()

Update the flash effect

updatePictures()

Update the pictures

updateShake()

Update the shake effect

updateTone()

Update the tone

updateWeather()

Changes the weather effects

updateZoom()

Update the zoom effect

weatherPower()number

Get the weather power of the screen
Returns:
TypeDescription
numberThe weather power

weatherType()string

Get the weather typeof the screen
Returns:
TypeDescription
stringThe weather type

zoomScale()number

Get the zoom scale of the screen
Returns:
TypeDescription
numberThe zoom scale effect

zoomX()number

Get the zoom x coordinate
Returns:
TypeDescription
numberThe zoom x coordinate

zoomY()number

Get the zoom y coordinate
Returns:
TypeDescription
numberThe zoom y coordinate