eu.wauz.wauzcore.system.instances

Class WauzActiveInstance

java.lang.Object

eu.wauz.wauzcore.system.instances.WauzBaseInstance

eu.wauz.wauzcore.system.instances.WauzActiveInstance

public class WauzActiveInstance
extends WauzBaseInstance

An instance data to save session scoped instance information.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<WauzCitizen>	activeCitizens The citizens that have been spawned in the instance.
private java.util.Map<java.lang.String,WauzInstanceKeyStatus>	keyStatusMap A map of the statuses of the instance's keys, indexed by key id.
private java.util.Map<org.bukkit.entity.Player,java.lang.Integer>	playerDeathMap A map of the amount of times a player has died in the instance so far, indexed by player.
private org.bukkit.Location	spawnLocation The location to spawn players.
private org.bukkit.World	world The world of the instance.

Constructor Summary

Constructors

Constructor and Description
WauzActiveInstance(org.bukkit.World world, java.lang.String name)
WauzActiveInstance(org.bukkit.World world, WauzInstance template) Constructs an active instance data, based on an instance template.

Method Summary

Modifier and Type	Method and Description
void	addPlayerDeath(org.bukkit.entity.Player player) Increases the amount of times a player has died in the instance by one.
void	clearActiveCitizens() Removes all citizens that have been spawned in the instance.
WauzInstanceKeyStatus	getKeyStatus(java.lang.String keyId)
int	getPlayerDeaths(org.bukkit.entity.Player player)
org.bukkit.Location	getSpawnLocation()
org.bukkit.World	getWorld()
void	setKeyStatus(java.lang.String keyId, WauzInstanceKeyStatus status) Updates the status of a key.

Methods inherited from class eu.wauz.wauzcore.system.instances.WauzBaseInstance

getDisplaySubtitle, getDisplayTitle, getInstanceName, getKeyIds, getMaxDeaths, getMaxPlayers, getMobArena, getSoundtrackName, getSpawnCoords, getType, setDisplaySubtitle, setDisplayTitle, setInstanceName, setKeyIds, setMaxDeaths, setMaxPlayers, setMobArena, setSoundtrackName, setSpawnCoords, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

world

private org.bukkit.World world

The world of the instance.

spawnLocation

private org.bukkit.Location spawnLocation

The location to spawn players.

activeCitizens

private java.util.List<WauzCitizen> activeCitizens

The citizens that have been spawned in the instance.

playerDeathMap

private java.util.Map<org.bukkit.entity.Player,java.lang.Integer> playerDeathMap

A map of the amount of times a player has died in the instance so far, indexed by player.

keyStatusMap

private java.util.Map<java.lang.String,WauzInstanceKeyStatus> keyStatusMap

A map of the statuses of the instance's keys, indexed by key id.

Constructor Detail

WauzActiveInstance

public WauzActiveInstance(org.bukkit.World world,
                          java.lang.String name)

WauzActiveInstance

public WauzActiveInstance(org.bukkit.World world,
                          WauzInstance template)

Constructs an active instance data, based on an instance template.

Parameters:

world - The world of the instance.

template - The template, the instance was created from.

See Also:

MobSpawn.spawn(World), WauzInstanceCitizen.spawn(World)

Method Detail

getWorld

public org.bukkit.World getWorld()

Returns:

The world of the instance.

getSpawnLocation

public org.bukkit.Location getSpawnLocation()

Returns:

The location to spawn players.

clearActiveCitizens

public void clearActiveCitizens()

Removes all citizens that have been spawned in the instance.

See Also:

WauzCitizen.removeFromChunkMap(WauzCitizen, org.bukkit.Chunk)

getPlayerDeaths

public int getPlayerDeaths(org.bukkit.entity.Player player)

Parameters:

player - The player to get the death count for.

Returns:

The amount of times a player has died in the instance so far.

addPlayerDeath

public void addPlayerDeath(org.bukkit.entity.Player player)

Increases the amount of times a player has died in the instance by one.

Parameters:

player - The player to increase the deaths for.

getKeyStatus

public WauzInstanceKeyStatus getKeyStatus(java.lang.String keyId)

Parameters:

keyId - The id of the key to get the status for.

Returns:

The status of the key.

setKeyStatus

public void setKeyStatus(java.lang.String keyId,
                         WauzInstanceKeyStatus status)

Updates the status of a key.

Parameters:

keyId - The id of the key to update the status for.

status - The new key status.