Class: Game_Vehicle

Game_Vehicle()

new Game_Vehicle()

The game object declare class for a vehicle.

Extends

Methods

advanceMoveRouteIndex()

Inherited From:

animationId() → {Number}

Returns the animation id.
Inherited From:
Returns:
Type
Number

animationWait() → {Number}

Inherited From:
Returns:
Type
Number

balloonId() → {Number}

Returns the id of the balloon animation.
Inherited From:
Returns:
Type
Number

blendMode() → {Number}

Returns the blend mode of the character; these are represented by numbers.
Inherited From:
Returns:
Type
Number

bushDepth() → {Number}

Returns the bush depth around the character.
Inherited From:
Returns:
Type
Number

canMove() → {Boolean}

Returns true if the vehicle can move.
Returns:
Type
Boolean

canPass(x, y, d) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
d Number
Inherited From:
Returns:
Type
Boolean

canPassDiagonally(x, y, horz, vert) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
horz Number
vert Number
Inherited From:
Returns:
Type
Boolean

characterIndex() → {Number}

Inherited From:
Returns:
Type
Number

characterName() → {String}

Inherited From:
Returns:
Type
String

checkEventTriggerTouch(x, y) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
Inherited From:
Returns:
Type
Boolean

checkEventTriggerTouchFront(d)

Parameters:
Name Type Description
d Number
Inherited From:

checkStop(threshold) → {Boolean}

Parameters:
Name Type Description
threshold Number
Inherited From:
Returns:
Type
Boolean

copyPosition(character)

Parameters:
Name Type Description
character Game_Player
Inherited From:

deltaXFrom(x) → {Number}

Parameters:
Name Type Description
x Number
Inherited From:
Returns:
Type
Number

deltaYFrom(x) → {Number}

Parameters:
Name Type Description
x Number
Inherited From:
Returns:
Type
Number

direction() → {Number}

Inherited From:
Returns:
Type
Number

distancePerFrame() → {Number}

Inherited From:
Returns:
Type
Number

endAnimation()

Inherited From:

endBalloon()

Ends the balloon animation on the character.
Inherited From:

findDirectionTo(goalX, goalY) → {Number}

Parameters:
Name Type Description
goalX Number
goalY Number
Inherited From:
Returns:
Type
Number

forceMoveRoute(moveRoute)

Forces the move route of the game character.
Parameters:
Name Type Description
moveRoute RPG.MoveRoute
Inherited From:

getOff()

Gets off the vehicle.

getOn()

Gets on the vehicle.

hasStepAnime() → {Boolean}

Returns true if the character has step animation.
Inherited From:
Returns:
Type
Boolean

hasWalkAnime() → {Boolean}

Inherited From:
Returns:
Type
Boolean

increaseSteps()

Increases the character steps.
Inherited From:

initialize(type)

Parameters:
Name Type Description
type String
Overrides:

initMembers()

Overrides:

initMoveSpeed()

isAirship() → {Boolean}

Returns true if the vehicle is an airship.
Returns:
Type
Boolean

isAnimationPlaying() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isBalloonPlaying() → {Boolean}

Returns true if a balloon animation is playing.
Inherited From:
Returns:
Type
Boolean

isBoat() → {Boolean}

Returns true if the vehicle is a boat.
Returns:
Type
Boolean

isCollidedWithCharacters(x, y) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
Inherited From:
Returns:
Type
Boolean

isCollidedWithEvents(x, y) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
Inherited From:
Returns:
Type
Boolean

isCollidedWithVehicles(x, y) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
Inherited From:
Returns:
Type
Boolean

isDashing() → {Boolean}

Returns true if the character is dashing.
Inherited From:
Returns:
Type
Boolean

isDebugThrough() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isDirectionFixed() → {Boolean}

Returns true if the character is set to a fixed direction.
Inherited From:
Returns:
Type
Boolean

isHighest() → {Boolean}

Returns true if the vehicle is at it's highest altitude.
Returns:
Type
Boolean

isJumping() → {Boolean}

Returns true if the character is jumping.
Inherited From:
Returns:
Type
Boolean

isLandOk(x, y, d) → {Boolean}

Returns true if the vehicle is capable of landing at the specified x, y coordinate, with the specified direction (d).
Parameters:
Name Type Description
x Number
y Number
d Number
Returns:
Type
Boolean

isLowest() → {Boolean}

Returns true if the vehicle is at it's lowest altitude.
Returns:
Type
Boolean

isMapPassable(x, y, d) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
d Number
Overrides:
Returns:
Type
Boolean

isMovementSucceeded(x, y) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
Inherited From:
Returns:
Type
Boolean

isMoveRouteForcing() → {Boolean}

Returns true if the move route is being forced.
Inherited From:
Returns:
Type
Boolean

