atavism.agis.util
Class EventMessageHelper

java.lang.Object
  atavism.agis.util.EventMessageHelper

public class EventMessageHelper
extends java.lang.Object

Helper class that contains static functions for sending event messages down to the client.

Author:

Andrew Harrison

Field Summary

static java.lang.String	CANNOT_SELL_ITEM
static java.lang.String	CLAIM_PURCHASED
static java.lang.String	COMBAT_ABILITY_LEARNED
static java.lang.String	COMBAT_BLOCKED
static java.lang.String	COMBAT_BUFF_GAINED
static java.lang.String	COMBAT_BUFF_LOST
static java.lang.String	COMBAT_CASTING_CANCELLED
static java.lang.String	COMBAT_CASTING_STARTED
static java.lang.String	COMBAT_COOLDOWN_EXTENDED
static java.lang.String	COMBAT_DEBUFF_GAINED
static java.lang.String	COMBAT_DEBUFF_LOST
static java.lang.String	COMBAT_DODGED
static java.lang.String	COMBAT_EVADED
static java.lang.String	COMBAT_EXP_GAINED
static java.lang.String	COMBAT_HEAL
static java.lang.String	COMBAT_HEALTH_TRANSFER
static java.lang.String	COMBAT_IMMUNE
static java.lang.String	COMBAT_MAGICAL_CRITICAL
static java.lang.String	COMBAT_MAGICAL_DAMAGE
static java.lang.String	COMBAT_MISSED
static java.lang.String	COMBAT_PARRIED
static java.lang.String	COMBAT_PHYSICAL_CRITICAL
static java.lang.String	COMBAT_PHYSICAL_DAMAGE
static java.lang.String	COMBAT_REPUTATION_CHANGED
static java.lang.String	COMBAT_REVIVED
static java.lang.String	DUEL_COUNTDOWN
static java.lang.String	DUEL_DEFEAT
static java.lang.String	DUEL_NOT_OUT_OF_BOUNDS
static java.lang.String	DUEL_OUT_OF_BOUNDS
static java.lang.String	DUEL_START
static java.lang.String	DUEL_VICTORY
static java.lang.String	EQUIP_MISSING
static java.lang.String	ERROR_ALREADY_IN_GUILD
static java.lang.String	ERROR_DEAD
static java.lang.String	ERROR_GUILD_RANK_NO_DELETE_IS_MEMBER
static java.lang.String	ERROR_IN_COMBAT
static java.lang.String	ERROR_INSUFFICIENT_PERMISSION
static java.lang.String	ERROR_MOUNTED
static java.lang.String	ERROR_NO_EQUIP_SLOT
static java.lang.String	ERROR_WRONG_EQUIP_SLOT
static java.lang.String	GUILD_MASTER_NO_LEAVE
static java.lang.String	GUILD_MEMBER_JOINED
static java.lang.String	GUILD_MEMBER_LEFT
static java.lang.String	GUILD_NO_DEMOTE
static java.lang.String	GUILD_NO_PROMOTE
static java.lang.String	INSTANCE_REQUIRES_GROUP
static java.lang.String	INSTANCE_REQUIRES_GUILD
static java.lang.String	INSUFFICIENT_CLAIM_OBJECT_ITEMS
static java.lang.String	INVALID_ITEM
static java.lang.String	INVALID_TRADE_CURRENCY
static java.lang.String	INVENTORY_FULL
static java.lang.String	ITEM_HARVESTED
static java.lang.String	ITEM_LOOTED
static java.lang.String	MISSING_ITEM
static java.lang.String	NO_ITEM_DURABILITY
static java.lang.String	NOT_ENOUGH_CURRENCY
static java.lang.String	QUEST_PROGRESS
static java.lang.String	REPAIR_SUCCESSFUL
static java.lang.String	REPUTATION_CHANGED
static java.lang.String	RESOURCE_HARVEST_FAILED
static java.lang.String	RESOURCE_NODE_BUSY
static java.lang.String	SKILL_ALREADY_KNOWN
static java.lang.String	SKILL_LEVEL_TOO_LOW
static java.lang.String	SKILL_MISSING
static java.lang.String	SOCIAL_PLAYER_OFFLINE
static java.lang.String	STAT_DECREASE
static java.lang.String	STAT_INCREASE
static java.lang.String	STORAGE_NOT_EMPTY
static java.lang.String	TOO_FAR_AWAY

