VGDLSprite

java.lang.Object
- core.vgdl.VGDLSprite

Direct Known Subclasses:

Conveyor, Flicker, Immovable, Missile, MovingAvatar, Passive, RandomNPC, SpriteProducer, Walker
```
public abstract class VGDLSprite
extends java.lang.Object
```
Created with IntelliJ IDEA. User: Diego Date: 17/10/13 Time: 10:59 This is a Java port from Tom Schaul's VGDL - https://github.com/schaul/py-vgdl

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`autotiling` Indicates if the tile support autotiling
`int`	`bucket` Bucket
`boolean`	`bucketSharp` Bucket remainder.
`java.awt.Color`	`color` Color of this sprite.
`int`	`cooldown` States the pause ticks in-between two moves
`int`	`currentFrame` the current frame to be drawn
`boolean`	`draw_arrow` Tells if an arrow must be drawn to indicate the orientation of the sprite.
`double`	`frameRate` max frameRate for animating sprites
`double`	`frameRemaining` remaining frame speed
`double`	`friction` The amount of friction this sprite has when moving.
`double`	`gravity` The amount of gravity force that pushes down on the sprite
`int`	`healthPoints` Health points of this sprite.
`java.lang.String`	`hidden` If true, this sprite is never present in the observations passed to the controller.
`double`	`hMult`
`java.awt.Image`	`image` Unique and current image of this sprite.
`java.util.HashMap<java.lang.String,java.util.ArrayList<java.awt.Image>>`	`images` All images in case there's orientation changes and/or animations.
`java.lang.String`	`img` String that represents the image in VGDL.
`java.lang.String`	`invisible` Indicates if the sprite is invisible.
`boolean`	`is_avatar` Indicates if this sprite is the avatar (player) of the game.
`boolean`	`is_from_avatar` Indicates if this sprite was created by the avatar.
`boolean`	`is_npc` Indicates if this sprite is an NPC.
`boolean`	`is_oriented` Indicates if this sprite has an oriented behaviour.
`boolean`	`is_resource` Indicates if this sprite is a resource.
`boolean`	`is_static` Indicates if this sprite is static or not.
`boolean`	`is_stochastic` Indicates if the sprite has a stochastic behaviour.
`boolean`	`isFirstTick` Indicates if the sprite is in its first cycle of existence.
`java.util.ArrayList<java.lang.Integer>`	`itypes` List of types this sprite belongs to.
`double`	`jump_strength` Strength measure of this sprite.
`int`	`lastmove` Tells how many timesteps ago was the last move
`java.awt.Rectangle`	`lastrect` Rectangle occupied for this sprite in the previous game step.
`int`	`limitHealthPoints` Limit of health points of this can have.
`double`	`mass` Mass of this sprite (for Continuous physics).
`double`	`max_speed` Maximum speed of the sprites
`int`	`maxHealthPoints` Maximum health points of this sprite.
`java.lang.String`	`name` Name of this sprite.
`boolean`	`on_ground` Is the sprite on ground?
`boolean`	`only_active` Indicates if passive movement is denied for this sprite.
`Direction`	`orientation` Orientation of the sprite.
`java.lang.String`	`orientedImg` String that represents the image in VGDL.
`Physics`	`physics` Reference to the physics object this sprite belongs to.
`int`	`physicstype` Id of the type if physics this sprite responds to.
`boolean`	`portal` Indicates if this sprite is a portal.
`double`	`randomtiling` Indicates if the tile picking is random
`java.awt.Rectangle`	`rect` Rectangle that this sprite occupies on the screen.
`java.util.TreeMap<java.lang.Integer,java.lang.Integer>`	`resources` Indicates the amount of resources this sprite has, for each type defined as its int identifier.
`boolean`	`rotateInPlace` Indicates if the sprite is able to rotate in place.
`double`	`rotation` The sprites rotation
`double`	`shrinkfactor` Scale factor to draw this sprite.
`boolean`	`singleton` Indicates if this sprite is a singleton.
`java.awt.Dimension`	`size` The sprites size
`boolean`	`solid` Is this a SOLID sprite?
`double`	`speed` Scalar speed of this sprite.
`int`	`spriteID` ID of this sprite.
`boolean`	`stationary` identifies whether this sprite should move (if an Avatar)
`int`	`timeToLive` Time to live for this sprite.
`double`	`wMult` Multipliers for sprite's rectangle size

Constructor Summary

Constructors
Constructor and Description

VGDLSprite()

