Reorganizes Project (#41)

Projects/Scripts/Engines/Factions/Items/Traps/BaseFactionTrap.cs

@@ -0,0 +1,264 @@
+using System;
+using Server.Items;
+using Server.Network;
+
+namespace Server.Factions
+{
+  public enum AllowedPlacing
+  {
+    Everywhere,
+
+    AnyFactionTown,
+    ControlledFactionTown,
+    FactionStronghold
+  }
+
+  public abstract class BaseFactionTrap : BaseTrap
+  {
+    private Timer m_Concealing;
+
+    public BaseFactionTrap(Faction f, Mobile m, int itemID) : base(itemID)
+    {
+      Visible = false;
+
+      Faction = f;
+      TimeOfPlacement = DateTime.UtcNow;
+      Placer = m;
+    }
+
+    public BaseFactionTrap(Serial serial) : base(serial)
+    {
+    }
+
+    [CommandProperty(AccessLevel.GameMaster)]
+    public Faction Faction{ get; set; }
+
+    [CommandProperty(AccessLevel.GameMaster)]
+    public Mobile Placer{ get; set; }
+
+    [CommandProperty(AccessLevel.GameMaster)]
+    public DateTime TimeOfPlacement{ get; set; }
+
+    public virtual int EffectSound => 0;
+
+    public virtual int SilverFromDisarm => 100;
+
+    public virtual int MessageHue => 0;
+
+    public virtual int AttackMessage => 0;
+    public virtual int DisarmMessage => 0;
+
+    public virtual AllowedPlacing AllowedPlacing => AllowedPlacing.Everywhere;
+
+    public virtual TimeSpan ConcealPeriod => TimeSpan.FromMinutes(1.0);
+
+    public virtual TimeSpan DecayPeriod
+    {
+      get
+      {
+        if (Core.AOS)
+          return TimeSpan.FromDays(1.0);
+
+        return TimeSpan.MaxValue; // no decay
+      }
+    }
+
+    public override void OnTrigger(Mobile from)
+    {
+      if (!IsEnemy(from))
+        return;
+
+      Conceal();
+
+      DoVisibleEffect();
+      Effects.PlaySound(Location, Map, EffectSound);
+      DoAttackEffect(from);
+
+      int silverToAward = from.Alive ? 20 : 40;
+
+      if (silverToAward > 0 && Placer != null && Faction != null)
+      {
+        PlayerState victimState = PlayerState.Find(from);
+
+        if (victimState?.CanGiveSilverTo(Placer) == true && victimState.KillPoints > 0)
+        {
+          int silverGiven = Faction.AwardSilver(Placer, silverToAward);
+
+          if (silverGiven > 0)
+          {
+            // TODO: Get real message
+            if (from.Alive)
+              Placer.SendMessage("You have earned {0} silver pieces because {1} fell for your trap.",
+                silverGiven, from.Name);
+            else
+              Placer.SendLocalizedMessage(1042736,
+                $"{silverGiven} silver\t{from.Name}"); // You have earned ~1_SILVER_AMOUNT~ pieces for vanquishing ~2_PLAYER_NAME~!
+          }
+
+          victimState.OnGivenSilverTo(Placer);
+        }
+      }
+
+      from.LocalOverheadMessage(MessageType.Regular, MessageHue, AttackMessage);
+    }
+
+    public abstract void DoVisibleEffect();
+    public abstract void DoAttackEffect(Mobile m);
+
+    public virtual int IsValidLocation()
+    {
+      return IsValidLocation(GetWorldLocation(), Map);
+    }
+
+    public virtual int IsValidLocation(Point3D p, Map m)
+    {
+      if (m == null)
+        return 502956; // You cannot place a trap on that.
+
+      if (Core.ML)
+        foreach (Item item in m.GetItemsInRange(p, 0))
+          if (item is BaseFactionTrap trap && trap.Faction == Faction)
+            return 1075263; // There is already a trap belonging to your faction at this location.;
+
+      switch (AllowedPlacing)
+      {
+        case AllowedPlacing.FactionStronghold:
+        {
+          StrongholdRegion region = Region.Find(p, m).GetRegion<StrongholdRegion>();
+
+          if (region != null && region.Faction == Faction)
+            return 0;
+
+          return 1010355; // This trap can only be placed in your stronghold
+        }
+        case AllowedPlacing.AnyFactionTown:
+        {
+          Town town = Town.FromRegion(Region.Find(p, m));
+
+          if (town != null)
+            return 0;
+
+          return 1010356; // This trap can only be placed in a faction town
+        }
+        case AllowedPlacing.ControlledFactionTown:
+        {
+          Town town = Town.FromRegion(Region.Find(p, m));
+
+          if (town != null && town.Owner == Faction)
+            return 0;
+
+          return 1010357; // This trap can only be placed in a town your faction controls
+        }
+      }
+
+      return 0;
+    }
+
+    public override void OnMovement(Mobile m, Point3D oldLocation)
+    {
+      base.OnMovement(m, oldLocation);
+
+      if (!CheckDecay() && CheckRange(m.Location, oldLocation, 6))
+        if (Faction.Find(m) != null &&
+            (m.Skills.DetectHidden.Value - 80.0) / 20.0 > Utility.RandomDouble())
+          PrivateOverheadLocalizedMessage(m, 1010154, MessageHue, "", ""); // [Faction Trap]
+    }
+
+    public void PrivateOverheadLocalizedMessage(Mobile to, int number, int hue, string name, string args)
+    {
+      NetState ns = to?.NetState;
+
+      ns?.Send(new MessageLocalized(Serial, ItemID, MessageType.Regular, hue, 3, number, name, args));
+    }
+
+    public virtual bool CheckDecay()
+    {
+      TimeSpan decayPeriod = DecayPeriod;
+
+      if (decayPeriod == TimeSpan.MaxValue)
+        return false;
+
+      if (TimeOfPlacement + decayPeriod < DateTime.UtcNow)
+      {
+        Timer.DelayCall(TimeSpan.Zero, Delete);
+        return true;
+      }
+
+      return false;
+    }
+
+    public virtual void BeginConceal()
+    {
+      m_Concealing?.Stop();
+
+      m_Concealing = Timer.DelayCall(ConcealPeriod, Conceal);
+    }
+
+    public virtual void Conceal()
+    {
+      m_Concealing?.Stop();
+
+      m_Concealing = null;
+
+      if (!Deleted)
+        Visible = false;
+    }
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+
+      Faction.WriteReference(writer, Faction);
+      writer.Write(Placer);
+      writer.Write(TimeOfPlacement);
+
+      if (Visible)
+        BeginConceal();
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+
+      int version = reader.ReadInt();
+
+      Faction = Faction.ReadReference(reader);
+      Placer = reader.ReadMobile();
+      TimeOfPlacement = reader.ReadDateTime();
+
+      if (Visible)
+        BeginConceal();
+
+      CheckDecay();
+    }
+
+    public override void OnDelete()
+    {
+      if (Faction?.Traps.Contains(this) == true)
+        Faction.Traps.Remove(this);
+
+      base.OnDelete();
+    }
+
+    public virtual bool IsEnemy(Mobile mob)
+    {
+      if (mob.Hidden && mob.AccessLevel > AccessLevel.Player)
+        return false;
+
+      if (!mob.Alive || mob.IsDeadBondedPet)
+        return false;
+
+      Faction faction = Faction.Find(mob, true);
+
+      if (faction == null && mob is BaseFactionGuard guard)
+        faction = guard.Faction;
+
+      if (faction == null)
+        return false;
+
+      return faction != Faction;
+    }
+  }
+}

