Advances the move route index
Get the wait between animation frames
Returns:
| Type | Description |
|---|
| number | Amount to wait between animation frames |
Get the blend mode of the character
Returns:
| Type | Description |
|---|
| number | The character's blend mode |
Get the character's bush depth
Returns:
| Type | Description |
|---|
| number | The character's bush depth |
Check if the vehicle can move
Returns:
| Type | Description |
|---|
| boolean | True if can move |
Check if the character can pass a tile in front of them given x/y coordinates and direction
| Name | Type | Description |
|---|
x | number | The x coordinate at the start of the move |
y | number | The y coordinate at the start of the move |
d | number | 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 |
|---|
x | number | The x coordinate at the start of the move |
y | number | The y coordinate at the start of the move |
horz | number | The horizontal direction of the move |
vert | number | The vertical direction of the move |
Returns:
| Type | Description |
|---|
| boolean | True if can pass |
Get the character's index (for character sheet image)
Returns:
| Type | Description |
|---|
| number | The character index |
Get the character's name (for character sheet image)
Returns:
| Type | Description |
|---|
| string | The character name |
Check for event trigger touch. Implemented by child classes
Returns:
| Type | Description |
|---|
| boolean | When called from Game_CharacterBase, this always returns false |
Check for event trigger touch (in front of character)
| Name | Type | Description |
|---|
d | number | The character's direction |
Check if the character should stop
| Name | Type | Description |
|---|
threshold | number | The threshold after which the character should stop |
Returns:
| Type | Description |
|---|
| boolean | True if should stop |
Copies the position of another character
| Name | Type | Description |
|---|
character | Game_Character | The character to copy position from |
Get the delta x from the given x and the character x
| Name | Type | Description |
|---|
x | number | The given x |
Returns:
| Type | Description |
|---|
| number | The delta x |
Get the delta y from the given y and the character y
| Name | Type | Description |
|---|
y | number | The given y |
Returns:
| Type | Description |
|---|
| number | The delta y |
Get the direction of the character
Returns:
| Type | Description |
|---|
| number | The character direction |
Get the distance moved per frame
Returns:
| Type | Description |
|---|
| number | The distance moved per frame |
End the animation
End the balloon animation
Find the direction to a given x/y coordinate
| Name | Type | Description |
|---|
goalX | number | The goal x coordinate |
goalY | number | The goal y coordinate |
Returns:
| Type | Description |
|---|
| number | The direction to the goal coordinates |
Forces a move route
| Name | Type | Description |
|---|
moveRoute | Object | The move route to force |
Get off the vehicle
Get on the vehicle
Check if the character has a step animation
Returns:
| Type | Description |
|---|
| boolean | True if has step animation |
Check if the character has a walk animation
Returns:
| Type | Description |
|---|
| boolean | True if has walk animation |
Increase the character's steps
Initialize character variables
Initialize the vehicle move speed
Initialize the character
Check if the vehicle is an airship
Returns:
| Type | Description |
|---|
| boolean | True if the vehicle is an airship |
Check if the animation is playing
Returns:
| Type | Description |
|---|
| boolean | True if animation playing |
Check if the character balloon animation is playing
Returns:
| Type | Description |
|---|
| boolean | True if balloon animation playing |
Check if the vehicle is a boat
Returns:
| Type | Description |
|---|
| boolean | True if the vehicle is a boat |
isCollidedWithCharacters(x, y)booleaninherited
Check if the character collided with other characters
| Name | Type | Description |
|---|
x | number | The x coordinate to check |
y | number | The y coordinate to check |
Returns:
| Type | Description |
|---|
| boolean | True if collided |
Check if the character collided with event characters
| Name | Type | Description |
|---|
x | number | The x coordinate to check |
y | number | The y coordinate to check |
Returns:
| Type | Description |
|---|
| boolean | True if collided |
Check if the character collided with vehicle characters
| Name | Type | Description |
|---|
x | number | The x coordinate to check |
y | number | The y coordinate to check |
Returns:
| Type | Description |
|---|
| boolean | True if collided |
Check if the character is dashing
Returns:
| Type | Description |
|---|
| boolean | True if dashing |
Check if the character is in the debug through state
Returns:
| Type | Description |
|---|
| boolean | True if debug through |
Check if the character has a fixed direction
Returns:
| Type | Description |
|---|
| boolean | True if has fixed direction |
Check if the vehicle is at the max altitude
Returns:
| Type | Description |
|---|
| boolean | True if at max altitude |
Check if the character is jumping
Returns:
| Type | Description |
|---|
| boolean | True if jumping |
Check if the vehicle can land
| Name | Type | Description |
|---|
x | number | The x coordinate on the map |
y | number | The y coordinate on the map |
d | number | The direction of the vehicle |
Returns:
| Type | Description |
|---|
| boolean | True if landing is allowed |
Check if the vehicle is on the ground
Returns:
| Type | Description |
|---|
| boolean | True if grounded |
Check if the map is passable for the vehicle
| Name | Type | Description |
|---|
x | number | The x coordinate on the map |
y | number | The y coordinate on the map |
d | number | The direction of the vehicle |
Returns:
| Type | Description |
|---|
| boolean | True if passable |
Check if move route is forcing
Returns:
| Type | Description |
|---|
| boolean | True if forcing |
Check for movement success
Returns:
| Type | Description |
|---|
| boolean | True if movement succeeded |
Check if the character is moving
Returns:
| Type | Description |
|---|
| boolean | True if moving |
Check if the character is near the screen
Returns:
| Type | Description |
|---|
| boolean | True if near the screen |
Check if the character is normal priority
Returns:
| Type | Description |
|---|
| boolean | True if normal priority |
Check if the character is an object character
Returns:
| Type | Description |
|---|
| boolean | True if object character |
Check if the character is on a bush
Returns:
| Type | Description |
|---|
| boolean | True if on bush tile |
Check if the character is on a ladder
Returns:
| Type | Description |
|---|
| boolean | True if on ladder |
Check if the pattern is in the original state
Returns:
| Type | Description |
|---|
| boolean | True if in original state |
Check if the vehicle is a ship
Returns:
| Type | Description |
|---|
| boolean | True if the vehicle is a ship |
Check if the character is stopping
Returns:
| Type | Description |
|---|
| boolean | True if stopping |
Check if the vehicle can take off
Returns:
| Type | Description |
|---|
| boolean | True if can take off |
Check if the character is through
Returns:
| Type | Description |
|---|
| boolean | True if through |
Check if the character is a tile
Returns:
| Type | Description |
|---|
| boolean | True if tile |
Check if the character is transparent
Returns:
| Type | Description |
|---|
| boolean | True if transparent |
Jumps the character
| Name | Type | Description |
|---|
xPlus | number | Amount to jump in the x direction |
yPlus | number | Amount to jump in the y direction |
Get the character's jump height
Returns:
| Type | Description |
|---|
| number | The character's jump height |
Load system settings for the vehicle
Locates the character to the given coordinates
| Name | Type | Description |
|---|
x | number | The new x coordinate |
y | number | The new y coordinate |
Get the max altitude
Returns:
| Type | Description |
|---|
| number | Max altitude |
Get the maximum pattern for animation
Returns:
| Type | Description |
|---|
| number | The maximum pattern for animation |
Memorizes the character move route
Moves away from the given character
| Name | Type | Description |
|---|
character | Game_Character | The character to move away from |
Moves away from the player
Moves backward
Moves diagonally in the given directions
| Name | Type | Description |
|---|
horz | number | The horizontal direction to move in |
vert | number | The vertical direction to move in |
Moves forward
Get the move frequency of the character
Returns:
| Type | Description |
|---|
| number | The character's movement frequency |
Random move handling
Get the move speed of the character
Returns:
| Type | Description |
|---|
| number | The character's movement speed |
Moves straight in the given direction
| Name | Type | Description |
|---|
d | number | The direction to move in |
Moves toward the given character
| Name | Type | Description |
|---|
character | Game_Character | The character to move toward |
Moves toward the player
Get the opacity of the character
Returns:
| Type | Description |
|---|
| number | The character's opacity |
Get the current animation pattern
Returns:
| Type | Description |
|---|
| number | The current animation pattern |
Plays the vehicle bgm
Check if the character's position is equal to the passed coordinates
| Name | Type | Description |
|---|
x | number | The x coordinate to check |
y | number | The y coordinate to check |
Returns:
| Type | Description |
|---|
| boolean | True if coordinates match |
Check if the character's position is equal to the passed coordinates, and it's (n)ot (t)hrough
| Name | Type | Description |
|---|
x | number | The x coordinate to check |
y | number | The y coordinate to check |
Returns:
| Type | Description |
|---|
| boolean | True if coordinates match and the character is not through |
Processes a given move command
| Name | Type | Description |
|---|
command | Object | The move command |
Processing when move route ends
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 vehicle
Refresh the character for bush depth change
Get the region id the character is on
Returns:
| Type | Description |
|---|
| number | The region id |
Resets the direction of the vehicle
Resets the animation pattern
Resets the stop count
Restores a memorized move route
Reverse the character's direction
| Name | Type | Description |
|---|
d | number | The direction to reverse from |
Get the character screen x value
Returns:
| Type | Description |
|---|
| number | The screen x value |
Get the character screen y value
Returns:
| Type | Description |
|---|
| number | The screen y value |
Get the character screen z value
Returns:
| Type | Description |
|---|
| number | The screen z value |
Get the character scrolled x value
Returns:
| Type | Description |
|---|
| number | The scrolled x value |
Get the character scrolled y value
Returns:
| Type | Description |
|---|
| number | The scrolled y value |
The maximum amount of tiles to search for finding direction
Returns:
| Type | Description |
|---|
| number | The search limit |
Sets the vehicle bgm
| Name | Type | Description |
|---|
bgm | Object | The new vehicle bgm |
Set the blend mode of the character
| Name | Type | Description |
|---|
blendMode | number | The character's new blend mode |
Set the direction of the character
| Name | Type | Description |
|---|
d | number | The character's new direction |
Set the character direction fix flag
| Name | Type | Description |
|---|
directionFix | boolean | New direction fix flag |
setImage(characterName, characterIndex)inherited
Set the character's image properties (character name and index)
| Name | Type | Description |
|---|
characterName | string | The new character name |
characterIndex | number | The new character index |
Set the vehicle location
| Name | Type | Description |
|---|
mapId | number | The map id of the new location |
x | number | The x coordinate on the map |
y | number | The y coordinate on the map |
Set the move frequency of the character
| Name | Type | Description |
|---|
moveFrequency | number | The character's new movement frequency |
Sets a move route
| Name | Type | Description |
|---|
moveRoute | Object | The move route to set |
Set the move speed of the character
| Name | Type | Description |
|---|
moveSpeed | number | The character's new movement speed |
Set movement success
| Name | Type | Description |
|---|
success | boolean | Whether movement succeeded |
Set the opacity of the character
| Name | Type | Description |
|---|
opacity | number | The character's new opacity |
Set the current animation pattern
| Name | Type | Description |
|---|
pattern | number | The new current animation pattern |
Sets the position of the character
| Name | Type | Description |
|---|
x | number | The new x coordinate |
y | number | The new y coordinate |
Set the priority type of the character
| Name | Type | Description |
|---|
priorityType | number | The character's new priority type |
Set the character step animation flag
| Name | Type | Description |
|---|
stepAnime | boolean | New step animation flag |
Set the character through flag
| Name | Type | Description |
|---|
through | boolean | New through flag |
Set the character's image properties when it's a tile character
| Name | Type | Description |
|---|
tileId | number | The tile id to use for the image |
Set the transparent flag
| Name | Type | Description |
|---|
transparent | boolean | New transparent flag |
Set the character walk animation flag
| Name | Type | Description |
|---|
walkAnime | boolean | New walk animation flag |
Get the shadow opacity
Returns:
| Type | Description |
|---|
| number | Shadow opacity |
Get the shadow x coordinate on the screen
Returns:
| Type | Description |
|---|
| number | Shadow x coordinate |
Get the shadow y coordinate on the screen
Returns:
| Type | Description |
|---|
| number | Shadow y coordinate |
Get the amount to shift the character's y value
Returns:
| Type | Description |
|---|
| number | Amount to shift the y value by |
Start the animation
Start the character balloon animation
Straighten the character
Swap location with the given character
Sync the vehicle with the player
Get the terrain tag the character is on
Returns:
| Type | Description |
|---|
| number | The terrain tag |
Get the character's tile id
Returns:
| Type | Description |
|---|
| number | The character's tile id |
Turn 180 degrees (turn around)
Turns away from the given character
| Name | Type | Description |
|---|
character | Game_Character | The character to turn away from |
Turns away from the player
Turn left 90 degrees
Turn in a random direction
Turn right 90 degrees
Randomly turn right or left 90 degrees
Turns toward the given character
| Name | Type | Description |
|---|
character | Game_Character | The character to turn toward |
Turns toward the player
Update the character
Update the airship
Update the airship altitude
Update the character's animation
Update the animation count
Update the character's jump
Update the character's move
Updates the animation pattern
Updates move route
Update the character's stop
Get the vehicle data object
Returns:
| Type | Description |
|---|
| Object|null | The vehicle data object, null if no vehicle |