Constructor Summary

EventMessageHelper()

Method Summary

static void	SendCombatEvent(OID casterOID, OID targetOID, java.lang.String eventType, int abilityID, int effectID, int val, int val2) Sends a Combat Event to the client allowing it to add an entry to the combat log and be used for any other display purposes.
static void	SendErrorEvent(OID playerOid, java.lang.String eventType, int val, java.lang.String data) Not used yet.
static void	SendGeneralEvent(OID playerOid, java.lang.String eventType, int val, java.lang.String data) Not used yet.
static void	SendInventoryEvent(OID playerOid, java.lang.String eventType, int itemID, int count, java.lang.String data) Sends an Inventory Event to the client allowing it to display the information if wanted.
static void	SendQuestEvent(OID playerOid, java.lang.String eventType, java.lang.String data, int val1, int val2, int val3)
static void	SendReputationChangedEvent(OID playerOid, java.lang.String eventType, int val, java.lang.String name, java.lang.String data)
static void	SendRequirementFailedEvent(OID playerOid, RequirementCheckResult result)

Methods inherited from class java.lang.Object

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

Field Detail

COMBAT_PHYSICAL_DAMAGE

public static final java.lang.String COMBAT_PHYSICAL_DAMAGE

See Also:

Constant Field Values

COMBAT_MAGICAL_DAMAGE

public static final java.lang.String COMBAT_MAGICAL_DAMAGE

See Also:

Constant Field Values

COMBAT_PHYSICAL_CRITICAL

public static final java.lang.String COMBAT_PHYSICAL_CRITICAL

See Also:

Constant Field Values

COMBAT_MAGICAL_CRITICAL

public static final java.lang.String COMBAT_MAGICAL_CRITICAL

See Also:

Constant Field Values

COMBAT_HEAL

public static final java.lang.String COMBAT_HEAL

See Also:

Constant Field Values

COMBAT_HEALTH_TRANSFER

public static final java.lang.String COMBAT_HEALTH_TRANSFER

See Also:

Constant Field Values

COMBAT_REVIVED

public static final java.lang.String COMBAT_REVIVED

See Also:

Constant Field Values

COMBAT_MISSED

public static final java.lang.String COMBAT_MISSED

See Also:

Constant Field Values

COMBAT_DODGED

public static final java.lang.String COMBAT_DODGED

See Also:

Constant Field Values

COMBAT_BLOCKED

public static final java.lang.String COMBAT_BLOCKED

See Also:

Constant Field Values

COMBAT_PARRIED

public static final java.lang.String COMBAT_PARRIED

See Also:

Constant Field Values

COMBAT_EVADED

public static final java.lang.String COMBAT_EVADED

See Also:

Constant Field Values

COMBAT_IMMUNE

public static final java.lang.String COMBAT_IMMUNE

See Also:

Constant Field Values

COMBAT_BUFF_GAINED

public static final java.lang.String COMBAT_BUFF_GAINED

See Also:

Constant Field Values

COMBAT_DEBUFF_GAINED

public static final java.lang.String COMBAT_DEBUFF_GAINED

See Also:

Constant Field Values

COMBAT_BUFF_LOST

public static final java.lang.String COMBAT_BUFF_LOST

See Also:

Constant Field Values

COMBAT_DEBUFF_LOST

public static final java.lang.String COMBAT_DEBUFF_LOST

See Also:

Constant Field Values

COMBAT_COOLDOWN_EXTENDED

public static final java.lang.String COMBAT_COOLDOWN_EXTENDED

See Also:

Constant Field Values

COMBAT_REPUTATION_CHANGED

public static final java.lang.String COMBAT_REPUTATION_CHANGED

See Also:

Constant Field Values

COMBAT_EXP_GAINED

public static final java.lang.String COMBAT_EXP_GAINED

See Also:

Constant Field Values

COMBAT_ABILITY_LEARNED

public static final java.lang.String COMBAT_ABILITY_LEARNED