Projects/Scripts/Engines/Factions/Items/Traps/BaseFactionTrapDeed.cs

@@ -0,0 +1,119 @@
+using System;
+using Server.Engines.Craft;
+using Server.Items;
+
+namespace Server.Factions
+{
+  public abstract class BaseFactionTrapDeed : Item, ICraftable
+  {
+    private Faction m_Faction;
+
+    public BaseFactionTrapDeed(int itemID= 0x14F0) : base(itemID)
+    {
+      Weight = 1.0;
+      LootType = LootType.Blessed;
+    }
+
+    public BaseFactionTrapDeed(Serial serial) : base(serial)
+    {
+    }
+
+    public abstract Type TrapType{ get; }
+
+    [CommandProperty(AccessLevel.GameMaster)]
+    public Faction Faction
+    {
+      get => m_Faction;
+      set
+      {
+        m_Faction = value;
+
+        if (m_Faction != null)
+          Hue = m_Faction.Definition.HuePrimary;
+      }
+    }
+
+    #region ICraftable Members
+
+    public int OnCraft(int quality, bool makersMark, Mobile from, CraftSystem craftSystem, Type typeRes, BaseTool tool,
+      CraftItem craftItem, int resHue)
+    {
+      ItemID = 0x14F0;
+      Faction = Faction.Find(from);
+
+      return 1;
+    }
+
+    #endregion
+
+    public virtual BaseFactionTrap Construct(Mobile from)
+    {
+      try
+      {
+        return Activator.CreateInstance(TrapType, m_Faction, from) as BaseFactionTrap;
+      }
+      catch
+      {
+        return null;
+      }
+    }
+
+    public override void OnDoubleClick(Mobile from)
+    {
+      Faction faction = Faction.Find(from);
+
+      if (faction == null)
+      {
+        from.SendLocalizedMessage(1010353, "", 0x23); // Only faction members may place faction traps
+      }
+      else if (faction != m_Faction)
+      {
+        from.SendLocalizedMessage(1010354, "", 0x23); // You may only place faction traps created by your faction
+      }
+      else if (faction.Traps.Count >= faction.MaximumTraps)
+      {
+        from.SendLocalizedMessage(1010358, "", 0x23); // Your faction already has the maximum number of traps placed
+      }
+      else
+      {
+        BaseFactionTrap trap = Construct(from);
+
+        if (trap == null)
+          return;
+
+        int message = trap.IsValidLocation(from.Location, from.Map);
+
+        if (message > 0)
+        {
+          from.SendLocalizedMessage(message, "", 0x23);
+          trap.Delete();
+        }
+        else
+        {
+          from.SendLocalizedMessage(1010360); // You arm the trap and carefully hide it from view
+          trap.MoveToWorld(from.Location, from.Map);
+          faction.Traps.Add(trap);
+          Delete();
+        }
+      }
+    }
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+
+      Faction.WriteReference(writer, m_Faction);
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+
+      int version = reader.ReadInt();
+
+      m_Faction = Faction.ReadReference(reader);
+    }
+  }
+}

