fix: Converts ethics system to generic entity persistence (#1824)

### Summary

Converts ethics system to entity persistence and removes the persistence item.


### TODO

1. The enable/disable toggle doesn't propagate to all code that does Ethics checks (notoriety, pvp, etc).
2. We need commands to remove them from an ethic.
This commit is contained in:
Kamron Batman 2024-06-16 10:26:09 -07:00 • committed by GitHub
parent f87c8f73ab
commit 20596e52fa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 1327 additions and 1338 deletions

View file

@ -1,288 +1,293 @@
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Ethics.Evil;
using Server.Ethics.Hero;
using Server.Items;
using Server.Mobiles;
namespace Server.Ethics
namespace Server.Ethics;
[SerializationGenerator(1)]
public abstract partial class Ethic : EthicsEntity
{
public abstract class Ethic
public static Ethic Hero { get; private set; }
public static Ethic Evil { get; private set; }
public static readonly Ethic[] Ethics =
{
public static readonly Ethic Hero = new HeroEthic();
public static readonly Ethic Evil = new EvilEthic();
Hero,
Evil
};
public static readonly Ethic[] Ethics =
public static bool RegisterEthic(Ethic ethic)
{
if (ethic is HeroEthic)
{
Hero,
Evil
};
protected EthicDefinition m_Definition;
protected PlayerCollection m_Players;
public Ethic() => m_Players = new PlayerCollection();
public static bool Enabled { get; private set; }
public EthicDefinition Definition => m_Definition;
public PlayerCollection Players => m_Players;
public static Ethic Find(Item item)
{
if ((item.SavedFlags & 0x100) != 0)
{
if (item.Hue == Hero.Definition.PrimaryHue)
{
return Hero;
}
item.SavedFlags &= ~0x100;
}
if ((item.SavedFlags & 0x200) != 0)
{
if (item.Hue == Evil.Definition.PrimaryHue)
{
return Evil;
}
item.SavedFlags &= ~0x200;
}
return null;
}
public static bool CheckTrade(Mobile from, Mobile to, Mobile newOwner, Item item)
{
var itemEthic = Find(item);
if (itemEthic == null || Find(newOwner) == itemEthic)
if (Hero == null)
{
Hero = ethic;
return true;
}
if (itemEthic == Hero)
{
(from == newOwner ? to : from).SendMessage("Only heros may receive this item.");
}
else if (itemEthic == Evil)
{
(from == newOwner ? to : from).SendMessage("Only the evil may receive this item.");
}
return false;
}
public static bool CheckEquip(Mobile from, Item item)
if (ethic is EvilEthic)
{
var itemEthic = Find(item);
if (itemEthic == null || Find(from) == itemEthic)
if (Evil == null)
{
Evil = ethic;
return true;
}
if (itemEthic == Hero)
{
from.SendMessage("Only heros may wear this item.");
}
else if (itemEthic == Evil)
{
from.SendMessage("Only the evil may wear this item.");
}
return false;
}
public static bool IsImbued(Item item) => IsImbued(item, false);
return false;
}
public static bool IsImbued(Item item, bool recurse)
public Ethic() => Players = [];
public static bool Enabled { get; private set; }
public virtual EthicDefinition Definition { get; }
public List<Player> Players { get; protected set; }
public static Ethic Find(Item item)
{
if ((item.SavedFlags & 0x100) != 0)
{
if (Find(item) != null)
if (item.Hue == Hero.Definition.PrimaryHue)
{
return true;
return Hero;
}
if (recurse)
item.SavedFlags &= ~0x100;
}
if ((item.SavedFlags & 0x200) != 0)
{
if (item.Hue == Evil.Definition.PrimaryHue)
{
foreach (var child in item.Items)
return Evil;
}
item.SavedFlags &= ~0x200;
}
return null;
}
public static bool CheckTrade(Mobile from, Mobile to, Mobile newOwner, Item item)
{
var itemEthic = Find(item);
if (itemEthic == null || Find(newOwner) == itemEthic)
{
return true;
}
if (itemEthic == Hero)
{
(from == newOwner ? to : from).SendMessage("Only heroes may receive this item.");
}
else if (itemEthic == Evil)
{
(from == newOwner ? to : from).SendMessage("Only the evil may receive this item.");
}
return false;
}
public static bool CheckEquip(Mobile from, Item item)
{
var itemEthic = Find(item);
if (itemEthic == null || Find(from) == itemEthic)
{
return true;
}
if (itemEthic == Hero)
{
from.SendMessage("Only heroes may wear this item.");
}
else if (itemEthic == Evil)
{
from.SendMessage("Only the evil may wear this item.");
}
return false;
}
public static bool IsImbued(Item item) => IsImbued(item, false);
public static bool IsImbued(Item item, bool recurse)
{
if (Find(item) != null)
{
return true;
}
if (recurse)
{
foreach (var child in item.Items)
{
if (IsImbued(child, true))
{
if (IsImbued(child, true))
return true;
}
}
}
return false;
}
public static void Configure()
{
Enabled = ServerConfiguration.GetOrUpdateSetting("ethics.enable", false);
}
public static void Initialize()
{
if (Enabled)
{
EventSink.Speech += EventSink_Speech;
}
}
public static void EventSink_Speech(SpeechEventArgs e)
{
if (e.Blocked || e.Handled)
{
return;
}
var pl = Player.Find(e.Mobile);
if (pl == null)
{
for (var i = 0; i < Ethics.Length; ++i)
{
var ethic = Ethics[i];
if (!ethic.IsEligible(e.Mobile))
{
continue;
}
if (!ethic.Definition.JoinPhrase.String.InsensitiveEquals(e.Speech))
{
continue;
}
var found = false;
foreach (var item in e.Mobile.GetItemsInRange(2))
{
if (item is AnkhNorth or AnkhWest)
{
return true;
found = true;
break;
}
}
}
return false;
}
if (!found)
{
continue;
}
public static void Configure()
{
Enabled = ServerConfiguration.GetOrUpdateSetting("ethics.enable", false);
}
pl = new Player(ethic, e.Mobile);
public static void Initialize()
{
if (Enabled)
{
EventSink.Speech += EventSink_Speech;
pl.Attach();
e.Mobile.FixedEffect(0x373A, 10, 30);
e.Mobile.PlaySound(0x209);
e.Handled = true;
break;
}
}
public static void EventSink_Speech(SpeechEventArgs e)
else
{
if (e.Blocked || e.Handled)
if (e.Mobile is PlayerMobile mobile && mobile.DuelContext != null)
{
return;
}
var pl = Player.Find(e.Mobile);
var ethic = pl.Ethic;
if (pl == null)
for (var i = 0; i < ethic.Definition.Powers.Length; ++i)
{
for (var i = 0; i < Ethics.Length; ++i)
var power = ethic.Definition.Powers[i];
if (!power.Definition.Phrase.String.InsensitiveEquals(e.Speech))
{
var ethic = Ethics[i];
if (!ethic.IsEligible(e.Mobile))
{
continue;
}
if (!ethic.Definition.JoinPhrase.String.InsensitiveEquals(e.Speech))
{
continue;
}
var found = false;
foreach (var item in e.Mobile.GetItemsInRange(2))
{
if (item is AnkhNorth or AnkhWest)
{
found = true;
break;
}
}
if (!found)
{
continue;
}
pl = new Player(ethic, e.Mobile);
pl.Attach();
e.Mobile.FixedEffect(0x373A, 10, 30);
e.Mobile.PlaySound(0x209);
e.Handled = true;
break;
continue;
}
if (!power.CheckInvoke(pl))
{
continue;
}
power.BeginInvoke(pl);
e.Handled = true;
break;
}
else
}
}
public static Ethic Find(Mobile mob) => Find(mob, false, false);
public static Ethic Find(Mobile mob, bool inherit) => Find(mob, inherit, false);
public static Ethic Find(Mobile mob, bool inherit, bool allegiance)
{
var pl = Player.Find(mob);
if (pl != null)
{
return pl.Ethic;
}
if (inherit && mob is BaseCreature bc)
{
if (bc.Controlled)
{
if (e.Mobile is PlayerMobile mobile && mobile.DuelContext != null)
{
return;
}
return Find(bc.ControlMaster, false);
}
var ethic = pl.Ethic;
if (bc.Summoned)
{
return Find(bc.SummonMaster, false);
}
for (var i = 0; i < ethic.Definition.Powers.Length; ++i)
{
var power = ethic.Definition.Powers[i];
if (!power.Definition.Phrase.String.InsensitiveEquals(e.Speech))
{
continue;
}
if (!power.CheckInvoke(pl))
{
continue;
}
power.BeginInvoke(pl);
e.Handled = true;
break;
}
if (allegiance)
{
return bc.EthicAllegiance;
}
}
public static Ethic Find(Mobile mob) => Find(mob, false, false);
return null;
}
public static Ethic Find(Mobile mob, bool inherit) => Find(mob, inherit, false);
public abstract bool IsEligible(Mobile mob);
public static Ethic Find(Mobile mob, bool inherit, bool allegiance)
private void Deserialize(IGenericReader reader, int version)
{
var playerCount = reader.ReadEncodedInt();
for (var i = 0; i < playerCount; ++i)
{
var pl = Player.Find(mob);
var pl = new Player(this, null);
pl.Deserialize(reader);
if (pl != null)
if (pl.Mobile != null)
{
return pl.Ethic;
}
if (inherit && mob is BaseCreature bc)
{
if (bc.Controlled)
{
return Find(bc.ControlMaster, false);
}
if (bc.Summoned)
{
return Find(bc.SummonMaster, false);
}
if (allegiance)
{
return bc.EthicAllegiance;
}
}
return null;
}
public abstract bool IsEligible(Mobile mob);
public virtual void Deserialize(IGenericReader reader)
{
var version = reader.ReadEncodedInt();
switch (version)
{
case 0:
{
var playerCount = reader.ReadEncodedInt();
for (var i = 0; i < playerCount; ++i)
{
var pl = new Player(this, reader);
if (pl.Mobile != null)
{
Timer.StartTimer(pl.CheckAttach);
}
}
break;
}
}
}
public virtual void Serialize(IGenericWriter writer)
{
writer.WriteEncodedInt(0); // version
writer.WriteEncodedInt(m_Players.Count);
for (var i = 0; i < m_Players.Count; ++i)
{
m_Players[i].Serialize(writer);
Timer.StartTimer(pl.CheckAttach);
}
}
}

View file

@ -0,0 +1,26 @@
using System;
using ModernUO.Serialization;
namespace Server.Ethics;
[SerializationGenerator(0)]
public partial class EthicsEntity : ISerializable
{
public EthicsEntity()
{
Serial = EthicsSystem.NewProfile;
EthicsSystem.Add(this);
}
public DateTime Created { get; set; } = Core.Now;
public Serial Serial { get; }
public bool Deleted { get; private set; }
public void Delete()
{
Deleted = true;
EthicsSystem.Remove(this);
}
}

View file

@ -0,0 +1,59 @@
using System;
using Server.Ethics.Evil;
using Server.Ethics.Hero;
namespace Server.Ethics;
public class EthicsSystem : GenericEntityPersistence<EthicsEntity>
{
private static EthicsSystem _persistence;
public static void Configure()
{
_persistence = new EthicsSystem();
}
public EthicsSystem() : base("Ethics", 3, 0x1, 0x7FFFFFFF)
{
}
public static Serial NewProfile => _persistence.NewEntity;
public static void Add(EthicsEntity entity) => _persistence.AddEntity(entity);
public static void Remove(EthicsEntity entity) => _persistence.RemoveEntity(entity);
public static T Find<T>(Serial serial) where T : EthicsEntity => _persistence.FindEntity<T>(serial);
}
[ManualDirtyChecking]
[TypeAlias("Server.Ethics.EthicsPersistance")]
[Obsolete("Deprecated in favor of the static system. Only used for legacy deserialization")]
public class EthicsPersistence : Item
{
public EthicsPersistence()
{
Delete();
}
public EthicsPersistence(Serial serial) : base(serial)
{
}
public override void Serialize(IGenericWriter writer)
{
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var heroEthic = new HeroEthic();
heroEthic.Deserialize(reader);
var evilEthic = new EvilEthic();
evilEthic.Deserialize(reader);
Timer.DelayCall(Delete);
}
}

View file

@ -1,65 +0,0 @@
namespace Server.Ethics
{
public class EthicsPersistance : Item
{
[Constructible]
public EthicsPersistance()
: base(1)
{
Movable = false;
if (Instance?.Deleted != false)
{
Instance = this;
}
else
{
base.Delete();
}
}
public EthicsPersistance(Serial serial)
: base(serial) =>
Instance = this;
public static EthicsPersistance Instance { get; private set; }
public override string DefaultName => "Ethics Persistance - Internal";
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.Write(0); // version
for (var i = 0; i < Ethic.Ethics.Length; ++i)
{
Ethic.Ethics[i].Serialize(writer);
}
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = reader.ReadInt();
switch (version)
{
case 0:
{
for (var i = 0; i < Ethic.Ethics.Length; ++i)
{
Ethic.Ethics[i].Deserialize(reader);
}
break;
}
}
}
public override void Delete()
{
}
}
}

View file

@ -1,169 +1,141 @@
using System;
using System.Collections.ObjectModel;
using ModernUO.Serialization;
using Server.Mobiles;
namespace Server.Ethics
namespace Server.Ethics;
[PropertyObject]
[SerializationGenerator(1)]
public partial class Player : EthicsEntity
{
public class PlayerCollection : Collection<Player>
[SerializableField(0, setter: "private")]
private Mobile _mobile;
[SerializableField(1)]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private int _power;
[SerializableField(2)]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private int _history;
[SerializableField(3)]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private Mobile _steed;
[SerializableField(4)]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private Mobile _familiar;
[DeltaDateTime]
[SerializableField(5, setter: "private")]
private DateTime _shield;
[SerializableField(6, setter: "private")]
private Ethic _ethic;
public Player(Ethic ethic, Mobile mobile)
{
_ethic = ethic;
_mobile = mobile;
_power = 5;
_history = 5;
}
[PropertyObject]
public class Player
private void Deserialize(IGenericReader reader, int version)
{
private DateTime m_Shield;
// Don't call the base Deserialize
public Player(Ethic ethic, Mobile mobile)
_mobile = reader.ReadEntity<Mobile>();
_power = reader.ReadEncodedInt();
_history = reader.ReadEncodedInt();
_steed = reader.ReadEntity<Mobile>();
_familiar = reader.ReadEntity<Mobile>();
_shield = reader.ReadDeltaTime();
}
[CommandProperty(AccessLevel.GameMaster)]
public bool IsShielded
{
get
{
Ethic = ethic;
Mobile = mobile;
Power = 5;
History = 5;
}
public Player(Ethic ethic, IGenericReader reader)
{
Ethic = ethic;
var version = reader.ReadEncodedInt();
switch (version)
if (_shield == DateTime.MinValue)
{
case 0:
{
Mobile = reader.ReadEntity<Mobile>();
Power = reader.ReadEncodedInt();
History = reader.ReadEncodedInt();
Steed = reader.ReadEntity<Mobile>();
Familiar = reader.ReadEntity<Mobile>();
m_Shield = reader.ReadDeltaTime();
break;
}
}
}
public Ethic Ethic { get; }
public Mobile Mobile { get; }
[CommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
public int Power { get; set; }
[CommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
public int History { get; set; }
[CommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
public Mobile Steed { get; set; }
[CommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
public Mobile Familiar { get; set; }
[CommandProperty(AccessLevel.GameMaster)]
public bool IsShielded
{
get
{
if (m_Shield == DateTime.MinValue)
{
return false;
}
if (Core.Now < m_Shield + TimeSpan.FromHours(1.0))
{
return true;
}
FinishShield();
return false;
}
if (Core.Now < _shield + TimeSpan.FromHours(1.0))
{
return true;
}
FinishShield();
return false;
}
}
public static Player Find(Mobile mob) => Find(mob, false);
public static Player Find(Mobile mob) => Find(mob, false);
public static Player Find(Mobile mob, bool inherit)
public static Player Find(Mobile mob, bool inherit)
{
var pm = mob as PlayerMobile;
if (pm == null)
{
var pm = mob as PlayerMobile;
if (inherit && mob is BaseCreature bc)
{
pm = bc.GetMaster() as PlayerMobile;
}
if (pm == null)
{
if (inherit && mob is BaseCreature bc)
{
if (bc.Controlled)
{
pm = bc.ControlMaster as PlayerMobile;
}
else if (bc.Summoned)
{
pm = bc.SummonMaster as PlayerMobile;
}
}
if (pm == null)
{
return null;
}
}
var pl = pm.EthicPlayer;
if (pl?.Ethic.IsEligible(pl.Mobile) == false)
{
pm.EthicPlayer = pl = null;
}
return pl;
}
public void BeginShield() => m_Shield = Core.Now;
public void FinishShield() => m_Shield = DateTime.MinValue;
public void CheckAttach()
{
if (Ethic.IsEligible(Mobile))
{
Attach();
return null;
}
}
public void Attach()
{
if (Mobile is PlayerMobile mobile)
{
mobile.EthicPlayer = this;
}
var pl = pm.EthicPlayer;
Ethic.Players.Add(this);
if (pl?.Ethic.IsEligible(pl.Mobile) == false)
{
pm.EthicPlayer = pl = null;
}
public void Detach()
return pl;
}
public void BeginShield() => _shield = Core.Now;
public void FinishShield() => _shield = DateTime.MinValue;
public void CheckAttach()
{
if (Ethic.IsEligible(Mobile))
{
if (Mobile is PlayerMobile mobile)
{
mobile.EthicPlayer = null;
}
Ethic.Players.Remove(this);
}
public void Serialize(IGenericWriter writer)
{
writer.WriteEncodedInt(0); // version
writer.Write(Mobile);
writer.WriteEncodedInt(Power);
writer.WriteEncodedInt(History);
writer.Write(Steed);
writer.Write(Familiar);
writer.WriteDeltaTime(m_Shield);
Attach();
}
}
public void Attach()
{
if (Mobile is PlayerMobile mobile)
{
mobile.EthicPlayer = this;
}
Ethic.Players.Add(this);
}
public void Detach()
{
if (Mobile is PlayerMobile mobile)
{
mobile.EthicPlayer = null;
}
Ethic.Players.Remove(this);
}
}

View file

@ -1,37 +1,31 @@
namespace Server.Ethics
namespace Server.Ethics;
public abstract class Power
{
public abstract class Power
public PowerDefinition Definition { get; protected set; }
public virtual bool CheckInvoke(Player from)
{
protected PowerDefinition m_Definition;
public PowerDefinition Definition => m_Definition;
public virtual bool CheckInvoke(Player from)
if (!from.Mobile.CheckAlive())
{
if (!from.Mobile.CheckAlive())
{
return false;
}
if (from.Power < m_Definition.Power)
{
from.Mobile.LocalOverheadMessage(
MessageType.Regular,
0x3B2,
false,
"You lack the power to invoke this ability."
);
return false;
}
return true;
return false;
}
public abstract void BeginInvoke(Player from);
public virtual void FinishInvoke(Player from)
if (from.Power < Definition.Power)
{
from.Power -= m_Definition.Power;
from.Mobile.LocalOverheadMessage(
MessageType.Regular,
0x3B2,
false,
"You lack the power to invoke this ability."
);
return false;
}
return true;
}
public abstract void BeginInvoke(Player from);
public virtual void FinishInvoke(Player from) => from.Power -= Definition.Power;
}