isMoving() → {Boolean}

Returns true if the character is moving.
Inherited From:
Returns:
Type
Boolean

isNearTheScreen()

Inherited From:

isNormalPriority() → {Boolean}

Returns true if the character is normal priority; this means you can collide with them.
Inherited From:
Returns:
Type
Boolean

isObjectCharacter() → {Boolean}

Returns true if the character is an object character; these are events with character sprites.
Inherited From:
Returns:
Type
Boolean

isOnBush() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isOnLadder() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isOriginalPattern() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isShip() → {Boolean}

Returns true if the vehicle is a ship.
Returns:
Type
Boolean

isStopping() → {Boolean}

Returns true if the character is stopping.
Inherited From:
Returns:
Type
Boolean

isTakeoffOk() → {Boolean}

Returns true if take off is ok.
Returns:
Type
Boolean

isThrough() → {Boolean}

Returns true if the character is set to pass through.
Inherited From:
Returns:
Type
Boolean

isTile() → {Boolean}

Returns true if the character is a tile; these are events without character sprites.
Inherited From:
Returns:
Type
Boolean

isTransparent() → {Boolean}

Inherited From:
Returns:
Type
Boolean

jump(xPlus, yPlus)

Parameters:
Name Type Description
xPlus Number
yPlus Number
Inherited From:

jumpHeight() → {Number}

Returns the jump height of base character.
Inherited From:
Returns:
Type
Number

loadSystemSettings()

locate(x, y) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
Inherited From:
Returns:
Type
Boolean

maxAltitude() → {Number}

Returns the max altitude of the vehicle.
Returns:
Type
Number

maxPattern() → {Number}

Inherited From:
Returns:
Type
Number

memorizeMoveRoute()

Memorizes the movement route.
Inherited From:

moveAwayFromCharacter(character)

Moves the game character away from the other game character.
Parameters:
Name Type Description
character Game_Character
Inherited From:

moveAwayFromPlayer()

Moves the game character away from the player.
Inherited From:

moveBackward()

Moves the game character backward.
Inherited From:

moveDiagonally(horz, vert)

Parameters:
Name Type Description
horz Number
vert Number
Inherited From:

moveForward()

Moves the game character forward.
Inherited From:

moveFrequency() → {Number}

Returns the move frequency of the character.
Inherited From:
Returns:
Type
Number

moveRandom()

Move's the game character at random.
Inherited From:

moveSpeed() → {Number}

Returns the move speed of the game character.
Inherited From:
Returns:
Type
Number

moveStraight(d)

Parameters:
Name Type Description
d Number
Inherited From:

moveTowardCharacter(character)

Moves the game character toward the other game character.
Parameters:
Name Type Description
character Game_Character
Inherited From:

moveTowardPlayer()

Moves the game character toward the player.
Inherited From:

opacity() → {Number}

Inherited From:
Returns:
Type
Number

pattern() → {Number}

Returns the pattern of the character; these are the walking
Inherited From:
Returns:
Type
Number

playBgm()

Plays the bgm associated with the vehicle.

pos(x, y) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
Overrides:
Returns:
Type
Boolean

posNt(x, y) → {Boolean}

Parameters:
Name Type Description
x Number
y Number
Inherited From:
Returns:
Type
Boolean

processMoveCommand(command)

Processes the given move commands.
Parameters:
Name Type Description
command RPG.MoveCommand
Inherited From:

processRouteEnd()

Handles the end of the move route.
Inherited From:

realMoveSpeed() → {Number}

Inherited From:
Returns:
Type
Number

refresh()

Refreshes the game vehicle.

refreshBushDepth()

Inherited From:

regionId() → {Number}

Returns the region id of the character.
Inherited From:
Returns:
Type
Number

requestAnimation(animationId)

Requests an animation given the animation id.
Parameters:
Name Type Description
animationId Number
Inherited From:

requestBalloon(balloonId)

Requests the balloon animation given the balloon id.
Parameters:
Name Type Description
balloonId Number
Inherited From:

resetDirection()

Resets the direction of the vehicle.

resetPattern()

Resets the pattern of the character.
Inherited From:

resetStopCount()

Resets the step count of the character.
Inherited From:

restoreMoveRoute()

Restores the original movement route.
Inherited From:

reverseDir(d) → {Number}

Parameters:
Name Type Description
d Number
Inherited From:
Returns:
Type
Number

screenX() → {Number}

Returns the character's scrreen x position.
Inherited From:
Returns:
Type
Number

screenY() → {Number}

Returns the screen y position of the vehicle.
Overrides:
Returns:
Type
Number

screenZ() → {Number}

Returns the character's screen z position.
Inherited From:
Returns:
Type
Number

scrolledX() → {Number}

