ArenaClient (Atavism Server API

java.lang.Object
- atavism.agis.plugins.ArenaClient

```
public class ArenaClient
extends java.lang.Object
```
This class is responsible for sending out messages associated with the Arena System. The majority (if not all) of the messages should be caught by the ArenaPlugin class.

Author:

Andrew Harrison

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ArenaClient.addArenaCreatureMessage`
`static class`	`ArenaClient.arenaKillMessage`
`static class`	`ArenaClient.despawnGatesMessage`
`static class`	`ArenaClient.dotScoreMessage`
`static class`	`ArenaClient.duelChallengeAcceptMessage`
`static class`	`ArenaClient.duelChallengeDeclineMessage`
`static class`	`ArenaClient.duelChallengeDisconnectMessage`
`static class`	`ArenaClient.duelChallengeMessage`
`static class`	`ArenaClient.duelChallengeRemoveMessage`
`static class`	`ArenaClient.duelDefeatMessage`
`static class`	`ArenaClient.duelDisconnectMessage`
`static class`	`ArenaClient.duelRemoveMessage`
`static class`	`ArenaClient.duelStartMessage`
`static class`	`ArenaClient.endArenaMessage`
`static class`	`ArenaClient.getArenaStatsMessage`
`static class`	`ArenaClient.removeEffectsMessage`
`static class`	`ArenaClient.removePlayerMessage`
`static class`	`ArenaClient.resourceNodeAssaultedMessage`
`static class`	`ArenaClient.startArenaCheckMessage`

Field Summary

Fields
Modifier and Type	Field and Description
`static MessageType`	`MSG_TYPE_ACTIVATE_ARENA_ABILITY`
`static MessageType`	`MSG_TYPE_ACTIVATE_MACHINE`
`static MessageType`	`MSG_TYPE_ADD_CREATURE`
`static MessageType`	`MSG_TYPE_ALTER_EXP`
`static MessageType`	`MSG_TYPE_ARENA_KILL`
`static MessageType`	`MSG_TYPE_CHANGE_RACE`
`static MessageType`	`MSG_TYPE_COMPLETE_TUTORIAL`
`static MessageType`	`MSG_TYPE_DESPAWN_GATES`
`static MessageType`	`MSG_TYPE_DOT_SCORE`
`static MessageType`	`MSG_TYPE_DROP_FLAG`
`static MessageType`	`MSG_TYPE_DUEL_ACCEPT_CHALLENGE`
`static MessageType`	`MSG_TYPE_DUEL_CHALLENGE`
`static MessageType`	`MSG_TYPE_DUEL_CHALLENGE_DISCONNECT`
`static MessageType`	`MSG_TYPE_DUEL_CHALLENGE_REMOVE`
`static MessageType`	`MSG_TYPE_DUEL_DECLINE_CHALLENGE`
`static MessageType`	`MSG_TYPE_DUEL_DEFEAT`
`static MessageType`	`MSG_TYPE_DUEL_DISCONNECT`
`static MessageType`	`MSG_TYPE_DUEL_REMOVE`
`static MessageType`	`MSG_TYPE_DUEL_START`
`static MessageType`	`MSG_TYPE_END_ARENA`
`static MessageType`	`MSG_TYPE_GET_ARENA_LIST`
`static MessageType`	`MSG_TYPE_GET_ARENA_STATS`
`static MessageType`	`MSG_TYPE_GET_ARENA_TYPES`
`static MessageType`	`MSG_TYPE_GROUP_JOIN_QUEUE`
`static MessageType`	`MSG_TYPE_GROUP_LEAVE_QUEUE`
`static MessageType`	`MSG_TYPE_JOIN_QUEUE`
`static MessageType`	`MSG_TYPE_LEAVE_ARENA`
`static MessageType`	`MSG_TYPE_LEAVE_QUEUE`
`static MessageType`	`MSG_TYPE_PICKUP_FLAG`
`static MessageType`	`MSG_TYPE_RELEASE_REQUEST`
`static MessageType`	`MSG_TYPE_REMOVE_EFFECTS`
`static MessageType`	`MSG_TYPE_REMOVE_PLAYER`
`static MessageType`	`MSG_TYPE_SELECT_RACE`
`static MessageType`	`MSG_TYPE_START_ARENA_CHECK`
`static Namespace`	`NAMESPACE`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ArenaClient()

Constructors
Modifier	Constructor and Description
`protected`	`ArenaClient()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addArenaCreature(java.lang.Long creatureOid, int arenaID)` Sends the addArenaCreatureMessage which will add the oid of the creature to the specified arena's list of creatures.
`static void`	`arenaDeath(OID k, OID v)` Sends the arenaDeathMessage which will cause the scores to be updated for the arena the killer/victim was in.
`static void`	`arenaReleaseRequest(OID oid)`
`static void`	`despawnGates(OID instanceOid, int arenaID)` Sends the despawnGatesMessage which will cause the gates in the specified instance to be removed.
`static void`	`dotScore(OID oid)` Sends the dotScoreMessage which will cause the scores to be updated for the arena where the player who ate the dot is in.
`static void`	`duelChallenge(OID challenger, OID challenged)` Sends the duelChallengeMessage which will create a new Duel Challenge object.
`static void`	`duelChallengeAccept(OID accepterOid)` Sends the duelChallengeAcceptMessage which will update the accepted status of the player for their corresponding duel challenge.
`static void`	`duelChallengeDecline(OID declinerOid)` Sends the duelChallengeDeclineMessage which will end the duel challenge.
`static void`	`duelChallengeDisconnect(OID defeatedOid, java.lang.String name, int challengeID)` Sends the duelChallengeDisconnectMessage which will remove the player from whatever duel they are in
`static void`	`duelChallengeRemove(int challengeID)` Sends the duelChallengeRemoveMessage which will remove the duelChallenge object from the ArenaPlugin.
`static void`	`duelDefeat(OID defeatedOid)` Sends the duelDefeatMessage which will remove the player from whatever duel they are in
`static void`	`duelDisconnect(OID defeatedOid, java.lang.String name, int duelID)` Sends the duelDisconnectMessage which will remove the player from whatever duel they are in
`static void`	`duelRemove(int duelID)` Sends the duelRemoveMessage which will remove the duelChallenge object from the ArenaPlugin.
`static void`	`duelStart(int challengeID)` Sends the duelStartMessage which will remove the duelChallenge object and create a new Duel object with the players from the challenge.
`static void`	`endArena(int arenaID)` Sends the endArenaMessage which will cause the arena to be removed from the Map stored in the ArenaPlugin.
`static void`	`getArenaStats(OID oid, int statsType)` Sends the getArenaStatsMessage which will cause the list of arena stats to be sent to the requesting client.
`static void`	`removeEffects(OID oid, java.lang.String type, int ID)` Sends the removeEffectsMessage which will remove any effects the layer had from the duel or arena
`static void`	`removePlayer(OID oid)` Sends the removePlayerMessage which will cause the specified player to be removed from any arena they are currently in.
`static void`	`resourceNodeAssaulted(OID oid, OID nodeOid)` Sends the resourceNodeAssaultedMessage which will cause the list of arena stats to be sent to the requesting client.
`static void`	`startArenaCheck()` Sends the startArenaCheckMessage which will cause the ArenaCheck class to be run every second.

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

- Field Detail
  - MSG_TYPE_LEAVE_ARENA
```
public static final MessageType MSG_TYPE_LEAVE_ARENA
```
  - MSG_TYPE_START_ARENA_CHECK
```
public static final MessageType MSG_TYPE_START_ARENA_CHECK
```
  - MSG_TYPE_ADD_CREATURE
```
public static final MessageType MSG_TYPE_ADD_CREATURE
```
  - MSG_TYPE_DESPAWN_GATES
```
public static final MessageType MSG_TYPE_DESPAWN_GATES
```
  - MSG_TYPE_END_ARENA
```
public static final MessageType MSG_TYPE_END_ARENA
```
  - MSG_TYPE_GET_ARENA_TYPES
```
public static final MessageType MSG_TYPE_GET_ARENA_TYPES
```
  - MSG_TYPE_GET_ARENA_LIST
```
public static final MessageType MSG_TYPE_GET_ARENA_LIST
```
  - MSG_TYPE_JOIN_QUEUE
```
public static final MessageType MSG_TYPE_JOIN_QUEUE
```
  - MSG_TYPE_LEAVE_QUEUE
```
public static final MessageType MSG_TYPE_LEAVE_QUEUE
```
  - MSG_TYPE_GROUP_JOIN_QUEUE
```
public static final MessageType MSG_TYPE_GROUP_JOIN_QUEUE
```
  - MSG_TYPE_GROUP_LEAVE_QUEUE
```
public static final MessageType MSG_TYPE_GROUP_LEAVE_QUEUE
```
  - MSG_TYPE_REMOVE_PLAYER
```
public static final MessageType MSG_TYPE_REMOVE_PLAYER
```
  - MSG_TYPE_ARENA_KILL
```
public static final MessageType MSG_TYPE_ARENA_KILL
```
  - MSG_TYPE_RELEASE_REQUEST
```
public static final MessageType MSG_TYPE_RELEASE_REQUEST
```
  - MSG_TYPE_DOT_SCORE
```
public static final MessageType MSG_TYPE_DOT_SCORE
```
  - MSG_TYPE_DUEL_CHALLENGE
```
public static final MessageType MSG_TYPE_DUEL_CHALLENGE
```
  - MSG_TYPE_DUEL_ACCEPT_CHALLENGE
```
public static final MessageType MSG_TYPE_DUEL_ACCEPT_CHALLENGE
```
  - MSG_TYPE_DUEL_DECLINE_CHALLENGE
```
public static final MessageType MSG_TYPE_DUEL_DECLINE_CHALLENGE
```
  - MSG_TYPE_DUEL_CHALLENGE_DISCONNECT
```
public static final MessageType MSG_TYPE_DUEL_CHALLENGE_DISCONNECT
```
  - MSG_TYPE_DUEL_CHALLENGE_REMOVE
```
public static final MessageType MSG_TYPE_DUEL_CHALLENGE_REMOVE
```
  - MSG_TYPE_DUEL_START
```
public static final MessageType MSG_TYPE_DUEL_START
```
  - MSG_TYPE_DUEL_DEFEAT
```
public static final MessageType MSG_TYPE_DUEL_DEFEAT
```
  - MSG_TYPE_DUEL_DISCONNECT
```
public static final MessageType MSG_TYPE_DUEL_DISCONNECT
```
  - MSG_TYPE_DUEL_REMOVE
```
public static final MessageType MSG_TYPE_DUEL_REMOVE
```
  - MSG_TYPE_REMOVE_EFFECTS
```
public static final MessageType MSG_TYPE_REMOVE_EFFECTS
```
  - MSG_TYPE_GET_ARENA_STATS
```
public static final MessageType MSG_TYPE_GET_ARENA_STATS
```
  - MSG_TYPE_ACTIVATE_ARENA_ABILITY
```
public static final MessageType MSG_TYPE_ACTIVATE_ARENA_ABILITY
```
  - MSG_TYPE_COMPLETE_TUTORIAL
```
public static final MessageType MSG_TYPE_COMPLETE_TUTORIAL
```
  - MSG_TYPE_SELECT_RACE
```
public static final MessageType MSG_TYPE_SELECT_RACE
```
  - MSG_TYPE_CHANGE_RACE
```
public static final MessageType MSG_TYPE_CHANGE_RACE
```
  - MSG_TYPE_PICKUP_FLAG
```
public static final MessageType MSG_TYPE_PICKUP_FLAG
```
  - MSG_TYPE_DROP_FLAG
```
public static final MessageType MSG_TYPE_DROP_FLAG
```
  - MSG_TYPE_ACTIVATE_MACHINE
```
public static final MessageType MSG_TYPE_ACTIVATE_MACHINE
```
  - MSG_TYPE_ALTER_EXP
```
public static final MessageType MSG_TYPE_ALTER_EXP
```
  - NAMESPACE
```
public static Namespace NAMESPACE
```
- Constructor Detail
  - ArenaClient
```
protected ArenaClient()
```
- Method Detail
  - startArenaCheck
```
public static void startArenaCheck()
                            throws java.io.IOException
```
    Sends the startArenaCheckMessage which will cause the ArenaCheck class to be run every second.
    
    Throws:
    
    java.io.IOException
  - addArenaCreature
```
public static void addArenaCreature(java.lang.Long creatureOid,
                                    int arenaID)
```
    Sends the addArenaCreatureMessage which will add the oid of the creature to the specified arena's list of creatures.
    
    Parameters:
    
    creatureOid: - the identifier for the creature
    
    arenaID: - the identifier for the arena which will have this creature added
  - despawnGates
```
public static void despawnGates(OID instanceOid,
                                int arenaID)
```
    Sends the despawnGatesMessage which will cause the gates in the specified instance to be removed.
    
    Parameters:
    
    instanceOid: - the identifier for the instance which needs the gates removed
    
    arenaID: - the identifier for the arena which needs the gates removed
  - endArena
```
public static void endArena(int arenaID)
```
    Sends the endArenaMessage which will cause the arena to be removed from the Map stored in the ArenaPlugin.
    
    Parameters:
    
    arenaID: - the identifier of the arena that has ended
  - removePlayer
```
public static void removePlayer(OID oid)
```
    Sends the removePlayerMessage which will cause the specified player to be removed from any arena they are currently in.
    
    Parameters:
    
    oid: - the player who is going to be removed
  - arenaDeath
```
public static void arenaDeath(OID k,
                              OID v)
```
    Sends the arenaDeathMessage which will cause the scores to be updated for the arena the killer/victim was in.
    
    Parameters:
    
    k: - the oid of the killer
    
    v: - the oid of the victim
  - dotScore
```
public static void dotScore(OID oid)
```
    Sends the dotScoreMessage which will cause the scores to be updated for the arena where the player who ate the dot is in.
    
    Parameters:
    
    oid: - the oid of the player who ate the dot
  - duelChallenge
```
public static void duelChallenge(OID challenger,
                                 OID challenged)
```
    Sends the duelChallengeMessage which will create a new Duel Challenge object.
    
    Parameters:
    
    challenger: - the oid of the challenger
    
    challenged: - the oid of the challenged
  - duelChallengeAccept
```
public static void duelChallengeAccept(OID accepterOid)
```
    Sends the duelChallengeAcceptMessage which will update the accepted status of the player for their corresponding duel challenge.
    
    Parameters:
    
    accepterOid: - the oid of the accepter
  - duelChallengeDecline
```
public static void duelChallengeDecline(OID declinerOid)
```
    Sends the duelChallengeDeclineMessage which will end the duel challenge.
    
    Parameters:
    
    declinerOid: - the oid of the decliner
  - duelChallengeDisconnect
```
public static void duelChallengeDisconnect(OID defeatedOid,
                                           java.lang.String name,
                                           int challengeID)
```
    Sends the duelChallengeDisconnectMessage which will remove the player from whatever duel they are in
    
    Parameters:
    
    challengeID: - the id of the duel challenge
  - duelChallengeRemove
```
public static void duelChallengeRemove(int challengeID)
```
    Sends the duelChallengeRemoveMessage which will remove the duelChallenge object from the ArenaPlugin.
    
    Parameters:
    
    challengeID: - the id of the duel challenge
  - duelStart
```
public static void duelStart(int challengeID)
```
    Sends the duelStartMessage which will remove the duelChallenge object and create a new Duel object with the players from the challenge.
    
    Parameters:
    
    challengeID: - the id of the duel challenge
  - duelDefeat
```
public static void duelDefeat(OID defeatedOid)
```
    Sends the duelDefeatMessage which will remove the player from whatever duel they are in
    
    Parameters:
    
    challengeID: - the id of the duel challenge
  - duelDisconnect
```
public static void duelDisconnect(OID defeatedOid,
                                  java.lang.String name,
                                  int duelID)
```
    Sends the duelDisconnectMessage which will remove the player from whatever duel they are in
    
    Parameters:
    
    challengeID: - the id of the duel challenge
  - duelRemove
```
public static void duelRemove(int duelID)
```
    Sends the duelRemoveMessage which will remove the duelChallenge object from the ArenaPlugin.
    
    Parameters:
    
    challengeID: - the id of the duel challenge
  - removeEffects
```
public static void removeEffects(OID oid,
                                 java.lang.String type,
                                 int ID)
```
    Sends the removeEffectsMessage which will remove any effects the layer had from the duel or arena
    
    Parameters:
    
    ID: - the id of the duel or arena
  - getArenaStats
```
public static void getArenaStats(OID oid,
                                 int statsType)
```
    Sends the getArenaStatsMessage which will cause the list of arena stats to be sent to the requesting client.
    
    Parameters:
    
    oid: - the oid of the player wanting the arena stats.
  - resourceNodeAssaulted
```
public static void resourceNodeAssaulted(OID oid,
                                         OID nodeOid)
```
    Sends the resourceNodeAssaultedMessage which will cause the list of arena stats to be sent to the requesting client.
    
    Parameters:
    
    oid: - the oid of the player wanting the arena stats.
  - arenaReleaseRequest
```
public static void arenaReleaseRequest(OID oid)
```

Class ArenaClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MSG_TYPE_LEAVE_ARENA

MSG_TYPE_START_ARENA_CHECK

MSG_TYPE_ADD_CREATURE

MSG_TYPE_DESPAWN_GATES

MSG_TYPE_END_ARENA

MSG_TYPE_GET_ARENA_TYPES

MSG_TYPE_GET_ARENA_LIST

MSG_TYPE_JOIN_QUEUE

MSG_TYPE_LEAVE_QUEUE

MSG_TYPE_GROUP_JOIN_QUEUE

MSG_TYPE_GROUP_LEAVE_QUEUE

MSG_TYPE_REMOVE_PLAYER

MSG_TYPE_ARENA_KILL

MSG_TYPE_RELEASE_REQUEST

MSG_TYPE_DOT_SCORE

MSG_TYPE_DUEL_CHALLENGE

MSG_TYPE_DUEL_ACCEPT_CHALLENGE

MSG_TYPE_DUEL_DECLINE_CHALLENGE

MSG_TYPE_DUEL_CHALLENGE_DISCONNECT

MSG_TYPE_DUEL_CHALLENGE_REMOVE

MSG_TYPE_DUEL_START

MSG_TYPE_DUEL_DEFEAT

MSG_TYPE_DUEL_DISCONNECT

MSG_TYPE_DUEL_REMOVE

MSG_TYPE_REMOVE_EFFECTS

MSG_TYPE_GET_ARENA_STATS

MSG_TYPE_ACTIVATE_ARENA_ABILITY

MSG_TYPE_COMPLETE_TUTORIAL

MSG_TYPE_SELECT_RACE

MSG_TYPE_CHANGE_RACE

MSG_TYPE_PICKUP_FLAG

MSG_TYPE_DROP_FLAG

MSG_TYPE_ACTIVATE_MACHINE

MSG_TYPE_ALTER_EXP

NAMESPACE

Constructor Detail

ArenaClient

Method Detail

startArenaCheck

addArenaCreature

despawnGates

endArena

removePlayer

arenaDeath

dotScore

duelChallenge

duelChallengeAccept

duelChallengeDecline

duelChallengeDisconnect

duelChallengeRemove

duelStart

duelDefeat

duelDisconnect

duelRemove

removeEffects

getArenaStats

resourceNodeAssaulted

arenaReleaseRequest