See Also:

Constant Field Values

COMBAT_CASTING_STARTED

public static final java.lang.String COMBAT_CASTING_STARTED

See Also:

Constant Field Values

COMBAT_CASTING_CANCELLED

public static final java.lang.String COMBAT_CASTING_CANCELLED

See Also:

Constant Field Values

ITEM_HARVESTED

public static final java.lang.String ITEM_HARVESTED

See Also:

Constant Field Values

ITEM_LOOTED

public static final java.lang.String ITEM_LOOTED

See Also:

Constant Field Values

REPUTATION_CHANGED

public static final java.lang.String REPUTATION_CHANGED

See Also:

Constant Field Values

REPAIR_SUCCESSFUL

public static final java.lang.String REPAIR_SUCCESSFUL

See Also:

Constant Field Values

DUEL_COUNTDOWN

public static final java.lang.String DUEL_COUNTDOWN

See Also:

Constant Field Values

DUEL_START

public static final java.lang.String DUEL_START

See Also:

Constant Field Values

DUEL_VICTORY

public static final java.lang.String DUEL_VICTORY

See Also:

Constant Field Values

DUEL_DEFEAT

public static final java.lang.String DUEL_DEFEAT

See Also:

Constant Field Values

DUEL_OUT_OF_BOUNDS

public static final java.lang.String DUEL_OUT_OF_BOUNDS

See Also:

Constant Field Values

DUEL_NOT_OUT_OF_BOUNDS

public static final java.lang.String DUEL_NOT_OUT_OF_BOUNDS

See Also:

Constant Field Values

STAT_INCREASE

public static final java.lang.String STAT_INCREASE

See Also:

Constant Field Values

STAT_DECREASE

public static final java.lang.String STAT_DECREASE

See Also:

Constant Field Values

CLAIM_PURCHASED

public static final java.lang.String CLAIM_PURCHASED

See Also:

Constant Field Values

GUILD_MEMBER_JOINED

public static final java.lang.String GUILD_MEMBER_JOINED

See Also:

Constant Field Values

GUILD_MEMBER_LEFT

public static final java.lang.String GUILD_MEMBER_LEFT

See Also:

Constant Field Values

ERROR_GUILD_RANK_NO_DELETE_IS_MEMBER

public static final java.lang.String ERROR_GUILD_RANK_NO_DELETE_IS_MEMBER

See Also:

Constant Field Values

GUILD_MASTER_NO_LEAVE

public static final java.lang.String GUILD_MASTER_NO_LEAVE

See Also:

Constant Field Values

GUILD_NO_DEMOTE

public static final java.lang.String GUILD_NO_DEMOTE

See Also:

Constant Field Values

GUILD_NO_PROMOTE

public static final java.lang.String GUILD_NO_PROMOTE

See Also:

Constant Field Values

SOCIAL_PLAYER_OFFLINE

public static final java.lang.String SOCIAL_PLAYER_OFFLINE

See Also:

Constant Field Values

ERROR_DEAD

public static final java.lang.String ERROR_DEAD

See Also:

Constant Field Values

NOT_ENOUGH_CURRENCY

public static final java.lang.String NOT_ENOUGH_CURRENCY

See Also:

Constant Field Values

INVALID_TRADE_CURRENCY

public static final java.lang.String INVALID_TRADE_CURRENCY

See Also:

Constant Field Values

NO_ITEM_DURABILITY

public static final java.lang.String NO_ITEM_DURABILITY

See Also:

Constant Field Values

SKILL_MISSING

public static final java.lang.String SKILL_MISSING

See Also:

Constant Field Values

SKILL_LEVEL_TOO_LOW

public static final java.lang.String SKILL_LEVEL_TOO_LOW

See Also:

Constant Field Values

EQUIP_MISSING

public static final java.lang.String EQUIP_MISSING

See Also:

Constant Field Values

TOO_FAR_AWAY

public static final java.lang.String TOO_FAR_AWAY

See Also:

Constant Field Values

RESOURCE_NODE_BUSY

public static final java.lang.String RESOURCE_NODE_BUSY

See Also:

Constant Field Values

RESOURCE_HARVEST_FAILED