Constructors
Constructor and Description
`VGDLSprite()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`_draw(java.awt.Graphics2D gphx, Game game, java.awt.Rectangle r)` Draws the not-oriented part of the sprite
`protected void`	`_drawHealthBar(java.awt.Graphics2D gphx, Game game, java.awt.Rectangle r)` Draws the health bar, as a vertical bar on top (and left) of the sprite.
`void`	`_drawImage(java.awt.Graphics2D gphx, Game game, java.awt.Rectangle r)` Draws the not-oriented part of the sprite, as an image. this.image must be not null.
`void`	`_drawOriented(java.awt.Graphics2D g, java.awt.Rectangle r)` In case this sprite is oriented and has an arrow to draw, it draws it.
`protected void`	`_drawResources(java.awt.Graphics2D gphx, Game game, java.awt.Rectangle r)` Draws the resources hold by this sprite, as an horizontal bar on top of the sprite.
`boolean`	`_updateOrientation(Direction orientation)` Updates the orientation of the avatar to match the orientation parameter.
`boolean`	`_updatePos(Direction orientation, int speed)` Updates the position of the sprite, giving its orientation and speed.
`boolean`	`_updateRotation(double rot)`
`Vector2d`	`_velocity()` Returns the velocity of the sprite, in a Vector2d object.
`abstract VGDLSprite`	`copy()` Creates a copy of this sprite.
`void`	`copyTo(VGDLSprite toSprite)` Copies the attributes of this object to the one passed as parameter.
`void`	`draw(java.awt.Graphics2D gphx, Game game)` Draws this sprite (both the not oriented and, if appropriate, the oriented part)
`boolean`	`equiv(java.lang.Object o)` Determines if two the object passed is equal to this.
`int`	`getAmountResource(int resourceId)` Returns the amount of resource of a given type this sprite has.
`java.util.ArrayList<java.lang.String>`	`getDependentSprites()` Get all sprites that affect or being affected by the current sprite
`Vector2d`	`getLastPosition()` Gets the last position of this sprite.
`Vector2d`	`getPosition()` Gets the position of this sprite.
`int`	`getType()` Gets the unique and precise type of this sprite
`boolean`	`groundIntersects(VGDLSprite sp)` Overwritting intersects to check if we are on ground.
`protected void`	`init(Vector2d position, java.awt.Dimension size)` Initializes the sprite, giving its position and dimensions.
`boolean`	`intersects(VGDLSprite sp)` Checks if this sprites intersects with the one received as parameter.
`boolean`	`is_disabled()` Check if this sprite is disabled.
`Vector2d`	`lastDirection()` Returns the last direction this sprite is following.
`protected void`	`loadDefaults()` Loads the default values for this sprite.
`void`	`loadImage()` Loads the image that represents this sprite, using its string name as reference.
`void`	`modifyResource(int resourceId, int amount_delta)` Modifies the amount of resource by a given quantity.
`void`	`parseParameters(SpriteContent content)` Parses parameters for the sprite, received as a SpriteContent object.
`void`	`postProcess()` Method to perform post processing when the sprite has received its parameters.
`void`	`preMovement()` Prepares the sprite for movement.
`void`	`removeResource(int resourceId)` Removes all resources collected of the specified type.
`void`	`setDisabled(boolean is_disabled)` Set the disabled flag of this sprite.
`void`	`setFromAvatar(boolean fromAvatar)` Used to indicate if this sprite was created by the avatar.
`void`	`setRect(java.awt.Rectangle rectangle)`
`void`	`setRect(Vector2d position, java.awt.Dimension size)`
`void`	`subtractResource(int resourceId, int amount_delta)`
`java.lang.String`	`toString()` Returns a string representation of this string, including its name and position.
`void`	`update(Game game)` Updates this sprite, performing the movements and actions for the next step.
`void`	`updateAvatar(Game game, boolean request, boolean[] actionMask)`
`void`	`updateBucket()`
`void`	`updatePassive()` Updates this sprite applying the passive movement.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
public java.lang.String name
```
    Name of this sprite.
  - is_static
```
public boolean is_static
```
    Indicates if this sprite is static or not.
  - only_active
```
public boolean only_active
```
    Indicates if passive movement is denied for this sprite.
  - is_avatar
```
public boolean is_avatar
```
    Indicates if this sprite is the avatar (player) of the game.
  - is_stochastic
```
public boolean is_stochastic
```
    Indicates if the sprite has a stochastic behaviour.
  - color
```
public java.awt.Color color
```
    Color of this sprite.
  - cooldown
```
public int cooldown
```
    States the pause ticks in-between two moves
  - speed
```
public double speed
```
    Scalar speed of this sprite.
  - stationary
