Get the character's X block from character sheet
Returns:
| Type | Description |
|---|
| number | Character X index on a character sheet |
Get the character's Y block from character sheet
Returns:
| Type | Description |
|---|
| number | Character Y index on a character sheet |
characterPatternX()number
Get the character's pattern X value within sheet block
Returns:
| Type | Description |
|---|
| number | Character X pattern |
characterPatternY()number
Get the character's pattern Y value within sheet block
Returns:
| Type | Description |
|---|
| number | Character Y pattern |
checkCharacter(character)boolean
Check if the sprite's character is equal to the given character
| Name | Type | Description |
|---|
character | Game_Character | Game character object to check |
Returns:
| Type | Description |
|---|
| boolean | True if the sprite's character matches |
Creates the half body sprites
Destroys the sprite
Gets the blend color for the sprite
Returns:
| Type | Description |
|---|
| array | The blend color [r, g, b, a] |
Gets the color tone for the sprite
Returns:
| Type | Description |
|---|
| array | The color tone [r, g, b, gray] |
Makes the sprite "hidden" (not visible)
Initialize sprite variables
Initializes the sprite
| Name | Type | Description |
|---|
bitmap | Bitmap | The bitmap of the sprite |
isEmptyCharacter()boolean
Check if the sprite is an empty character
Returns:
| Type | Description |
|---|
| boolean | True if the sprite is an empty character |
Check if the Sprite has changed images
Returns:
| Type | Description |
|---|
| boolean | True if the sprite has changed images |
isObjectCharacter()boolean
Check if the sprite is an object character
Returns:
| Type | Description |
|---|
| boolean | True if the character is an object character |
Check if the sprite is a tile
Returns:
| Type | Description |
|---|
| boolean | True if the character is a tile |
Sets the x and y coordiantes of the sprite
| Name | Type | Description |
|---|
x | number | The x coordinate of the sprite |
y | number | The y coordinate of the sprite |
Get the character's pattern height
Returns:
| Type | Description |
|---|
| number | Height of the pattern |
Get the character's pattern width
Returns:
| Type | Description |
|---|
| number | Width of the pattern |
Sets the blend color for the sprite
| Name | Type | Description |
|---|
color | array | The blend color [r, g, b, a] |
Set the character for the sprite
| Name | Type | Description |
|---|
character | Game_Character | The game character object to track |
Sets the bitmap to the character bitmap
Sets the color tone for the sprite
| Name | Type | Description |
|---|
tone | array | The color tone [r, g, b, gray] |
Sets the rectagle of the bitmap that the sprite displays
| Name | Type | Description |
|---|
x | number | The x coordinate of the frame |
y | number | The y coordinate of the frame |
width | number | The width of the frame |
height | number | The height of the frame |
Sets the hue rotation value
| Name | Type | Description |
|---|
hue | number | The hue value (-360, 360) |
Sets the bitmap to the tileset bitmap
Removes the "hidden" state of the sprite, making it visible
Get the tileset bitmap given the tile ID
| Name | Type | Description |
|---|
tileId | number | The ID of the tile |
Returns:
| Type | Description |
|---|
| Bitmap | The tileset bitmap |
Updates the sprite for each frame
Updates the sprite's bitmap
Update the character's frame
Updates the sprite's frame
Updates the half body sprites
Updates other things not already covered by an update function. By default this is opacity, blend mode, bush depth.
Updates the sprite's position
Updates the tile's frame
Updates the visibility status of the sprite