atavism.agis.plugins

Class GuildClient

java.lang.Object

atavism.agis.plugins.GuildClient

public class GuildClient
extends java.lang.Object

This class is responsible for sending out messages associated with the Guild System. The majority (if not all) of the messages should be caught by the GuildPlugin class.

Author:

Andrew Harrison

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GuildClient.createGuildMessage
static class	GuildClient.getPlayerIsOnlineMessage
static class	GuildClient.guildClaimPermitionMessage
static class	GuildClient.guildCommandMessage

Field Summary

Fields

Modifier and Type	Field and Description
static MessageType	MSG_TYPE_CREATE_GUILD
static MessageType	MSG_TYPE_GET_PLAYER_IS_ONLINE
static MessageType	MSG_TYPE_GUILD_CLAIM_PERMISSION
static MessageType	MSG_TYPE_GUILD_COMMAND
static MessageType	MSG_TYPE_INVITE_RESPONSE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GuildClient()

Method Summary

Modifier and Type	Method and Description
static void	createGuild(OID oid, java.lang.String guildName) Sends the createGuildMessage which will create a new guild if one with the given name doesn't exist.
static int	getGuildClaimPermition(OID oid, int guildId)
static boolean	getPlayerIsOnline(OID oid) Sends the getPlayerIsOnlineMessage which will attempt to get a players oid from their name.
static void	guildCommand(OID oid, java.lang.String commandType, java.io.Serializable data, java.io.Serializable dataTwo) Sends the guildCommandMessage which will deal with the given command appropriately.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_TYPE_GET_PLAYER_IS_ONLINE

public static final MessageType MSG_TYPE_GET_PLAYER_IS_ONLINE

MSG_TYPE_CREATE_GUILD

public static final MessageType MSG_TYPE_CREATE_GUILD

MSG_TYPE_INVITE_RESPONSE

public static final MessageType MSG_TYPE_INVITE_RESPONSE

MSG_TYPE_GUILD_COMMAND

public static final MessageType MSG_TYPE_GUILD_COMMAND

MSG_TYPE_GUILD_CLAIM_PERMISSION

public static final MessageType MSG_TYPE_GUILD_CLAIM_PERMISSION

Constructor Detail

GuildClient

protected GuildClient()

Method Detail

createGuild

public static void createGuild(OID oid,
                               java.lang.String guildName)

Sends the createGuildMessage which will create a new guild if one with the given name doesn't exist.

Parameters:

oid: - the identifier of the player who wishes to create the guild

guildName: - the name of the new guild to be created

getPlayerIsOnline

public static boolean getPlayerIsOnline(OID oid)
                                 throws java.io.IOException

Sends the getPlayerIsOnlineMessage which will attempt to get a players oid from their name.

Throws:

java.io.IOException

guildCommand

public static void guildCommand(OID oid,
                                java.lang.String commandType,
                                java.io.Serializable data,
                                java.io.Serializable dataTwo)

Sends the guildCommandMessage which will deal with the given command appropriately.

Parameters:

oid: - the identifier of the player who sent the command

commandType: - the type of command

data: - some data to assist with execution of the command

dataTwo: - another piece of data to assist with execution of the command0

getGuildClaimPermition

public static int getGuildClaimPermition(OID oid,
                                         int guildId)