### Additions
- Automatically opts-out `Item/Mobile/Guild/Accounts` from dirty checking with a new property `UseDirtyChecking`
- Codegen now enables `UseDirtyChecking` via getter. This requires that the property is `virtual` for derived types.
### Fixes
- Fixes `EncodedInt` being broken
- Fixes issues with new custom serializable types that are not derived from Item/Mobile/etc.
- Removes double dirty checking.
### Example of a brand new serializable type that isn't an Item/Mobile/etc.
User created code:
```cs
using System;
namespace Server.Items
{
[Serializable(0)]
public partial class NewTestEntityObject : ISerializable
{
[EncodedInt]
[SerializableField(0)]
private int _someProperty;
public NewTestEntityObject()
{
SetTypeRef(GetType());
// Add to serial tracking like World.Item
/*
Serial = World.NewEntity;
World.AddEntity(this);
*/
}
[AfterDeserialization]
private void AfterDeserialization()
{
Console.WriteLine("This ran!");
}
public int TypeRef { get; }
public Serial Serial { get; }
public void Delete()
{
}
public bool Deleted { get; set; }
public void SetTypeRef(Type type)
{
// Type tracking for persistence goes here
/*
TypeRef = World.NewEntityTypes.IndexOf(type);
if (TypeRef == -1)
{
World.NewEntityTypes.Add(type);
TypeRef = World.NewEntityTypes.Count - 1;
}
*/
}
}
}
```
Generated code:
```cs
namespace Server.Items
{
public partial class NewTestEntityObject
{
#pragma warning disable 0414
private const int _version = 0;
#pragma warning restore 0414
public int SomeProperty
{
get => _someProperty;
set
{
if (value != _someProperty)
{
_someProperty = value;
((ISerializable)this).MarkDirty();
}
}
}
long ISerializable.SavePosition { get; set; } = -1;
BufferWriter ISerializable.SaveBuffer { get; set; }
bool ISerializable.UseDirtyChecking => true;
public NewTestEntityObject(Serial serial)
{
Serial = serial;
SetTypeRef(typeof(NewTestEntityObject));
}
public void Serialize(IGenericWriter writer)
{
writer.WriteEncodedInt(_version);
writer.WriteEncodedInt(SomeProperty);
}
public void Deserialize(IGenericReader reader)
{
var version = reader.ReadEncodedInt();
SomeProperty = reader.ReadEncodedInt();
Timer.DelayCall(AfterDeserialization);
}
}
}
```
119 lines
3.4 KiB
C#
119 lines
3.4 KiB
C#
/*************************************************************************
|
|
* ModernUO *
|
|
* Copyright 2019-2020 - ModernUO Development Team *
|
|
* Email: hi@modernuo.com *
|
|
* File: IEntity.cs *
|
|
* *
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation, either version 3 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
|
|
*************************************************************************/
|
|
|
|
using System;
|
|
|
|
namespace Server
|
|
{
|
|
public interface IEntity : IPoint3D, ISerializable
|
|
{
|
|
Point3D Location { get; }
|
|
Map Map { get; }
|
|
void MoveToWorld(Point3D location, Map map);
|
|
|
|
void ProcessDelta();
|
|
|
|
bool InRange(Point2D p, int range);
|
|
|
|
bool InRange(Point3D p, int range);
|
|
|
|
bool InRange(IPoint2D p, int range);
|
|
|
|
void RemoveItem(Item item);
|
|
}
|
|
|
|
public class Entity : IEntity
|
|
{
|
|
public Entity(Serial serial, Point3D loc, Map map)
|
|
{
|
|
Serial = serial;
|
|
Location = loc;
|
|
Map = map;
|
|
Deleted = false;
|
|
}
|
|
|
|
public void SetTypeRef(Type type)
|
|
{
|
|
}
|
|
|
|
bool ISerializable.UseDirtyChecking => false;
|
|
|
|
long ISerializable.SavePosition { get; set; } = -1;
|
|
|
|
BufferWriter ISerializable.SaveBuffer { get; set; }
|
|
|
|
public int TypeRef { get; } = -1;
|
|
|
|
public Serial Serial { get; }
|
|
|
|
public Point3D Location { get; private set; }
|
|
|
|
public int X => Location.X;
|
|
|
|
public int Y => Location.Y;
|
|
|
|
public int Z => Location.Z;
|
|
|
|
public Map Map { get; private set; }
|
|
|
|
public void MoveToWorld(Point3D newLocation, Map map)
|
|
{
|
|
Location = newLocation;
|
|
Map = map;
|
|
}
|
|
|
|
public bool Deleted { get; }
|
|
|
|
public void Delete()
|
|
{
|
|
}
|
|
|
|
public void ProcessDelta()
|
|
{
|
|
}
|
|
|
|
public void RemoveItem(Item item)
|
|
{
|
|
}
|
|
|
|
public bool InRange(Point2D p, int range) =>
|
|
p.m_X >= Location.m_X - range
|
|
&& p.m_X <= Location.m_X + range
|
|
&& p.m_Y >= Location.m_Y - range
|
|
&& p.m_Y <= Location.m_Y + range;
|
|
|
|
public bool InRange(Point3D p, int range) =>
|
|
p.m_X >= Location.m_X - range
|
|
&& p.m_X <= Location.m_X + range
|
|
&& p.m_Y >= Location.m_Y - range
|
|
&& p.m_Y <= Location.m_Y + range;
|
|
|
|
public bool InRange(IPoint2D p, int range) =>
|
|
p.X >= Location.m_X - range
|
|
&& p.X <= Location.m_X + range
|
|
&& p.Y >= Location.m_Y - range
|
|
&& p.Y <= Location.m_Y + range;
|
|
|
|
public void Deserialize(IGenericReader reader)
|
|
{
|
|
// Should not actually be saved
|
|
Timer.DelayCall(Delete);
|
|
}
|
|
|
|
public void Serialize(IGenericWriter writer)
|
|
{
|
|
}
|
|
}
|
|
}
|