The game object class for an event. It contains functionality for event page switching and running parallel process events.
Extends
Methods
advanceMoveRouteIndex()inherited
- Advances the move route index
animationWait()numberinherited
- Get the wait between animation frames
Returns:
Type Description number Amount to wait between animation frames blendMode()numberinherited
- Get the blend mode of the character
Returns:
Type Description number The character's blend mode bushDepth()numberinherited
- Get the character's bush depth
Returns:
Type Description number The character's bush depth canPass(x, y, d)booleaninherited
- Check if the character can pass a tile in front of them given x/y coordinates and direction
Name Type Description xnumber The x coordinate at the start of the move ynumber The y coordinate at the start of the move dnumber The direction of the move Returns:
Type Description boolean True if can pass canPassDiagonally(x, y, horz, vert)booleaninherited
- Check if the character can diagonally pass a tile in front of them given x/y coordinates and horizontal/vertical direction
Name Type Description xnumber The x coordinate at the start of the move ynumber The y coordinate at the start of the move horznumber The horizontal direction of the move vertnumber The vertical direction of the move Returns:
Type Description boolean True if can pass characterIndex()numberinherited
- Get the character's index (for character sheet image)
Returns:
Type Description number The character index characterName()stringinherited
- Get the character's name (for character sheet image)
Returns:
Type Description string The character name - Check if the event is triggered automatically, start the event if so
checkEventTriggerTouch(x, y)overrides
- Check if the event is triggered by touch, start the event if so
Name Type Description xnumber The x coordinate to check for trigger ynumber The y coordinate to check for trigger checkEventTriggerTouchFront(d)inherited
- Check for event trigger touch (in front of character)
Name Type Description dnumber The character's direction checkStop(threshold)booleaninherited
- Check if the character should stop
Name Type Description thresholdnumber The threshold after which the character should stop Returns:
Type Description boolean True if should stop - Clear event page settings
- Clear the event's starting flag
copyPosition(character)inherited
- Copies the position of another character
Name Type Description characterGame_Character The character to copy position from deltaXFrom(x)numberinherited
- Get the delta x from the given x and the character x
Name Type Description xnumber The given x Returns:
Type Description number The delta x deltaYFrom(y)numberinherited
- Get the delta y from the given y and the character y
Name Type Description ynumber The given y Returns:
Type Description number The delta y direction()numberinherited
- Get the direction of the character
Returns:
Type Description number The character direction distancePerFrame()numberinherited
- Get the distance moved per frame
Returns:
Type Description number The distance moved per frame endAnimation()inherited
- End the animation
endBalloon()inherited
- End the balloon animation
- Erase the event
- Get the event data object
Returns:
Type Description Object The event data object - Get the event id
Returns:
Type Description number The event's id findDirectionTo(goalX, goalY)numberinherited
- Find the direction to a given x/y coordinate
Name Type Description goalXnumber The goal x coordinate goalYnumber The goal y coordinate Returns:
Type Description number The direction to the goal coordinates - Get the event's page index
Returns:
Type Description number The index of the event's page - Forces a move route
Name Type Description moveRouteObject The move route to force hasStepAnime()booleaninherited
- Check if the character has a step animation
Returns:
Type Description boolean True if has step animation hasWalkAnime()booleaninherited
- Check if the character has a walk animation
Returns:
Type Description boolean True if has walk animation increaseSteps()inherited
- Increase the character's steps
- Initialize character variables
initialize(mapId, eventId)overrides
- Initialize the event
Name Type Description mapIdnumber The map id of the event eventIdnumber The event's id isAnimationPlaying()booleaninherited
- Check if the animation is playing
Returns:
Type Description boolean True if animation playing isBalloonPlaying()booleaninherited
- Check if the character balloon animation is playing
Returns:
Type Description boolean True if balloon animation playing - Check if the character collided with other characters
Name Type Description xnumber The x coordinate to check ynumber The y coordinate to check Returns:
Type Description boolean True if collided isCollidedWithEvents(x, y)booleanoverrides
- Check if collided with events
Name Type Description xnumber The x coordinate to check for collision ynumber The y coordinate to check for collision Returns:
Type Description boolean True if collided - Check if collided with the player
Name Type Description xnumber The x coordinate to check for collision ynumber The y coordinate to check for collision Returns:
Type Description boolean True if collided isCollidedWithVehicles(x, y)booleaninherited
- Check if the character collided with vehicle characters
Name Type Description xnumber The x coordinate to check ynumber The y coordinate to check Returns:
Type Description boolean True if collided isDashing()booleaninherited
- Check if the character is dashing
Returns:
Type Description boolean True if dashing isDebugThrough()booleaninherited
- Check if the character is in the debug through state
Returns:
Type Description boolean True if debug through isDirectionFixed()booleaninherited
- Check if the character has a fixed direction
Returns:
Type Description boolean True if has fixed direction isJumping()booleaninherited
- Check if the character is jumping
Returns:
Type Description boolean True if jumping isMapPassable(x, y, d)booleaninherited
- Check if the map is passable between two tiles
Name Type Description xnumber The x coordinate at the start of the move ynumber The y coordinate at the start of the move dnumber The direction of the move Returns:
Type Description boolean True if map is passable isMoveRouteForcing()booleaninherited
- Check if move route is forcing
Returns:
Type Description boolean True if forcing isMovementSucceeded()booleaninherited
- Check for movement success
Returns:
Type Description boolean True if movement succeeded isMoving()booleaninherited
- Check if the character is moving
Returns:
Type Description boolean True if moving - Check if the event is near the player
Returns:
Type Description boolean True if near the player isNearTheScreen()booleaninherited
- Check if the character is near the screen
Returns:
Type Description boolean True if near the screen isNormalPriority()booleaninherited
- Check if the character is normal priority
Returns:
Type Description boolean True if normal priority isObjectCharacter()booleaninherited
- Check if the character is an object character
Returns:
Type Description boolean True if object character isOnBush()booleaninherited
- Check if the character is on a bush
Returns:
Type Description boolean True if on bush tile isOnLadder()booleaninherited
- Check if the character is on a ladder
Returns:
Type Description boolean True if on ladder isOriginalPattern()booleanoverrides
- Check if the event's pattern is the original pattern
Returns:
Type Description boolean True if original pattern - Check if the event is starting
Returns:
Type Description boolean True if starting isStopping()booleaninherited
- Check if the character is stopping
Returns:
Type Description boolean True if stopping isThrough()booleaninherited
- Check if the character is through
Returns:
Type Description boolean True if through isTile()booleaninherited
- Check if the character is a tile
Returns:
Type Description boolean True if tile isTransparent()booleaninherited
- Check if the character is transparent
Returns:
Type Description boolean True if transparent - Check if the event's trigger is included in the given triggers
Name Type Description triggersArray.<number> The triggers to check Returns:
Type Description boolean True if trigger included jump(xPlus, yPlus)inherited
- Jumps the character
Name Type Description xPlusnumber Amount to jump in the x direction yPlusnumber Amount to jump in the y direction jumpHeight()numberinherited
- Get the character's jump height
Returns:
Type Description number The character's jump height - Get the event command list
Returns:
Type Description Array The event's command list - Locates the character to the given coordinates
Name Type Description xnumber The new x coordinate ynumber The new y coordinate - Locks the event
maxPattern()numberinherited
- Get the maximum pattern for animation
Returns:
Type Description number The maximum pattern for animation - Check if the given page has its conditions met
Name Type Description pageObject The event page to check Returns:
Type Description boolean True if conditions are met memorizeMoveRoute()inherited
- Memorizes the character move route
moveAwayFromCharacter(character)inherited
- Moves away from the given character
Name Type Description characterGame_Character The character to move away from moveAwayFromPlayer()inherited
- Moves away from the player
moveBackward()inherited
- Moves backward
moveDiagonally(horz, vert)inherited
- Moves diagonally in the given directions
Name Type Description horznumber The horizontal direction to move in vertnumber The vertical direction to move in moveForward()inherited
- Moves forward
moveFrequency()numberinherited
- Get the move frequency of the character
Returns:
Type Description number The character's movement frequency moveRandom()inherited
- Random move handling
moveSpeed()numberinherited
- Get the move speed of the character
Returns:
Type Description number The character's movement speed moveStraight(d)inherited
- Moves straight in the given direction
Name Type Description dnumber The direction to move in moveTowardCharacter(character)inherited
- Moves toward the given character
Name Type Description characterGame_Character The character to move toward moveTowardPlayer()inherited
- Moves toward the player
- Update custom move type
- Handling for random movement move type
- Handling for movement toward the player move type
opacity()numberinherited
- Get the opacity of the character
Returns:
Type Description number The character's opacity - Get the event's page
Returns:
Type Description Object The event's page pattern()numberinherited
- Get the current animation pattern
Returns:
Type Description number The current animation pattern pos(x, y)booleaninherited
- Check if the character's position is equal to the passed coordinates
Name Type Description xnumber The x coordinate to check ynumber The y coordinate to check Returns:
Type Description boolean True if coordinates match posNt(x, y)booleaninherited
- Check if the character's position is equal to the passed coordinates, and it's (n)ot (t)hrough
Name Type Description xnumber The x coordinate to check ynumber The y coordinate to check Returns:
Type Description boolean True if coordinates match and the character is not through processMoveCommand(command)inherited
- Processes a given move command
Name Type Description commandObject The move command processRouteEnd()inherited
- Processing when move route ends
realMoveSpeed()numberinherited
- Get the real movement speed for the character (factor in dashing or other effects)
Returns:
Type Description number The actual move speed of the character - Refresh the event
refreshBushDepth()inherited
- Refresh the character for bush depth change
regionId()numberinherited
- Get the region id the character is on
Returns:
Type Description number The region id resetPattern()overrides
- Reset event pattern
resetStopCount()inherited
- Resets the stop count
restoreMoveRoute()inherited
- Restores a memorized move route
reverseDir(d)inherited
- Reverse the character's direction
Name Type Description dnumber The direction to reverse from screenX()numberinherited
- Get the character screen x value
Returns:
Type Description number The screen x value screenY()numberinherited
- Get the character screen y value
Returns:
Type Description number The screen y value screenZ()numberinherited
- Get the character screen z value
Returns:
Type Description number The screen z value scrolledX()numberinherited
- Get the character scrolled x value
Returns:
Type Description number The scrolled x value scrolledY()numberinherited
- Get the character scrolled y value
Returns:
Type Description number The scrolled y value searchLimit()numberinherited
- The maximum amount of tiles to search for finding direction
Returns:
Type Description number The search limit setBlendMode(blendMode)inherited
- Set the blend mode of the character
Name Type Description blendModenumber The character's new blend mode setDirection(d)inherited
- Set the direction of the character
Name Type Description dnumber The character's new direction setDirectionFix(directionFix)inherited
- Set the character direction fix flag
Name Type Description directionFixboolean New direction fix flag setImage(characterName, characterIndex)inherited
- Set the character's image properties (character name and index)
Name Type Description characterNamestring The new character name characterIndexnumber The new character index setMoveFrequency(moveFrequency)inherited
- Set the move frequency of the character
Name Type Description moveFrequencynumber The character's new movement frequency setMoveRoute(moveRoute)inherited
- Sets a move route
Name Type Description moveRouteObject The move route to set setMoveSpeed(moveSpeed)inherited
- Set the move speed of the character
Name Type Description moveSpeednumber The character's new movement speed setMovementSuccess(success)inherited
- Set movement success
Name Type Description successboolean Whether movement succeeded setOpacity(opacity)inherited
- Set the opacity of the character
Name Type Description opacitynumber The character's new opacity setPattern(pattern)inherited
- Set the current animation pattern
Name Type Description patternnumber The new current animation pattern setPosition(x, y)inherited
- Sets the position of the character
Name Type Description xnumber The new x coordinate ynumber The new y coordinate setPriorityType(priorityType)inherited
- Set the priority type of the character
Name Type Description priorityTypenumber The character's new priority type setStepAnime(stepAnime)inherited
- Set the character step animation flag
Name Type Description stepAnimeboolean New step animation flag setThrough(through)inherited
- Set the character through flag
Name Type Description throughboolean New through flag setTileImage(tileId)inherited
- Set the character's image properties when it's a tile character
Name Type Description tileIdnumber The tile id to use for the image setTransparent(transparent)inherited
- Set the transparent flag
Name Type Description transparentboolean New transparent flag setWalkAnime(walkAnime)inherited
- Set the character walk animation flag
Name Type Description walkAnimeboolean New walk animation flag - Set up the event's page
- Set up the event's page settings
shiftY()numberinherited
- Get the amount to shift the character's y value
Returns:
Type Description number Amount to shift the y value by - Start the event
startAnimation()inherited
- Start the animation
startBalloon()inherited
- Start the character balloon animation
- Get the stop count threshold
Returns:
Type Description number Threshold to be stopped straighten()inherited
- Straighten the character
swap(character)inherited
- Swap location with the given character
Name Type Description characterGame_Character The character to swap with terrainTag()numberinherited
- Get the terrain tag the character is on
Returns:
Type Description number The terrain tag tileId()numberinherited
- Get the character's tile id
Returns:
Type Description number The character's tile id turn180()inherited
- Turn 180 degrees (turn around)
turnAwayFromCharacter(character)inherited
- Turns away from the given character
Name Type Description characterGame_Character The character to turn away from turnAwayFromPlayer()inherited
- Turns away from the player
turnLeft90()inherited
- Turn left 90 degrees
turnRandom()inherited
- Turn in a random direction
turnRight90()inherited
- Turn right 90 degrees
turnRightOrLeft90()inherited
- Randomly turn right or left 90 degrees
turnTowardCharacter(character)inherited
- Turns toward the given character
Name Type Description characterGame_Character The character to turn toward turnTowardPlayer()inherited
- Turns toward the player
- Unlocks the event
- Update the character
updateAnimation()inherited
- Update the character's animation
updateAnimationCount()inherited
- Update the animation count
updateJump()inherited
- Update the character's jump
updateMove()inherited
- Update the character's move
- Update for parallel process events
updatePattern()inherited
- Updates the animation pattern
updateRoutineMove()inherited
- Updates move route
- Update autonomous movement
- Update the character's stop