Inherited From:
Returns:
Type
Number

scrolledY() → {Number}

Inherited From:
Returns:
Type
Number

searchLimit() → {Number}

Returns the search limit for path finding.
Inherited From:
Returns:
Type
Number

setBgm(bgm)

Sets the bgm associated with the vehicle.
Parameters:
Name Type Description
bgm RPG.AudioFile

setBlendMode(blendMode)

Sets the blend mode of the character; these are represented by numbers.
Parameters:
Name Type Description
blendMode Number
Inherited From:

setDirection(d)

Sets the direction of the character based on numpad directions.
Parameters:
Name Type Description
d Number
Inherited From:

setDirectionFix(directionFix)

Sets the character to be fixed in a specified direction given a boolean value.
Parameters:
Name Type Description
directionFix Boolean
Inherited From:

setImage(characterName, characterIndex)

Parameters:
Name Type Description
characterName String
characterIndex Number
Inherited From:

setLocation(mapId, x, y)

Parameters:
Name Type Description
mapId Number
x Number
y Number

setMoveFrequency(moveFrequency)

Parameters:
Name Type Description
moveFrequency Number
Inherited From:

setMovementSuccess(success)

Parameters:
Name Type Description
success Boolean
Inherited From:

setMoveRoute(moveRoute)

Sets the move route of the game character.
Parameters:
Name Type Description
moveRoute RPG.MoveRoute
Inherited From:

setMoveSpeed(moveSpeed)

Parameters:
Name Type Description
moveSpeed Number
Inherited From:

setOpacity(opacity)

Parameters:
Name Type Description
opacity Number
Inherited From:

setPattern(pattern)

Sets the pattern of the character, given a pattern number.
Parameters:
Name Type Description
pattern Number
Inherited From:

setPosition(x, y)

Parameters:
Name Type Description
x Number
y Number
Inherited From:

setPriorityType(priorityType)

Parameters:
Name Type Description
priorityType Number
Inherited From:

setStepAnime(stepAnime)

Parameters:
Name Type Description
stepAnime Boolean
Inherited From:

setThrough(through)

Parameters:
Name Type Description
through Boolean
Inherited From:

setTileImage(tileId)

Parameters:
Name Type Description
tileId Number
Inherited From:

setTransparent(transparent)

Parameters:
Name Type Description
transparent Boolean
Inherited From:

setWalkAnime(walkAnime)

Parameters:
Name Type Description
walkAnime Boolean
Inherited From:

shadowOpacity() → {Number}

Returns the shadow opacity of the vehicle's shadow.
Returns:
Type
Number

shadowX() → {Number}

Returns the shadow x position of the vehicle's shadow.
Returns:
Type
Number

shadowY() → {Number}

Returns the shadow y position of the vehicle's shadow.
Returns:
Type
Number

shiftY() → {Number}

Inherited From:
Returns:
Type
Number

startAnimation()

Starts the requested animation.
Inherited From:

startBalloon()

Stars a balloon animation.
Inherited From:

straighten()

Straightens the character.
Inherited From:

swap(character)

Parameters:
Name Type Description
character Game_Character
Inherited From:

syncWithPlayer()

Syncs the vehicle with the player.

terrainTag() → {Number}

Returns the terrain tag of the character.
Inherited From:
Returns:
Type
Number

tileId() → {Number}

Returns the tile id of character.
Inherited From:
Returns:
Type
Number

turn180()

Turns the game character by 180 degrees.
Inherited From:

turnAwayFromCharacter(character)

Turns the game character away from the other game character.
Parameters:
Name Type Description
character Game_Character
Inherited From:

turnAwayFromPlayer()

Turns the game character away from the player.
Inherited From:

turnLeft90()

Turns the game character left by 90 degrees.
Inherited From:

turnRandom()

Turns the game character at random.
Inherited From:

turnRight90()

Turns the game character right by 90 degrees.
Inherited From:

turnRightOrLeft90()

Turns the game character or left by 90 degrees.
Inherited From:

turnTowardCharacter(character)

Turns the game character toward the other game character.
Parameters:
Name Type Description
character Game_Character
Inherited From:

turnTowardPlayer()

Turns the game character toward the player.
Inherited From:

update()

Updates the vehicle.
Overrides:

updateAirship()

Updates the airship.

updateAirshipAltitude()

Updates airship altitude.

updateAnimation()

Inherited From:

updateAnimationCount()

Updates the character's animation count.
Inherited From:

updateJump()

Inherited From:

updateMove()

Inherited From:

updatePattern()

Inherited From:

updateRoutineMove()

Updates the game character's move routine.
Inherited From:

updateStop()

Inherited From:

vehicle() → {RPG.System.Vehicle}

Returns the current vehicle.
Returns:
Type
RPG.System.Vehicle