Projects/Scripts/Engines/Factions/Items/Traps/FactionExplosionTrap.cs

@@ -0,0 +1,75 @@
+using System;
+
+namespace Server.Factions
+{
+  public class FactionExplosionTrap : BaseFactionTrap
+  {
+    public FactionExplosionTrap(Faction f = null, Mobile m = null) : base(f, m, 0x11C1)
+    {
+    }
+
+    public FactionExplosionTrap(Serial serial) : base(serial)
+    {
+    }
+
+    public override int LabelNumber => 1044599; // faction explosion trap
+
+    public override int AttackMessage => 1010543; // You are enveloped in an explosion of fire!
+    public override int DisarmMessage => 1010539; // You carefully remove the pressure trigger and disable the trap.
+    public override int EffectSound => 0x307;
+    public override int MessageHue => 0x78;
+
+    public override AllowedPlacing AllowedPlacing => AllowedPlacing.AnyFactionTown;
+
+    public override void DoVisibleEffect()
+    {
+      Effects.SendLocationEffect(GetWorldLocation(), Map, 0x36BD, 15, 10);
+    }
+
+    public override void DoAttackEffect(Mobile m)
+    {
+      m.Damage(Utility.Dice(6, 10, 40), m);
+    }
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+
+      int version = reader.ReadInt();
+    }
+  }
+
+  public class FactionExplosionTrapDeed : BaseFactionTrapDeed
+  {
+    public FactionExplosionTrapDeed() : base(0x36D2)
+    {
+    }
+
+    public FactionExplosionTrapDeed(Serial serial) : base(serial)
+    {
+    }
+
+    public override Type TrapType => typeof(FactionExplosionTrap);
+    public override int LabelNumber => 1044603; // faction explosion trap deed
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+      int version = reader.ReadInt();
+    }
+  }
+}

