Factions/src/com/massivecraft/factions/Faction.java

602 lines
15 KiB
Java
Raw Normal View History

2011-07-18 22:06:02 +02:00
package com.massivecraft.factions;
2011-02-06 13:36:11 +01:00
import java.util.*;
import org.bukkit.ChatColor;
2011-03-23 17:39:56 +01:00
import org.bukkit.Location;
2011-02-06 13:36:11 +01:00
import org.bukkit.entity.Player;
2011-07-18 22:06:02 +02:00
2011-10-12 17:25:01 +02:00
import com.massivecraft.factions.iface.EconomyParticipator;
import com.massivecraft.factions.iface.RelationParticipator;
import com.massivecraft.factions.integration.Econ;
import com.massivecraft.factions.integration.SpoutFeatures;
import com.massivecraft.factions.struct.FFlag;
2011-10-24 01:37:51 +02:00
import com.massivecraft.factions.struct.FPerm;
import com.massivecraft.factions.struct.Rel;
2011-07-18 22:06:02 +02:00
import com.massivecraft.factions.util.*;
import com.massivecraft.factions.zcore.persist.Entity;
2011-02-06 13:36:11 +01:00
2011-10-12 17:25:01 +02:00
public class Faction extends Entity implements EconomyParticipator
{
// FIELD: relationWish
private Map<String, Rel> relationWish;
// FIELD: fplayers
// speedy lookup of players in faction
private transient Set<FPlayer> fplayers = new HashSet<FPlayer>();
// FIELD: invites
// Where string is a lowercase player name
private Set<String> invites;
2011-10-24 03:02:25 +02:00
public void invite(FPlayer fplayer) { this.invites.add(fplayer.getId().toLowerCase()); }
public void deinvite(FPlayer fplayer) { this.invites.remove(fplayer.getId().toLowerCase()); }
public boolean isInvited(FPlayer fplayer) { return this.invites.contains(fplayer.getId().toLowerCase()); }
2011-03-22 17:20:21 +01:00
// FIELD: open
2011-03-22 17:20:21 +01:00
private boolean open;
public boolean getOpen() { return open; }
public void setOpen(boolean isOpen) { open = isOpen; }
// FIELD: tag
private String tag;
public String getTag() { return this.tag; }
public String getTag(String prefix) { return prefix+this.tag; }
public String getTag(RelationParticipator observer)
{
if (observer == null)
{
return getTag();
}
return this.getTag(this.getColorTo(observer).toString());
}
public void setTag(String str)
{
if (Conf.factionTagForceUpperCase)
{
str = str.toUpperCase();
}
this.tag = str;
}
public String getComparisonTag() { return MiscUtil.getComparisonString(this.tag); }
// FIELD: description
private String description;
public String getDescription() { return this.description; }
public void setDescription(String value) { this.description = value; }
2011-03-23 17:39:56 +01:00
// FIELD: home
private LazyLocation home;
public void setHome(Location home) { this.home = new LazyLocation(home); }
public boolean hasHome() { return this.getHome() != null; }
public Location getHome()
{
confirmValidHome();
return (this.home != null) ? this.home.getLocation() : null;
}
public void confirmValidHome()
{
if (!Conf.homesMustBeInClaimedTerritory || this.home == null || (this.home.getLocation() != null && Board.getFactionAt(new FLocation(this.home.getLocation())) == this))
return;
msg("<b>Your faction home has been un-set since it is no longer in your territory.");
this.home = null;
}
2011-10-12 17:25:01 +02:00
// FIELD: account (fake field)
// Bank functions
public double money;
public String getAccountId()
2011-10-12 17:25:01 +02:00
{
String aid = "faction-"+this.getId();
2011-10-12 18:48:47 +02:00
// We need to override the default money given to players.
if ( ! Econ.hasAccount(aid))
Econ.setBalance(aid, 0);
return aid;
2011-10-12 17:25:01 +02:00
}
// FIELD: cape
private String cape;
public String getCape() { return cape; }
public void setCape(String val) { this.cape = val; SpoutFeatures.updateCape(this, null); }
// FIELD: powerBoost
// special increase/decrease to default and max power for this faction
private double powerBoost;
public double getPowerBoost() { return this.powerBoost; }
public void setPowerBoost(double powerBoost) { this.powerBoost = powerBoost; }
2011-10-23 20:50:49 +02:00
// FIELDS: Flag management
// TODO: This will save... defaults if they where changed to...
private Map<FFlag, Boolean> flagOverrides; // Contains the modifications to the default values
public boolean getFlag(FFlag flag)
2011-10-23 20:50:49 +02:00
{
Boolean ret = this.flagOverrides.get(flag);
if (ret == null) ret = flag.getDefault();
return ret;
}
public void setFlag(FFlag flag, boolean value)
2011-10-23 20:50:49 +02:00
{
if (Conf.factionFlagDefaults.get(flag).equals(value))
2011-10-23 20:50:49 +02:00
{
this.flagOverrides.remove(flag);
return;
}
this.flagOverrides.put(flag, value);
}
2011-10-23 20:50:49 +02:00
// FIELDS: Permission <-> Groups management
2011-10-24 01:37:51 +02:00
private Map<FPerm, Set<Rel>> permOverrides; // Contains the modifications to the default values
public Set<Rel> getPermittedRelations(FPerm perm)
{
Set<Rel> ret = this.permOverrides.get(perm);
if (ret == null) ret = perm.getDefault();
return ret;
}
2012-05-09 06:29:52 +02:00
/*
public void addPermittedRelation(FPerm perm, Rel rel)
{
Set<Rel> newPermittedRelations = EnumSet.noneOf(Rel.class);
newPermittedRelations.addAll(this.getPermittedRelations(perm));
newPermittedRelations.add(rel);
this.setPermittedRelations(perm, newPermittedRelations);
}
public void removePermittedRelation(FPerm perm, Rel rel)
{
Set<Rel> newPermittedRelations = EnumSet.noneOf(Rel.class);
newPermittedRelations.addAll(this.getPermittedRelations(perm));
newPermittedRelations.remove(rel);
this.setPermittedRelations(perm, newPermittedRelations);
2012-05-09 06:29:52 +02:00
}*/
public void setRelationPermitted(FPerm perm, Rel rel, boolean permitted)
{
Set<Rel> newPermittedRelations = EnumSet.noneOf(Rel.class);
newPermittedRelations.addAll(this.getPermittedRelations(perm));
if (permitted)
{
newPermittedRelations.add(rel);
}
else
{
newPermittedRelations.remove(rel);
}
this.setPermittedRelations(perm, newPermittedRelations);
}
public void setPermittedRelations(FPerm perm, Set<Rel> rels)
{
if (perm.getDefault().equals(rels))
{
this.permOverrides.remove(perm);
return;
}
this.permOverrides.put(perm, rels);
}
public void setPermittedRelations(FPerm perm, Rel... rels)
{
Set<Rel> temp = new HashSet<Rel>();
temp.addAll(Arrays.asList(rels));
this.setPermittedRelations(perm, temp);
}
2011-10-23 20:50:49 +02:00
2011-10-22 18:12:15 +02:00
// -------------------------------------------- //
// Construct
// -------------------------------------------- //
public Faction()
{
this.relationWish = new HashMap<String, Rel>();
this.invites = new HashSet<String>();
this.open = Conf.newFactionsDefaultOpen;
this.tag = "???";
this.description = "Default faction description :(";
this.money = 0.0;
this.powerBoost = 0.0;
this.flagOverrides = new LinkedHashMap<FFlag, Boolean>();
2011-10-24 01:37:51 +02:00
this.permOverrides = new LinkedHashMap<FPerm, Set<Rel>>();
New "peaceful" status for factions which can only be set by server admins/moderators. Members of peaceful factions cannot deal or receive PvP damage (unless in a war zone which has friendly fire enabled), cannot claim land from another faction and likewise can't have their land claimed, and cannot be considered as ally or enemy of any other faction. Faction admins and moderators of peaceful factions can enable/disable all explosions inside their faction's territory at will. The main purpose of this is to provide a way for more peaceful players who don't want to take part in faction wars (or just want to take a break from them) to still have fun on the server. It is also meant to allow groups of players to make protected buildings, monuments, grand constructions, and so forth without having to worry about another faction destroying them. New conf.json settings: "peacefulTerritoryDisablePVP" (default true) prevents PvP damage for anyone inside a peaceful faction's territory "peacefulTerritoryDisableMonsters" (default false) provides protection against monsters spawning or attacking inside a peaceful faction's territory "peacefulMembersDisablePowerLoss" (default true) which keeps members of peaceful factions from suffering power loss when they die. New commands: /f peaceful [faction tag] - toggle the indicated faction's "peaceful" status /f noboom - enable/disable explosions inside your faction's territory; only available to faction admin and faction moderators for peaceful factions New permission nodes: factions.setPeaceful - ability to use the /f peaceful command (admins) factions.peacefulExplosionToggle - ability to use /f noboom (everyone)
2011-08-05 10:50:47 +02:00
}
New "peaceful" status for factions which can only be set by server admins/moderators. Members of peaceful factions cannot deal or receive PvP damage (unless in a war zone which has friendly fire enabled), cannot claim land from another faction and likewise can't have their land claimed, and cannot be considered as ally or enemy of any other faction. Faction admins and moderators of peaceful factions can enable/disable all explosions inside their faction's territory at will. The main purpose of this is to provide a way for more peaceful players who don't want to take part in faction wars (or just want to take a break from them) to still have fun on the server. It is also meant to allow groups of players to make protected buildings, monuments, grand constructions, and so forth without having to worry about another faction destroying them. New conf.json settings: "peacefulTerritoryDisablePVP" (default true) prevents PvP damage for anyone inside a peaceful faction's territory "peacefulTerritoryDisableMonsters" (default false) provides protection against monsters spawning or attacking inside a peaceful faction's territory "peacefulMembersDisablePowerLoss" (default true) which keeps members of peaceful factions from suffering power loss when they die. New commands: /f peaceful [faction tag] - toggle the indicated faction's "peaceful" status /f noboom - enable/disable explosions inside your faction's territory; only available to faction admin and faction moderators for peaceful factions New permission nodes: factions.setPeaceful - ability to use the /f peaceful command (admins) factions.peacefulExplosionToggle - ability to use /f noboom (everyone)
2011-08-05 10:50:47 +02:00
2011-03-23 17:39:56 +01:00
// -------------------------------
// Understand the types
// -------------------------------
2011-10-23 20:50:49 +02:00
// TODO: These should be gone after the refactoring...
public boolean isNormal()
{
2011-10-23 22:08:57 +02:00
//return ! (this.isNone() || this.isSafeZone() || this.isWarZone());
return ! this.isNone();
2011-03-23 17:39:56 +01:00
}
public boolean isNone()
{
return this.getId().equals("0");
2011-03-23 17:39:56 +01:00
}
2011-03-22 17:20:21 +01:00
// -------------------------------
2011-10-22 17:42:13 +02:00
// Relation and relation colors
2011-03-22 17:20:21 +01:00
// -------------------------------
2011-10-12 17:25:01 +02:00
@Override
2011-10-24 11:07:06 +02:00
public String describeTo(RelationParticipator observer, boolean ucfirst)
2011-10-12 17:25:01 +02:00
{
2011-10-24 11:07:06 +02:00
return RelationUtil.describeThatToMe(this, observer, ucfirst);
2011-10-12 17:25:01 +02:00
}
@Override
2011-10-24 11:07:06 +02:00
public String describeTo(RelationParticipator observer)
2011-10-12 17:25:01 +02:00
{
2011-10-24 11:07:06 +02:00
return RelationUtil.describeThatToMe(this, observer);
2011-10-12 17:25:01 +02:00
}
@Override
2011-10-24 11:07:06 +02:00
public Rel getRelationTo(RelationParticipator observer)
2011-10-12 17:25:01 +02:00
{
2011-10-24 11:07:06 +02:00
return RelationUtil.getRelationOfThatToMe(this, observer);
2011-10-12 17:25:01 +02:00
}
@Override
2011-10-24 11:07:06 +02:00
public Rel getRelationTo(RelationParticipator observer, boolean ignorePeaceful)
2011-10-12 17:25:01 +02:00
{
2011-10-24 11:07:06 +02:00
return RelationUtil.getRelationOfThatToMe(this, observer, ignorePeaceful);
2011-10-12 17:25:01 +02:00
}
@Override
2011-10-24 11:07:06 +02:00
public ChatColor getColorTo(RelationParticipator observer)
2011-10-12 17:25:01 +02:00
{
2011-10-24 11:07:06 +02:00
return RelationUtil.getColorOfThatToMe(this, observer);
2011-10-12 17:25:01 +02:00
}
public Rel getRelationWish(Faction otherFaction)
{
if (this.relationWish.containsKey(otherFaction.getId()))
{
2011-03-22 17:20:21 +01:00
return this.relationWish.get(otherFaction.getId());
}
return Rel.NEUTRAL;
2011-03-22 17:20:21 +01:00
}
public void setRelationWish(Faction otherFaction, Rel relation)
{
if (this.relationWish.containsKey(otherFaction.getId()) && relation.equals(Rel.NEUTRAL))
{
2011-03-22 17:20:21 +01:00
this.relationWish.remove(otherFaction.getId());
}
else
{
2011-03-22 17:20:21 +01:00
this.relationWish.put(otherFaction.getId(), relation);
}
}
2011-11-24 16:53:59 +01:00
public Map<Rel, List<String>> getFactionTagsPerRelation(RelationParticipator rp)
{
return getFactionTagsPerRelation(rp, false);
}
// onlyNonNeutral option provides substantial performance boost on large servers for listing only non-neutral factions
public Map<Rel, List<String>> getFactionTagsPerRelation(RelationParticipator rp, boolean onlyNonNeutral)
{
Map<Rel, List<String>> ret = new HashMap<Rel, List<String>>();
for (Rel rel : Rel.values())
{
ret.put(rel, new ArrayList<String>());
}
for (Faction faction : Factions.i.get())
{
Rel relation = faction.getRelationTo(this);
if (onlyNonNeutral && relation == Rel.NEUTRAL) continue;
2011-11-24 16:53:59 +01:00
ret.get(relation).add(faction.getTag(rp));
}
return ret;
}
2011-10-24 03:02:25 +02:00
// TODO: Implement a has enough feature.
2011-02-06 13:36:11 +01:00
//----------------------------------------------//
// Power
//----------------------------------------------//
public double getPower()
{
if (this.getFlag(FFlag.INFPOWER))
2011-10-22 18:12:15 +02:00
{
2011-10-23 20:50:49 +02:00
return 999999;
2011-10-22 18:12:15 +02:00
}
double ret = 0;
for (FPlayer fplayer : fplayers)
{
2011-03-23 12:00:38 +01:00
ret += fplayer.getPower();
2011-02-06 13:36:11 +01:00
}
if (Conf.powerFactionMax > 0 && ret > Conf.powerFactionMax)
{
ret = Conf.powerFactionMax;
}
return ret + this.powerBoost;
2011-02-06 13:36:11 +01:00
}
public double getPowerMax()
{
if (this.getFlag(FFlag.INFPOWER))
2011-10-22 18:12:15 +02:00
{
2011-10-23 20:50:49 +02:00
return 999999;
2011-10-22 18:12:15 +02:00
}
double ret = 0;
for (FPlayer fplayer : fplayers)
{
2011-03-23 12:00:38 +01:00
ret += fplayer.getPowerMax();
2011-02-06 13:36:11 +01:00
}
if (Conf.powerFactionMax > 0 && ret > Conf.powerFactionMax)
{
ret = Conf.powerFactionMax;
}
return ret + this.powerBoost;
2011-02-06 13:36:11 +01:00
}
public int getPowerRounded()
{
2011-02-06 13:36:11 +01:00
return (int) Math.round(this.getPower());
}
public int getPowerMaxRounded()
{
2011-02-06 13:36:11 +01:00
return (int) Math.round(this.getPowerMax());
}
public int getLandRounded() {
2011-03-22 17:20:21 +01:00
return Board.getFactionCoordCount(this);
2011-02-06 13:36:11 +01:00
}
public int getLandRoundedInWorld(String worldName)
{
return Board.getFactionCoordCountInWorld(this, worldName);
}
public boolean hasLandInflation()
{
return this.getLandRounded() > this.getPowerRounded();
2011-02-06 13:36:11 +01:00
}
// -------------------------------
2011-10-22 17:42:13 +02:00
// FPlayers
2011-02-06 13:36:11 +01:00
// -------------------------------
// maintain the reference list of FPlayers in this faction
public void refreshFPlayers()
{
fplayers.clear();
if (this.isNone()) return;
for (FPlayer fplayer : FPlayers.i.get())
{
if (fplayer.getFaction() == this)
{
fplayers.add(fplayer);
2011-02-06 13:36:11 +01:00
}
}
}
protected boolean addFPlayer(FPlayer fplayer)
{
if (this.isNone()) return false;
return fplayers.add(fplayer);
}
protected boolean removeFPlayer(FPlayer fplayer)
{
if (this.isNone()) return false;
return fplayers.remove(fplayer);
}
public Set<FPlayer> getFPlayers()
{
// return a shallow copy of the FPlayer list, to prevent tampering and concurrency issues
Set<FPlayer> ret = new HashSet<FPlayer>(fplayers);
2011-02-06 13:36:11 +01:00
return ret;
}
public Set<FPlayer> getFPlayersWhereOnline(boolean online)
{
Set<FPlayer> ret = new HashSet<FPlayer>();
for (FPlayer fplayer : fplayers)
{
if (fplayer.isOnline() == online)
{
2011-03-22 17:20:21 +01:00
ret.add(fplayer);
2011-02-06 13:36:11 +01:00
}
}
2011-02-06 13:36:11 +01:00
return ret;
}
2011-10-23 17:55:53 +02:00
public FPlayer getFPlayerLeader()
{
//if ( ! this.isNormal()) return null;
for (FPlayer fplayer : fplayers)
{
if (fplayer.getRole() == Rel.LEADER)
{
return fplayer;
}
}
return null;
}
public ArrayList<FPlayer> getFPlayersWhereRole(Rel role)
2011-10-22 17:42:13 +02:00
{
2011-03-18 17:33:23 +01:00
ArrayList<FPlayer> ret = new ArrayList<FPlayer>();
//if ( ! this.isNormal()) return ret;
2011-02-06 13:36:11 +01:00
for (FPlayer fplayer : fplayers)
2011-10-22 17:42:13 +02:00
{
if (fplayer.getRole() == role)
2011-10-22 17:42:13 +02:00
{
2011-03-22 17:20:21 +01:00
ret.add(fplayer);
2011-02-06 13:36:11 +01:00
}
}
return ret;
}
public ArrayList<Player> getOnlinePlayers()
{
2011-02-06 13:36:11 +01:00
ArrayList<Player> ret = new ArrayList<Player>();
2011-10-23 22:08:57 +02:00
//if (this.isPlayerFreeType()) return ret;
for (Player player: P.p.getServer().getOnlinePlayers())
{
FPlayer fplayer = FPlayers.i.get(player);
if (fplayer.getFaction() == this)
{
2011-02-06 13:36:11 +01:00
ret.add(player);
}
}
2011-02-06 13:36:11 +01:00
return ret;
}
// used when current leader is about to be removed from the faction; promotes new leader, or disbands faction if no other members left
public void promoteNewLeader()
{
if (! this.isNormal()) return;
if (this.getFlag(FFlag.PERMANENT) && Conf.permanentFactionsDisableLeaderPromotion) return;
FPlayer oldLeader = this.getFPlayerLeader();
// get list of officers, or list of normal members if there are no officers
ArrayList<FPlayer> replacements = this.getFPlayersWhereRole(Rel.OFFICER);
if (replacements == null || replacements.isEmpty())
replacements = this.getFPlayersWhereRole(Rel.MEMBER);
if (replacements == null || replacements.isEmpty())
{ // faction leader is the only member; one-man faction
if (this.getFlag(FFlag.PERMANENT))
{
if (oldLeader != null)
oldLeader.setRole(Rel.MEMBER);
return;
}
// no members left and faction isn't permanent, so disband it
if (Conf.logFactionDisband)
P.p.log("The faction "+this.getTag()+" ("+this.getId()+") has been disbanded since it has no members left.");
for (FPlayer fplayer : FPlayers.i.getOnline())
{
fplayer.msg("The faction %s<i> was disbanded.", this.getTag(fplayer));
}
this.detach();
}
else
{ // promote new faction leader
if (oldLeader != null)
oldLeader.setRole(Rel.MEMBER);
replacements.get(0).setRole(Rel.LEADER);
this.msg("<i>Faction leader <h>%s<i> has been removed. %s<i> has been promoted as the new faction leader.", oldLeader == null ? "" : oldLeader.getName(), replacements.get(0).getName());
P.p.log("Faction "+this.getTag()+" ("+this.getId()+") leader was removed. Replacement leader: "+replacements.get(0).getName());
}
}
2011-02-06 13:36:11 +01:00
//----------------------------------------------//
2011-03-22 17:20:21 +01:00
// Messages
2011-02-06 13:36:11 +01:00
//----------------------------------------------//
2011-10-10 13:40:24 +02:00
public void msg(String message, Object... args)
{
message = P.p.txt.parse(message, args);
for (FPlayer fplayer : this.getFPlayersWhereOnline(true))
{
fplayer.sendMessage(message);
}
}
public void sendMessage(String message)
{
for (FPlayer fplayer : this.getFPlayersWhereOnline(true))
{
2011-03-22 17:20:21 +01:00
fplayer.sendMessage(message);
2011-02-06 13:36:11 +01:00
}
}
public void sendMessage(List<String> messages)
{
for (FPlayer fplayer : this.getFPlayersWhereOnline(true))
{
2011-03-22 17:20:21 +01:00
fplayer.sendMessage(messages);
2011-02-06 13:36:11 +01:00
}
}
2011-11-27 23:13:43 +01:00
//----------------------------------------------//
// Deprecated
//----------------------------------------------//
/**
* @deprecated As of release 1.7, replaced by {@link #getFPlayerLeader()}
*/
public FPlayer getFPlayerAdmin()
{
return getFPlayerLeader();
}
/**
* @deprecated As of release 1.7, replaced by {@link #getFlag()}
*/
public boolean isPeaceful()
{
return this.getFlag(FFlag.PEACEFUL);
}
/**
* @deprecated As of release 1.7, replaced by {@link #getFlag()}
*/
public boolean getPeacefulExplosionsEnabled()
{
return this.getFlag(FFlag.EXPLOSIONS);
}
/**
* @deprecated As of release 1.7, replaced by {@link #getFlag()}
*/
public boolean noExplosionsInTerritory()
{
return ! this.getFlag(FFlag.EXPLOSIONS);
}
/**
* @deprecated As of release 1.7, replaced by {@link #getFlag()}
*/
public boolean isSafeZone()
{
return ! this.getFlag(FFlag.EXPLOSIONS);
}
2011-02-06 13:36:11 +01:00
//----------------------------------------------//
// Persistance and entity management
//----------------------------------------------//
2011-03-18 17:33:23 +01:00
@Override
public void postDetach()
{
2011-10-12 18:48:47 +02:00
if (Econ.shouldBeUsed())
{
Econ.setBalance(getAccountId(), 0);
2011-10-12 18:48:47 +02:00
}
// Clean the board
Board.clean();
// Clean the fplayers
FPlayers.i.clean();
2011-03-18 17:33:23 +01:00
}
2011-02-06 13:36:11 +01:00
}