com.jonathan.survivor

Class Profile

java.lang.Object

com.jonathan.survivor.Profile

All Implemented Interfaces:

com.badlogic.gdx.utils.Json.Serializable

public class Profile
extends java.lang.Object
implements com.badlogic.gdx.utils.Json.Serializable

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_WORLD_SEED Stores the max world seed that will be used to create the world.

Constructor Summary

Constructors

Constructor and Description
Profile() Creates a default profile with profileId = 0.
Profile(int id) Creates a new profile starting from the beginning of the game.

Method Summary

Methods

Modifier and Type	Method and Description
void	addScavengedLayerObject(GameObject gameObject) Adds the given GameObject as a scavenged GameObject.
void	addScavengedLayerObject(int row, int col, int objectId) Adds a scavenged object to the TerrainLayer, specified with the layer's cell coordinates.
Inventory	getInventory() Retrieves the player's inventory, which contains all of the items collected by the player.
Loadout	getLoadout() Gets the loadout used by the player.
int	getProfileId() Returns the if of the profile, where 0 is the first profile shown in the world selection list
java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>>>	getScavengedLayerObjects() Returns a HashMap containing an array for each TerrainLayer.
java.util.ArrayList<java.lang.Integer>	getScavengedLayerObjects(int row, int col) Returns a list of all of the objectIds that have been scavenged on the given TerrainLayer, denoted by its row and column.
int	getTerrainColOffset() Gets the terrain column offset which was saved to profile.
int	getTerrainRowOffset() Gets the terrain row offset which was saved to profile.
int	getWorldSeed() Returns the world seed used to procedurally generate the world.
void	read(com.badlogic.gdx.utils.Json json, com.badlogic.gdx.utils.JsonValue jsonData) Indicates how a JSON file is read to be converted into a Profile object.
void	setInventory(Inventory inventory) Sets the player's inventory, which contains all of the items collected by the player.
void	setLoadout(Loadout loadout) Sets the loadout used by the player.
void	setProfileId(int profileId) Sets the profile Id of the profile.
void	setScavengedLayerObjects(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>>> scavengedLayerObjects) Sets the HashMap containing objectId arrays for each TerrainLayer.
void	setTerrainColOffset(int offset) Sets the terrain column offset to be used the next time the game is loaded.
void	setTerrainRowOffset(int offset) Sets the terrain row offset to be used the next time the game is loaded.
void	setWorldSeed(int worldSeed) Sets the world seed of the profile.
java.lang.String	toString() Returns a string representation for the profile, used for each item of the world selection list from the world select screen.
void	write(com.badlogic.gdx.utils.Json json) Indicates how a Profile object is converted to a JSON file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_WORLD_SEED

public static final int MAX_WORLD_SEED

Stores the max world seed that will be used to create the world. Possibly the higher the value, the more probability in world diversity.

See Also:

Constant Field Values

Constructor Detail

Profile

public Profile()

Creates a default profile with profileId = 0. This constructor will be called when a Profile object is read from a JSON file.

Profile

public Profile(int id)

Creates a new profile starting from the beginning of the game. Called when the user creates a new world.

Parameters:

id - ID of the profile we want to create. The first profile has ID 0, and is the first shown in the world selection list.

Method Detail

setProfileId

public void setProfileId(int profileId)

Sets the profile Id of the profile.

getProfileId

public int getProfileId()

Returns the if of the profile, where 0 is the first profile shown in the world selection list

setWorldSeed

public void setWorldSeed(int worldSeed)

Sets the world seed of the profile. Changing it changes the entire world. Should not be changed after profile creation, or will break save file.

getWorldSeed

public int getWorldSeed()

Returns the world seed used to procedurally generate the world. Same seed = same world.

setTerrainRowOffset

public void setTerrainRowOffset(int offset)

Sets the terrain row offset to be used the next time the game is loaded. Set this to the row of the bottom-left-most layer of the level to resume the game where the player left off last.

getTerrainRowOffset

public int getTerrainRowOffset()

Gets the terrain row offset which was saved to profile. Specify this as the rowOffset of the TerrainLevel to start the game at the same place the user left off.

setTerrainColOffset

public void setTerrainColOffset(int offset)

Sets the terrain column offset to be used the next time the game is loaded. Set this to the column of the bottom-left-most layer of the level to resume the game where the player left off last.

getTerrainColOffset

public int getTerrainColOffset()

Gets the terrain column offset which was saved to profile. Specify this as the colOffset of the TerrainLevel to start the game at the same place the user left off.

toString

public java.lang.String toString()

Returns a string representation for the profile, used for each item of the world selection list from the world select screen.

Overrides:

toString in class java.lang.Object

write

public void write(com.badlogic.gdx.utils.Json json)

Indicates how a Profile object is converted to a JSON file.

Specified by:

write in interface com.badlogic.gdx.utils.Json.Serializable

read

public void read(com.badlogic.gdx.utils.Json json,
        com.badlogic.gdx.utils.JsonValue jsonData)

Indicates how a JSON file is read to be converted into a Profile object. Note that the default Profile constructor is called before this method.

Specified by:

read in interface com.badlogic.gdx.utils.Json.Serializable

getScavengedLayerObjects

public java.util.ArrayList<java.lang.Integer> getScavengedLayerObjects(int row,
                                                              int col)

Returns a list of all of the objectIds that have been scavenged on the given TerrainLayer, denoted by its row and column.

addScavengedLayerObject

public void addScavengedLayerObject(GameObject gameObject)

Adds the given GameObject as a scavenged GameObject. It is added as a scavenged GameObject at the TerrainLayer where it resides, so that the GameObject is never instantiated there again.

addScavengedLayerObject

public void addScavengedLayerObject(int row,
                           int col,
                           int objectId)

Adds a scavenged object to the TerrainLayer, specified with the layer's cell coordinates. Accepts the objectId of the scavenged GameObject. Makes it so that the GameObject won't respawn the next time the layer is displayed.

getLoadout

public Loadout getLoadout()

Gets the loadout used by the player.

setLoadout

public void setLoadout(Loadout loadout)

Sets the loadout used by the player.

getInventory

public Inventory getInventory()

Retrieves the player's inventory, which contains all of the items collected by the player.

setInventory

public void setInventory(Inventory inventory)

Sets the player's inventory, which contains all of the items collected by the player.

getScavengedLayerObjects

public java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>>> getScavengedLayerObjects()

Returns a HashMap containing an array for each TerrainLayer. This array specifies the objectIds of the GameObjects that have been scavenged on that layer. First key is the TerrainLayer's row, and second is the TerrainLayer's column.

setScavengedLayerObjects

public void setScavengedLayerObjects(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>>> scavengedLayerObjects)

Sets the HashMap containing objectId arrays for each TerrainLayer. These array specify the objectIds of the GameObjects that have been scavenged on a certain layer.