Part 12. Creating player.

It has only three tiles, but should be enough for sample run animation, in our game player will automatically run in right direction, player will control jump function.

1. Loading player resources:

public ITiledTextureRegion player_region;

• lets load this region, inside our loadGameGraphics() method:

player_region = BitmapTextureAtlasTextureRegionFactory.createTiledFromAsset(gameTextureAtlas, activity, "player.png", 3, 1);

Do not forget to put players graphic inside assets/gfx/game directory. As you can see, we loaded players graphic, it has 3 columns, and 1 row.

2. Creaing Player code:

package com.matimdev.object;

import org.andengine.engine.camera.Camera;
import org.andengine.entity.sprite.AnimatedSprite;
import org.andengine.extension.physics.box2d.PhysicsWorld;
import org.andengine.opengl.vbo.VertexBufferObjectManager;

import com.matimdev.manager.ResourcesManager;

/**
 * @author Mateusz Mysliwiec
 * @author www.matim-dev.com
 * @version 1.0
 */
public abstract class Player extends AnimatedSprite
{
    // ---------------------------------------------
    // CONSTRUCTOR
    // ---------------------------------------------
    
    public Player(float pX, float pY, VertexBufferObjectManager vbo, Camera camera, PhysicsWorld physicsWorld)
    {
        super(pX, pY, ResourcesManager.getInstance().player_region, vbo);
    }
}

We made this class abstract, because we will create some abstract methods. 

As mentioned we modified constructor little bit, as a texture region, we used previously create texture region from our resources manager. We will need also some new parameters, such as camera and physics world.

• create new field for our player body:

// ---------------------------------------------
// VARIABLES
// ---------------------------------------------
    
private Body body;

• create new abstract method onDie() we will execute it when certain events will occur.

public abstract void onDie();

• create new boolean to flag if player can jump (as I said, if player will firstly touch screen, we will make player run, and after that every next touch will make player jump) here`s method responsible for creating physics body for player:

private boolean canRun = false;

private void createPhysics(final Camera camera, PhysicsWorld physicsWorld)
{        
    body = PhysicsFactory.createBoxBody(physicsWorld, this, BodyType.DynamicBody, PhysicsFactory.createFixtureDef(0, 0, 0));

    body.setUserData("player");
    body.setFixedRotation(true);
    
    physicsWorld.registerPhysicsConnector(new PhysicsConnector(this, body, true, false)
    {
        @Override
        public void onUpdate(float pSecondsElapsed)
        {
            super.onUpdate(pSecondsElapsed);
            camera.onUpdate(0.1f);
            
            if (getY() <= 0)
            {                    
                onDie();
            }
            
            if (canRun)
            {    
                body.setLinearVelocity(new Vector2(5, body.getLinearVelocity().y)); 
            }
        }
    });
}

• execute this method inside constructor. Lets also add code setting camera`s chase entity, so camera will follow player`s position.

public Player(float pX, float pY, VertexBufferObjectManager vbo, Camera camera, PhysicsWorld physicsWorld)
{
    super(pX, pY, ResourcesManager.getInstance().player_region, vbo);
    createPhysics(camera, physicsWorld);
    camera.setChaseEntity(this);
}

• create method responsible for setting player run and animate, we will execute this method, after player`s first touch of the scene. Latter, every next screen touch will cause player to jump.

public void setRunning()
{
    canRun = true;
        
    final long[] PLAYER_ANIMATE = new long[] { 100, 100, 100 };
        
    animate(PLAYER_ANIMATE, 0, 2, true);
}

• create method responsible for jumping:

public void jump()
{
    body.setLinearVelocity(new Vector2(body.getLinearVelocity().x, 12)); 
}

player.java Download File

3. Initializing player on the scene:

• open our GameScene class, and implement IOnSceneTouchListener class. You will be forced by eclipse to add unimplemented method.

public boolean onSceneTouchEvent(Scene pScene, TouchEvent pSceneTouchEvent)
{
    if (pSceneTouchEvent.isActionDown())
    {

    }
    return false;
}

• inside our createScene method, add this line to register this scene touch listener:

setOnSceneTouchListener(this);

• lets take care about initializing player and placing it on the scene, create new field for player, and tag used for level loader.

private static final Object TAG_ENTITY_ATTRIBUTE_TYPE_VALUE_PLAYER = "player";
    
private Player player;

• add code responsible for initializing player inside level loader code, just like we did in previous article for loading platforms and coin from xml file:

else if (type.equals(TAG_ENTITY_ATTRIBUTE_TYPE_VALUE_PLAYER))
{
    player = new Player(x, y, vbom, camera, physicsWorld)
    {
        @Override
        public void onDie()
        {
            // TODO Latter we will handle it.
        }
    };
    levelObject = player;
}

• now simply open our level data file, and put line for our player:

<entity x="60" y="140" type="player"/>

4. Setting player run and allowing to jump:

private boolean firstTouch = false;

• now inside onSceneTouchEvent lets execute our logic:

public boolean onSceneTouchEvent(Scene pScene, TouchEvent pSceneTouchEvent)
{
    if (pSceneTouchEvent.isActionDown())
    {
        if (!firstTouch)
        {
            player.setRunning();
            firstTouch = true;
        }
        else
        {
            player.jump();
        }
    }
    return false;
}

• inside disposeScene() method lets add code responsible for removing chase entity.

camera.setChaseEntity(null);