3 KiB
3 KiB
| name | description |
|---|---|
| migrate-serialization | Trigger: when converting RunUO Serialize/Deserialize methods, adding [SerializableField], converting [Constructable] to [Constructible], or migrating manual serialization code. Covers: source-generated serialization, field conversion, version handling, TypeAlias. |
RunUO -> ModernUO Serialization Migration
When This Activates
- Converting
Serialize(GenericWriter)/Deserialize(GenericReader)overrides - Converting
[Constructable]to[Constructible] - Adding
[SerializableField]attributes - Handling save compatibility with
[TypeAlias]
Conversion Steps
- Add
using ModernUO.Serialization; - Read the old
Serialize()to find the version number it writes. Bump it by 1 for[SerializationGenerator] - If old
Deserialize()usedreader.ReadInt()(notReadEncodedInt()), passfalseas second parameter:[SerializationGenerator(N, false)] - Add
partialto class declaration - Convert each serialized field:
private int m_X->[SerializableField(N)] private int _x - Add
[SerializedCommandProperty(AccessLevel.X)]if RunUO had[CommandProperty] - Add
[InvalidateProperties]if setter calledInvalidateProperties() - DELETE the
Serialconstructor - DELETE the
Serialize()override - Convert
Deserialize()toprivate void Deserialize(IGenericReader reader, int version)to handle pre-codegen saves (removeoverride,base.Deserialize(), and version read line). Delete entirely if no existing saves. - Change
[Constructable]to[Constructible] - Timer fields: leave unserialized, add
[AfterDeserialization]method
Quick Mapping
| RunUO | ModernUO |
|---|---|
public class Foo : Item |
[SerializationGenerator(N, false)] public partial class Foo : Item (N = old version + 1) |
private int m_X + manual Serialize |
[SerializableField(0)] private int _x |
[CommandProperty(GM)] on property |
[SerializedCommandProperty(GM)] on field |
Foo(Serial serial) : base(serial) |
DELETE |
Serialize(GenericWriter) |
DELETE -- auto-generated |
Deserialize(GenericReader) |
Convert to private void Deserialize(IGenericReader reader, int version) for old saves |
| Custom setter with InvalidateProperties() | [InvalidateProperties] attribute |
| Custom setter logic | [SerializableProperty(N)] with this.MarkDirty() |
reader.ReadMobile() |
reader.ReadEntity<Mobile>() |
reader.ReadItem() |
reader.ReadEntity<Item>() |
Anti-Patterns
- Missing
partialkeyword -> build error - Serializing
TimerExecutionToken-> build error - Missing
this.MarkDirty()in[SerializableProperty]setter -> changes not saved - Wrong field prefix (
m_instead of_)
See Also
dev-docs/runuo-migration-docs/02-serialization.md-- detailed migration reference with before/afterdev-docs/serialization.md-- complete ModernUO serialization systemdev-docs/claude-skills/modernuo-serialization.md-- ModernUO serialization skill (patterns, attributes, examples)