warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ModernUO/dev-docs/claude-skills/migrate-from-runuo/migrate-items-mobiles.md
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

3.8 KiB
Raw Blame History

name description
migrate-items-mobiles Trigger: when converting RunUO Item, Mobile, or BaseCreature subclasses to ModernUO. Most common migration task. Covers: complete item/creature conversion combining serialization, timers, properties, naming.

RunUO -> ModernUO Item/Mobile/Creature Migration

When This Activates

  • Converting any Item subclass from RunUO
  • Converting any Mobile/BaseCreature subclass
  • This is the most common migration task -- combines all other systems

Item Conversion Checklist

  1. Foundation: file-scoped namespace, using ModernUO.Serialization;
  2. Class: add [SerializationGenerator(N, false)] (N = old version + 1, false if old Deserialize used ReadInt()), add partial
  3. Fields: m_X -> [SerializableField(N)] _x with [SerializedCommandProperty]
  4. Add [InvalidateProperties] where RunUO setter called InvalidateProperties()
  5. Delete: Serial constructor, Serialize, Deserialize
  6. [Constructable] -> [Constructible]
  7. Name = "text" -> public override string DefaultName => "text";
  8. Timers: nested class -> Timer.StartTimer() + TimerExecutionToken + [AfterDeserialization] + OnAfterDelete
  9. Properties: GetProperties(ObjectPropertyList) -> GetProperties(IPropertyList), apply string hole rule
  10. Context menus: List<ContextMenuEntry> -> ref PooledRefList<ContextMenuEntry>

Creature-Specific Changes

  • [CorpseName("...")] attribute -> public override string CorpseName => "...";
  • BaseCreature(AI, Fight, 10, 1, 0.2, 0.4) -> BaseCreature(AI, Fight) (extra params default)
  • Name = "text" -> public override string DefaultName => "text";
  • Expression-bodied overrides: public override int Meat { get { return 1; } } -> public override int Meat => 1;
  • AI movement calls lose the run flag: MoveTo(m, true, range) -> MoveTo(m, range) (also WalkMobileRange, ApproachTarget, MoveToPoint, PathFollower.Follow); the Running bit is derived from step pace -> dev-docs/runuo-migration-docs/09-items-mobiles-creatures.md § AI Movement
  • AcquireOnApproach (bool) -> AcquireOnApproachDelay (TimeSpan; Zero = old instant behavior) -> same doc § Target Acquisition
  • BaseAI.OnAggressiveAction(aggressor) is bool, not void: the AI owns the retaliation policy (BaseCreature no longer sets Combatant after it); an early return; that refused a fight -> return false;, otherwise return true;; swap-only overrides call PreferCloserAggressor(aggressor) instead of base -> same doc § Retaliation
  • DamageEntries is an inline ref readonly ValueLinkList<DamageEntry>, not a List: indexer/Add/Remove/Clear -> foreach / .ByDescending() (needs using Server.Collections;) and ClearDamageEntries(); GetLootingRights takes it by in -> same doc § Damage Entries
  • ControlMaster/SummonMaster are views of one Master, gated by Controlled/Summoned; assignments still compile (they set Master). ControlMaster ?? SummonMaster and controlled-or-summoned pairs -> GetMaster(); a creature that sets SummonMaster without Summoned (RunUO's BaseEnraged) must read Master, because SummonMaster now reads null -> same doc § Masters

Anti-Patterns

  • Using _field-- instead of Property-- (bypasses MarkDirty tracking)
  • Forgetting [AfterDeserialization] for timer restoration
  • Forgetting OnAfterDelete() for timer cancellation

See Also

  • dev-docs/runuo-migration-docs/09-items-mobiles-creatures.md -- detailed migration with before/after examples
  • dev-docs/content-patterns.md -- ModernUO content templates
  • dev-docs/claude-skills/modernuo-content-patterns.md -- ModernUO content skill
  • dev-docs/claude-skills/modernuo-serialization.md -- serialization patterns
  • dev-docs/claude-skills/modernuo-timers.md -- timer patterns