```
public boolean stationary
```
    identifies whether this sprite should move (if an Avatar)
  - mass
```
public double mass
```
    Mass of this sprite (for Continuous physics).
  - physicstype
```
public int physicstype
```
    Id of the type if physics this sprite responds to.
  - physics
```
public Physics physics
```
    Reference to the physics object this sprite belongs to.
  - gravity
```
public double gravity
```
    The amount of gravity force that pushes down on the sprite
  - friction
```
public double friction
```
    The amount of friction this sprite has when moving.
  - shrinkfactor
```
public double shrinkfactor
```
    Scale factor to draw this sprite.
  - is_oriented
```
public boolean is_oriented
```
    Indicates if this sprite has an oriented behaviour.
  - draw_arrow
```
public boolean draw_arrow
```
    Tells if an arrow must be drawn to indicate the orientation of the sprite.
  - orientation
```
public Direction orientation
```
    Orientation of the sprite.
  - rect
```
public java.awt.Rectangle rect
```
    Rectangle that this sprite occupies on the screen.
  - lastrect
```
public java.awt.Rectangle lastrect
```
    Rectangle occupied for this sprite in the previous game step.
  - lastmove
```
public int lastmove
```
    Tells how many timesteps ago was the last move
  - jump_strength
```
public double jump_strength
```
    Strength measure of this sprite.
  - singleton
```
public boolean singleton
```
    Indicates if this sprite is a singleton.
  - is_resource
```
public boolean is_resource
```
    Indicates if this sprite is a resource.
  - portal
```
public boolean portal
```
    Indicates if this sprite is a portal.
  - invisible
```
public java.lang.String invisible
```
    Indicates if the sprite is invisible. If it is, the effect is that it is not drawn.
  - hidden
```
public java.lang.String hidden
```
    If true, this sprite is never present in the observations passed to the controller.
  - autotiling
```
public boolean autotiling
```
    Indicates if the tile support autotiling
  - randomtiling
```
public double randomtiling
```
    Indicates if the tile picking is random
  - frameRate
```
public double frameRate
```
    max frameRate for animating sprites
  - frameRemaining
```
public double frameRemaining
```
    remaining frame speed
  - currentFrame
```
public int currentFrame
```
    the current frame to be drawn
  - itypes
```
public java.util.ArrayList<java.lang.Integer> itypes
```
    List of types this sprite belongs to. It contains the ids, including itself's, from this sprite up in the hierarchy of sprites defined in SpriteSet in the game definition.
  - resources
```
public java.util.TreeMap<java.lang.Integer,java.lang.Integer> resources
```
    Indicates the amount of resources this sprite has, for each type defined as its int identifier.
  - images
```
public java.util.HashMap<java.lang.String,java.util.ArrayList<java.awt.Image>> images
```
    All images in case there's orientation changes and/or animations.
  - image
```
public java.awt.Image image
```
    Unique and current image of this sprite.
  - img
```
public java.lang.String img
```
    String that represents the image in VGDL.
  - orientedImg
```
public java.lang.String orientedImg
```
    String that represents the image in VGDL.
  - is_npc
```
public boolean is_npc
```
    Indicates if this sprite is an NPC.
  - spriteID
```
public int spriteID
```
    ID of this sprite.
  - is_from_avatar
```
public boolean is_from_avatar
```
    Indicates if this sprite was created by the avatar.
  - bucket
```
public int bucket
```
    Bucket
  - bucketSharp
```
public boolean bucketSharp
```
    Bucket remainder.
  - rotateInPlace
```
public boolean rotateInPlace
```
    Indicates if the sprite is able to rotate in place.
  - isFirstTick
```
public boolean isFirstTick
```
    Indicates if the sprite is in its first cycle of existence. Passive movement is not allowed in the first tick.
  - healthPoints
```
public int healthPoints
```
    Health points of this sprite. It does not automatically kill the sprite when it gets to 0 (an effect must do that, like 'SubtractHealthPoints'). Its default value is set to 0, if not set specifically in VGDL.
  - maxHealthPoints
```
public int maxHealthPoints
```
    Maximum health points of this sprite. If not set specifically in VGDL, the default value is set to the healthPoints value set. This is NOT the maximum possible amount of points, it's the max. ever had.
  - limitHealthPoints
```
public int limitHealthPoints
```
    Limit of health points of this can have. If not set specifically in VGDL, the default value is set to a very high value (1000)
  - timeToLive
```
public int timeToLive
```
    Time to live for this sprite. Default set to -1 will not affect the sprite. If ttl > -1, when it gets to 0, the sprite gets killed.
  - rotation
