Skip to content

Unity Attribute Sync SDK ​

Overview ​

Provides an attribute sync SDK for Unity clients, corresponding to the server-side ComVal/ProperValue attribute system. It supports:

  • Multi-type attribute value storage
  • Attribute change detection and incremental sync
  • Computed attribute support
  • Attribute change event notification

Directory Structure ​

sdks/unity/ApolloSDK/Attributes/
├── AttributeValue.cs       # 属性值类型(对应Server ComVal)
├── AttributeDefinition.cs  # 属性定义
├── AttributeRegistry.cs    # attribute registry
├── AttributeContainer.cs   # attribute container(对应Server ProperValue)
├── AttributeSyncManager.cs # attribute synchronization manager
├── ComputedAttribute.cs    # computed attribute support
├── AttributeEvents.cs      # attribute change events
└── AttributeExtensions.cs  # extension methods

Server-Side Mapping ​

ServerClient
BaseClass/ComVal.h - uComValAttributeValue.cs
Adapter/CppLua/ObjProperty_enum.h - attribute ID definitionsAttributeDefinition.cs
Game/GlobeObj.h - ProperValueAttributeContainer.cs
protocol/PacketBuilders.cpp - synchronization logicAttributeSyncManager.cs

Attribute ID Ranges ​

csharp
// 公共对象属性 (1-12)
ATTR_PointId = 1,      // 对象指针ID
ATTR_ObjType = 2,      // 对象类型
ATTR_Direction = 4,    // 方向
ATTR_DisplayName = 5,  // 显示名称
ATTR_NameColor = 6,    // 名字颜色
ATTR_Status = 7,       // 状态 (0=活着 1=死亡)
ATTR_Appr = 8,         // 外观
ATTR_MasterID = 11,    // 主人ID

// 生物属性 (101-223)
ATTR_Sex = 101,        // 性别
ATTR_Level = 105,      // 等级
ATTR_DcMax = 110,      // 最大攻击
ATTR_AcMax = 111,      // 最大防御
ATTR_CurHp = 112,      // 当前血量
ATTR_HpMax = 113,      // 最大血量
ATTR_AddAtkPer = 114,  // 攻击万分比
ATTR_AddHpMaxPer = 115,// 生命万分比
ATTR_Hit = 128,        // 命中(万分比)
ATTR_Dodge = 129,      // 闪避(万分比)
ATTR_CritRatio = 130,  // 暴击概率(万分比)
ATTR_TotalHpMax = 153, // 总最大血量
ATTR_FinalHit = 196,   // 命中率
ATTR_FinalDodge = 197, // 闪避率
ATTR_FinalCritRatio = 198, // 暴击率

// 玩家专属属性 (301-378)
ATTR_ExpMax = 303,        // 升级所需经验
ATTR_BindYuanBao = 305,   // 绑金
ATTR_YuanBao = 306,       // 元宝
ATTR_Diamond = 307,       // 钻石
ATTR_JinBi = 308,         // 金币
ATTR_MaxPower = 313,      // 体力上限
ATTR_PlayerID = 327,      // 角色全服唯一ID
ATTR_TeamId = 372,        // 队伍ID

// 宠物属性 (3001-3100)
PetAttr_Start = 3001,
ATTR_PetIdx = 3002,
ATTR_PetState = 3003,
PetAttr_End = 3100,

// 怪物属性 (5001-6000)
ATTR_MoveInterval = 5001,
ATTR_AttackDistance = 5003,
ATTR_AttackInterval = 5004,

// 物品属性 (8000-9000)
ATTR_CollectionLevel = 8050,
ATTR_ItemType = 8052,
ATTR_ItemIdx = 8053,
ATTR_Dura = 8054,
ATTR_Quality = 8055,
ATTR_Bound = 8061,
ATTR_ItemId = 8063,

Usage Example ​

csharp
// 1. 初始化属性系统
AttributeRegistry.Instance.Initialize();

// 2. 创建attribute container
var container = new AttributeContainer(playerId);

// 3. 设置属性
container.SetAttribute(AttributeIDs.ATTR_Level, 50);
container.SetAttribute(AttributeIDs.ATTR_CurHp, 1000);
container.SetAttribute(AttributeIDs.ATTR_HpMax, 5000);

// 4. 获取属性
int level = container.GetInt(AttributeIDs.ATTR_Level);
long hp = container.GetLong(AttributeIDs.ATTR_CurHp);

// 5. 监听属性变化
container.OnAttributeChanged += (evt) => {
    Debug.Log($"属性 {evt.AttributeId} 从 {evt.OldValue} 变为 {evt.NewValue}");
};

// 6. 同步到Server
byte[] deltaData = AttributeSyncManager.Instance.BuildDeltaPacket(container);
NetworkManager.Send(deltaData);

// 7. 应用Server更新
AttributeSyncManager.Instance.ApplyServerUpdate(receivedData, container);

Development Tasks ​

Phase 1: Base Types ​

  • [x] AttributeValue.cs - attribute value wrapper
  • [ ] AttributeDefinition.cs - attribute definitions

Phase 2: Registry and Container ​

  • [ ] AttributeRegistry.cs - attribute registry
  • [ ] AttributeContainer.cs - attribute container

Phase 3: Sync System ​

  • [ ] AttributeSyncManager.cs - attribute synchronization manager

Phase 4: Computed Attributes ​

  • [ ] ComputedAttribute.cs - computed attribute support

Phase 5: Event System ​

  • [ ] AttributeEvents.cs - attribute change events

Phase 6: Extensions and Utilities ​

  • [ ] AttributeExtensions.cs - extension methods

Released under the MIT License