Projects/Scripts/Engines/Factions/Items/Traps/FactionGasTrap.cs

@@ -0,0 +1,75 @@
+using System;
+
+namespace Server.Factions
+{
+  public class FactionGasTrap : BaseFactionTrap
+  {
+    public FactionGasTrap(Faction f = null, Mobile m = null) : base(f, m, 0x113C)
+    {
+    }
+
+    public FactionGasTrap(Serial serial) : base(serial)
+    {
+    }
+
+    public override int LabelNumber => 1044598; // faction gas trap
+
+    public override int AttackMessage => 1010542; // A noxious green cloud of poison gas envelops you!
+    public override int DisarmMessage => 502376; // The poison leaks harmlessly away due to your deft touch.
+    public override int EffectSound => 0x230;
+    public override int MessageHue => 0x44;
+
+    public override AllowedPlacing AllowedPlacing => AllowedPlacing.FactionStronghold;
+
+    public override void DoVisibleEffect()
+    {
+      Effects.SendLocationEffect(Location, Map, 0x3709, 28, 10, 0x1D3, 5);
+    }
+
+    public override void DoAttackEffect(Mobile m)
+    {
+      m.ApplyPoison(m, Poison.Lethal);
+    }
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+
+      int version = reader.ReadInt();
+    }
+  }
+
+  public class FactionGasTrapDeed : BaseFactionTrapDeed
+  {
+    public FactionGasTrapDeed() : base(0x11AB)
+    {
+    }
+
+    public FactionGasTrapDeed(Serial serial) : base(serial)
+    {
+    }
+
+    public override Type TrapType => typeof(FactionGasTrap);
+    public override int LabelNumber => 1044602; // faction gas trap deed
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+      int version = reader.ReadInt();
+    }
+  }
+}

Projects/Scripts/Engines/Factions/Items/Traps/FactionSawTrap.cs

@@ -0,0 +1,71 @@
+using System;
+
+namespace Server.Factions
+{
+  public class FactionSawTrap : BaseFactionTrap
+  {
+    public FactionSawTrap(Faction f = null, Mobile m = null) : base(f, m, 0x11AC)
+    {
+    }
+
+    public override int LabelNumber => 1041047; // faction saw trap
+
+    public override int AttackMessage => 1010544; // The blade cuts deep into your skin!
+    public override int DisarmMessage => 1010540; // You carefully dismantle the saw mechanism and disable the trap.
+    public override int EffectSound => 0x218;
+    public override int MessageHue => 0x5A;
+
+    public override AllowedPlacing AllowedPlacing => AllowedPlacing.ControlledFactionTown;
+
+    public override void DoVisibleEffect()
+    {
+      Effects.SendLocationEffect(Location, Map, 0x11AD, 25, 10);
+    }
+
+    public override void DoAttackEffect(Mobile m)
+    {
+      m.Damage(Utility.Dice(6, 10, 40), m);
+    }
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+
+      int version = reader.ReadInt();
+    }
+  }
+
+  public class FactionSawTrapDeed : BaseFactionTrapDeed
+  {
+    public FactionSawTrapDeed() : base(0x1107)
+    {
+    }
+
+    public FactionSawTrapDeed(Serial serial) : base(serial)
+    {
+    }
+
+    public override Type TrapType => typeof(FactionSawTrap);
+    public override int LabelNumber => 1044604; // faction saw trap deed
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+      int version = reader.ReadInt();
+    }
+  }
+}