```
public double rotation
```
    The sprites rotation
  - wMult
```
public double wMult
```
    Multipliers for sprite's rectangle size
  - hMult
```
public double hMult
```
  - size
```
public java.awt.Dimension size
```
    The sprites size
  - on_ground
```
public boolean on_ground
```
    Is the sprite on ground?
  - solid
```
public boolean solid
```
    Is this a SOLID sprite? Meaning, can sprites stand on top of them, triggering the on_ground check.
  - max_speed
```
public double max_speed
```
    Maximum speed of the sprites
- Constructor Detail
  - VGDLSprite
```
public VGDLSprite()
```
- Method Detail
  - init
```
protected void init(Vector2d position,
                    java.awt.Dimension size)
```
    Initializes the sprite, giving its position and dimensions.
    
    Parameters:
    
    position - position of the sprite
    
    size - dimensions of the sprite on the screen.
  - setRect
```
public void setRect(Vector2d position,
                    java.awt.Dimension size)
```
  - setRect
```
public void setRect(java.awt.Rectangle rectangle)
```
  - loadDefaults
```
protected void loadDefaults()
```
    Loads the default values for this sprite.
  - parseParameters
```
public void parseParameters(SpriteContent content)
```
    Parses parameters for the sprite, received as a SpriteContent object.
    
    Parameters:
    
    content -
  - update
```
public void update(Game game)
```
    Updates this sprite, performing the movements and actions for the next step.
    
    Parameters:
    
    game - the current game that is being played.
  - updateAvatar
```
public void updateAvatar(Game game,
                         boolean request,
                         boolean[] actionMask)
```
  - setDisabled
```
public void setDisabled(boolean is_disabled)
```
    Set the disabled flag of this sprite.
    
    Parameters:
    
    is_disabled - - disabled state
  - is_disabled
```
public boolean is_disabled()
```
    Check if this sprite is disabled.
    
    Returns:
    
    true if disabled, false otherwise.
  - preMovement
```
public void preMovement()
```
    Prepares the sprite for movement.
  - updatePassive
```
public void updatePassive()
```
    Updates this sprite applying the passive movement.
  - _updateOrientation
```
public boolean _updateOrientation(Direction orientation)
```
    Updates the orientation of the avatar to match the orientation parameter.
    
    Parameters:
    
    orientation - final orientation the avatar must have.
    
    Returns:
    
    true if orientation could be changed. This returns false in two circumstances: the avatar is not oriented (is_oriented == false) or the previous orientation is the same as the one received by parameter.
  - _updatePos
```
public boolean _updatePos(Direction orientation,
                          int speed)
```
    Updates the position of the sprite, giving its orientation and speed.
    
    Parameters:
    
    orientation - the orientation of the sprite.
    
    speed - the speed of the sprite.
    
    Returns:
    
    true if the position changed.
  - _updateRotation
```
public boolean _updateRotation(double rot)
```
    Parameters:
    
    rot - the rotation of the sprite
    
    Returns:
    
    true if rotation could be changed
  - updateBucket
```
public void updateBucket()
```
  - _velocity
```
public Vector2d _velocity()
```
    Returns the velocity of the sprite, in a Vector2d object.
    
    Returns:
    
    the velocity of the sprite
  - intersects
```
public boolean intersects(VGDLSprite sp)
```
    Checks if this sprites intersects with the one received as parameter.
    
    Parameters:
    
    sp - the other sprite to check collisions with
    
    Returns:
    
    true if there's a collision.
  - lastDirection
```
public Vector2d lastDirection()
```
    Returns the last direction this sprite is following.
    
    Returns:
    
    the direction.
  - getPosition
```
public Vector2d getPosition()
```
    Gets the position of this sprite.
    
    Returns:
    
    the position as a Vector2d.
  - getLastPosition
```
public Vector2d getLastPosition()
```
    Gets the last position of this sprite. Returns null if same as current position.
    
    Returns:
    
    the position as a Vector2d.
  - modifyResource
```
public void modifyResource(int resourceId,
                           int amount_delta)
```
    Modifies the amount of resource by a given quantity.
    
    Parameters:
    
    resourceId - id of the resource whose quantity must be changed.
    
    amount_delta - amount of units the resource has to be modified by.
  - subtractResource
```
public void subtractResource(int resourceId,
                             int amount_delta)
```
  - removeResource
```
public void removeResource(int resourceId)
```
    Removes all resources collected of the specified type.
    
    Parameters:
    
    resourceId - - id of the resource whose quantity must be changed.
  - getAmountResource
