ModernUO/Projects/UOContent/Mobiles/Monsters/LBR/Meers/EnragedCreatures.cs
Kamron Batman 843a29e7dc
refactor: master views over BaseCreature's one master reference (#2674)
## Summary

After #2670, `BaseCreature` stores one master. Callers still reached it through three differently gated names plus hand-rolled combinations of the `Controlled`/`Summoned` flags. Each gate is now one named view:

| Member | Definition | Meaning |
|---|---|---|
| `Master` | the reference; its setter does the follower bookkeeping; serialized as before | whoever the creature answers to |
| `ControlMaster` | `Controlled ? Master : null` | the owner |
| `SummonMaster` | `Summoned ? Master : null` | the summoner |
| `GetMaster()` | `ControlMaster ?? SummonMaster` | who answers for the creature |

`ControlMaster` and `SummonMaster` stay settable so custom code keeps compiling: both setters assign `Master`. There is no guard, so a write through either one can read back as null until the matching flag is set.

An enraged creature is the one shape with a master and neither flag. It keeps its meer through `Master`, while `GetMaster()` stays null, so the meer never answers for it (notoriety, kill credit).

Readers move onto the view they mean:
- "Owner or summoner" pairs and `ControlMaster ?? SummonMaster` collapse into `GetMaster()`: pack instinct, familiars, golem, house access, mounts, pack horse, Solen friendship, spell target and guild checks, and the `[` pet command.
- Checks such as `Controlled && ControlMaster == from` drop the flag the view already applies. Checks that don't reduce keep it: `Controlled && ControlMaster != from`, a possibly-null `from`, and `MageAI.CanDispel`'s `Summoned &&`.

**No behavior change, save format unchanged** (the schema generator produces no diff). Edge cases for custom code and shard operators:
- `SummonMaster = x` on a plain pet now replaces its owner (#2670 made that a no-op), and `ControlMaster = null` on an uncontrolled summon now clears its caster (it did nothing before).
- `SpellHelper.GetGuildFor` no longer falls back to an enraged creature's meer. Meer mages have no guild.

## Docs

- `dev-docs/content-patterns.md` § Masters: which view answers which question, how to set a master, and which flag checks are redundant.
- `dev-docs/runuo-migration-docs/09-items-mobiles-creatures.md` § Masters: RunUO's two-field reads mapped onto the views, plus the gotcha for creatures that set `SummonMaster` without `Summoned` (the write compiles, the read now returns null; use `Master`).
- The `modernuo-content-patterns` and `migrate-items-mobiles` skills point at both.

## Test plan

- [x] `MasterViewsTests`: all four views across wild, pet, controlled summon, uncontrolled summon and enraged shapes; reassigning `Master` moves follower slots; `SetControlMaster(null)` keeps an uncontrolled summon's caster; deleting a summon returns the caster's slots
- [x] Serialization tests updated to the new views (round-trip, legacy v22, v23 migration)
- [x] UOContent.Tests (1178 passed, 2 skipped) and Server.Tests (907) green
2026-09-24 22:45:24 -07:00

153 lines
4.5 KiB
C#

using ModernUO.Serialization;
namespace Server.Mobiles
{
[SerializationGenerator(0, false)]
public partial class EnragedRabbit : BaseEnraged
{
public EnragedRabbit(Mobile summoner) : base(summoner) => Body = 0xcd;
public override string CorpseName => "a hare corpse";
public override string DefaultName => "a rabbit";
public override int GetAttackSound() => 0xC9;
public override int GetHurtSound() => 0xCA;
public override int GetDeathSound() => 0xCB;
}
[SerializationGenerator(0, false)]
public partial class EnragedHart : BaseEnraged
{
public EnragedHart(Mobile summoner) : base(summoner) => Body = 0xea;
public override string CorpseName => "a deer corpse";
public override string DefaultName => "a great hart";
public override int GetAttackSound() => 0x82;
public override int GetHurtSound() => 0x83;
public override int GetDeathSound() => 0x84;
}
[SerializationGenerator(0, false)]
public partial class EnragedHind : BaseEnraged
{
public EnragedHind(Mobile summoner) : base(summoner) => Body = 0xed;
public override string CorpseName => "a deer corpse";
public override string DefaultName => "a hind";
public override int GetAttackSound() => 0x82;
public override int GetHurtSound() => 0x83;
public override int GetDeathSound() => 0x84;
}
[SerializationGenerator(0, false)]
public partial class EnragedBlackBear : BaseEnraged
{
public EnragedBlackBear(Mobile summoner) : base(summoner)
{
Body = 0xd3;
BaseSoundID = 0xa3;
}
public override string CorpseName => "a bear corpse";
public override string DefaultName => "a black bear";
}
[SerializationGenerator(0, false)]
public partial class EnragedEagle : BaseEnraged
{
public EnragedEagle(Mobile summoner) : base(summoner)
{
Body = 0x5;
BaseSoundID = 0x2ee;
}
public override string CorpseName => "an eagle corpse";
public override string DefaultName => "an eagle";
}
[SerializationGenerator(0, false)]
public partial class BaseEnraged : BaseCreature
{
public BaseEnraged(Mobile summoner) : base(AIType.AI_Melee)
{
SetStr(50, 200);
SetDex(50, 200);
/*
* On OSI, all stats are random 50-200, but
* str is never less than hits, and dex is never
* less than stam.
*/
SetHits(50, Str);
SetStam(50, Dex);
Karma = -1000;
Tamable = false;
Master = summoner;
}
// The meer's FightMode.Evil against our negative karma would otherwise make us enemies.
public override bool IsEnemy(Mobile m) => m != Master && base.IsEnemy(m);
public override void OnThink()
{
if (Master?.Deleted != false)
{
Delete();
}
/*
On OSI, without combatant, they behave as if they have been
given "come" command, ie they wander towards their summoner,
but never actually "follow".
*/
else if (!Combat(this))
{
AIObject?.MoveTo(Master, 5);
}
/*
On OSI, if the summon attacks a mobile, the summoner meer also
attacks them, regardless of karma, etc. as long as the combatant
is a player or controlled/summoned, and the summoner is not already
engaged in combat.
*/
else if (!Combat(Master))
{
if (Combatant.Player || Combatant is BaseCreature bc && bc.GetMaster() != null)
{
Master.Combatant = Combatant;
}
}
else
{
base.OnThink();
}
}
private bool Combat(Mobile mobile)
{
var combatant = mobile.Combatant;
return combatant?.Deleted == false && !combatant.IsDeadBondedPet && combatant.Alive;
}
public override void OnSingleClick(Mobile from)
{
base.OnSingleClick(from);
PrivateOverheadMessage(MessageType.Regular, 0x3B2, 1060768, from.NetState); // enraged
}
public override void AddNameProperties(IPropertyList list)
{
base.AddNameProperties(list);
list.Add(1060768); // enraged
}
}
}