Projects/Scripts/Engines/Factions/Items/Traps/FactionSpikeTrap.cs

@@ -0,0 +1,78 @@
+using System;
+
+namespace Server.Factions
+{
+  public class FactionSpikeTrap : BaseFactionTrap
+  {
+    public FactionSpikeTrap(Faction f = null, Mobile m = null) : base(f, m, 0x11A0)
+    {
+    }
+
+    public FactionSpikeTrap(Serial serial) : base(serial)
+    {
+    }
+
+    public override int LabelNumber => 1044601; // faction spike trap
+
+    public override int AttackMessage => 1010545; // Large spikes in the ground spring up piercing your skin!
+
+    public override int DisarmMessage =>
+      1010541; // You carefully dismantle the trigger on the spikes and disable the trap.
+
+    public override int EffectSound => 0x22E;
+    public override int MessageHue => 0x5A;
+
+    public override AllowedPlacing AllowedPlacing => AllowedPlacing.ControlledFactionTown;
+
+    public override void DoVisibleEffect()
+    {
+      Effects.SendLocationEffect(Location, Map, 0x11A4, 12, 6);
+    }
+
+    public override void DoAttackEffect(Mobile m)
+    {
+      m.Damage(Utility.Dice(6, 10, 40), m);
+    }
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+
+      int version = reader.ReadInt();
+    }
+  }
+
+  public class FactionSpikeTrapDeed : BaseFactionTrapDeed
+  {
+    public FactionSpikeTrapDeed() : base(0x11A5)
+    {
+    }
+
+    public FactionSpikeTrapDeed(Serial serial) : base(serial)
+    {
+    }
+
+    public override Type TrapType => typeof(FactionSpikeTrap);
+    public override int LabelNumber => 1044605; // faction spike trap deed
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(0); // version
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+      int version = reader.ReadInt();
+    }
+  }
+}

Projects/Scripts/Engines/Factions/Items/Traps/FactionTrapRemovalKit.cs

@@ -0,0 +1,71 @@
+namespace Server.Factions
+{
+  public class FactionTrapRemovalKit : Item
+  {
+    [Constructible]
+    public FactionTrapRemovalKit() : base(7867)
+    {
+      LootType = LootType.Blessed;
+      Charges = 25;
+    }
+
+    public FactionTrapRemovalKit(Serial serial) : base(serial)
+    {
+    }
+
+    [CommandProperty(AccessLevel.GameMaster)]
+    public int Charges{ get; set; }
+
+    public override int LabelNumber => 1041508; // a faction trap removal kit
+
+    public void ConsumeCharge(Mobile consumer)
+    {
+      --Charges;
+
+      if (Charges <= 0)
+      {
+        Delete();
+
+        consumer?.SendLocalizedMessage(1042531); // You have used all of the parts in your trap removal kit.
+      }
+    }
+
+    public override void GetProperties(ObjectPropertyList list)
+    {
+      base.GetProperties(list);
+
+      // NOTE: OSI does not list uses remaining; intentional difference
+      list.Add(1060584, Charges.ToString()); // uses remaining: ~1_val~
+    }
+
+    public override void Serialize(GenericWriter writer)
+    {
+      base.Serialize(writer);
+
+      writer.Write(1); // version
+
+      writer.WriteEncodedInt(Charges);
+    }
+
+    public override void Deserialize(GenericReader reader)
+    {
+      base.Deserialize(reader);
+
+      int version = reader.ReadInt();
+
+      switch (version)
+      {
+        case 1:
+        {
+          Charges = reader.ReadEncodedInt();
+          break;
+        }
+        case 0:
+        {
+          Charges = 25;
+          break;
+        }
+      }
+    }
+  }
+}