public static final java.lang.String RESOURCE_HARVEST_FAILED

See Also:

Constant Field Values

INSTANCE_REQUIRES_GROUP

public static final java.lang.String INSTANCE_REQUIRES_GROUP

See Also:

Constant Field Values

INSTANCE_REQUIRES_GUILD

public static final java.lang.String INSTANCE_REQUIRES_GUILD

See Also:

Constant Field Values

SKILL_ALREADY_KNOWN

public static final java.lang.String SKILL_ALREADY_KNOWN

See Also:

Constant Field Values

CANNOT_SELL_ITEM

public static final java.lang.String CANNOT_SELL_ITEM

See Also:

Constant Field Values

INVENTORY_FULL

public static final java.lang.String INVENTORY_FULL

See Also:

Constant Field Values

STORAGE_NOT_EMPTY

public static final java.lang.String STORAGE_NOT_EMPTY

See Also:

Constant Field Values

ERROR_MOUNTED

public static final java.lang.String ERROR_MOUNTED

See Also:

Constant Field Values

INVALID_ITEM

public static final java.lang.String INVALID_ITEM

See Also:

Constant Field Values

MISSING_ITEM

public static final java.lang.String MISSING_ITEM

See Also:

Constant Field Values

INSUFFICIENT_CLAIM_OBJECT_ITEMS

public static final java.lang.String INSUFFICIENT_CLAIM_OBJECT_ITEMS

See Also:

Constant Field Values

ERROR_IN_COMBAT

public static final java.lang.String ERROR_IN_COMBAT

See Also:

Constant Field Values

ERROR_INSUFFICIENT_PERMISSION

public static final java.lang.String ERROR_INSUFFICIENT_PERMISSION

See Also:

Constant Field Values

ERROR_ALREADY_IN_GUILD

public static final java.lang.String ERROR_ALREADY_IN_GUILD

See Also:

Constant Field Values

ERROR_NO_EQUIP_SLOT

public static final java.lang.String ERROR_NO_EQUIP_SLOT

See Also:

Constant Field Values

ERROR_WRONG_EQUIP_SLOT

public static final java.lang.String ERROR_WRONG_EQUIP_SLOT

See Also:

Constant Field Values

QUEST_PROGRESS

public static final java.lang.String QUEST_PROGRESS

See Also:

Constant Field Values

Constructor Detail

EventMessageHelper

public EventMessageHelper()

Method Detail

SendCombatEvent

public static void SendCombatEvent(OID casterOID,
                                   OID targetOID,
                                   java.lang.String eventType,
                                   int abilityID,
                                   int effectID,
                                   int val,
                                   int val2)

Sends a Combat Event to the client allowing it to add an entry to the combat log and be used for any other display purposes.

Parameters:

casterOID -

targetOID -

eventType -

val -

SendInventoryEvent

public static void SendInventoryEvent(OID playerOid,
                                      java.lang.String eventType,
                                      int itemID,
                                      int count,
                                      java.lang.String data)

Sends an Inventory Event to the client allowing it to display the information if wanted.

Parameters:

playerOid -

eventType -

itemID -

count -

data -

SendGeneralEvent

public static void SendGeneralEvent(OID playerOid,
                                    java.lang.String eventType,
                                    int val,
                                    java.lang.String data)

Not used yet. To replace sendAnnouncementMessage

Parameters:

playerOid -

eventType -

val -

data -

SendReputationChangedEvent

public static void SendReputationChangedEvent(OID playerOid,
                                              java.lang.String eventType,
                                              int val,
                                              java.lang.String name,
                                              java.lang.String data)

SendErrorEvent

public static void SendErrorEvent(OID playerOid,
                                  java.lang.String eventType,
                                  int val,
                                  java.lang.String data)

Not used yet. To replace sendErrorMessage

Parameters:

playerOid -

eventType -

val -

data -

SendRequirementFailedEvent

public static void SendRequirementFailedEvent(OID playerOid,
                                              RequirementCheckResult result)

SendQuestEvent

public static void SendQuestEvent(OID playerOid,
                                  java.lang.String eventType,
                                  java.lang.String data,
                                  int val1,
                                  int val2,
                                  int val3)