```
public int getAmountResource(int resourceId)
```
    Returns the amount of resource of a given type this sprite has.
    
    Parameters:
    
    resourceId - id of the resource to check.
    
    Returns:
    
    how much of this resource this sprite has.
  - draw
```
public void draw(java.awt.Graphics2D gphx,
                 Game game)
```
    Draws this sprite (both the not oriented and, if appropriate, the oriented part)
    
    Parameters:
    
    gphx - graphics object to draw in.
    
    game - reference to the game that is being played now.
  - groundIntersects
```
public boolean groundIntersects(VGDLSprite sp)
```
    Overwritting intersects to check if we are on ground.
    
    Returns:
    
    true if it directly intersects with sp (as in the normal case), but additionally checks for on_ground condition.
  - _drawOriented
```
public void _drawOriented(java.awt.Graphics2D g,
                          java.awt.Rectangle r)
```
    In case this sprite is oriented and has an arrow to draw, it draws it.
    
    Parameters:
    
    g - graphics device to draw in.
  - _draw
```
public void _draw(java.awt.Graphics2D gphx,
                  Game game,
                  java.awt.Rectangle r)
```
    Draws the not-oriented part of the sprite
    
    Parameters:
    
    gphx - graphics object to draw in.
    
    game - reference to the game that is being played now.
  - _drawImage
```
public void _drawImage(java.awt.Graphics2D gphx,
                       Game game,
                       java.awt.Rectangle r)
```
    Draws the not-oriented part of the sprite, as an image. this.image must be not null.
    
    Parameters:
    
    gphx - graphics object to draw in.
    
    game - reference to the game that is being played now.
  - _drawResources
```
protected void _drawResources(java.awt.Graphics2D gphx,
                              Game game,
                              java.awt.Rectangle r)
```
    Draws the resources hold by this sprite, as an horizontal bar on top of the sprite.
    
    Parameters:
    
    gphx - graphics to draw in.
    
    game - game being played at the moment.
  - _drawHealthBar
```
protected void _drawHealthBar(java.awt.Graphics2D gphx,
                              Game game,
                              java.awt.Rectangle r)
```
    Draws the health bar, as a vertical bar on top (and left) of the sprite.
    
    Parameters:
    
    gphx - graphics to draw in.
    
    game - game being played at the moment.
    
    r - rectangle of this sprite.
  - getType
```
public int getType()
```
    Gets the unique and precise type of this sprite
    
    Returns:
    
    the type
  - postProcess
```
public void postProcess()
```
    Method to perform post processing when the sprite has received its parameters.
  - loadImage
```
public void loadImage()
```
    Loads the image that represents this sprite, using its string name as reference.
  - setFromAvatar
```
public void setFromAvatar(boolean fromAvatar)
```
    Used to indicate if this sprite was created by the avatar.
    
    Parameters:
    
    fromAvatar - true if the avatar created this sprite.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this string, including its name and position.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation of this sprite.
  - copy
```
public abstract VGDLSprite copy()
```
    Creates a copy of this sprite. To be overwritten in each subclass.
    
    Returns:
    
    a copy of this sprite.
  - copyTo
```
public void copyTo(VGDLSprite toSprite)
```
    Copies the attributes of this object to the one passed as parameter.
    
    Parameters:
    
    toSprite - the sprite to copy to.
  - equiv
```
public boolean equiv(java.lang.Object o)
```
    Determines if two the object passed is equal to this. We are NOT overriding EQUALS on purpose (Costly operation for eventHandling).
  - getDependentSprites
```
public java.util.ArrayList<java.lang.String> getDependentSprites()
```
    Get all sprites that affect or being affected by the current sprite
    
    Returns:
    
    a list of all dependent sprites

Class VGDLSprite

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

is_static

only_active

is_avatar

is_stochastic

color

cooldown

speed

stationary

mass

physicstype

physics

gravity

friction

shrinkfactor

is_oriented

draw_arrow

orientation

rect

lastrect

lastmove

jump_strength

singleton

is_resource

portal

invisible

hidden

autotiling

randomtiling

frameRate

frameRemaining

currentFrame

itypes

resources

images

image

img

orientedImg

is_npc

spriteID

is_from_avatar

bucket

bucketSharp

rotateInPlace

isFirstTick

healthPoints

maxHealthPoints

limitHealthPoints

timeToLive

rotation

wMult

hMult

size

on_ground

solid

max_speed

Constructor Detail

VGDLSprite

Method Detail

init

setRect

setRect

loadDefaults

parseParameters

update

updateAvatar

setDisabled

is_disabled

preMovement

updatePassive

_updateOrientation

_updatePos

_updateRotation

updateBucket