星火 2.0 开发文档

主题

GameSystemUI.BuffSystemUI ​

ScopeData 仅客户端 ​

命名空间 GameSystemUI.BuffSystemUI

csharp
public class ScopeData : IGameClass

构造函数 ​

ScopeData 仅客户端 ​

csharp
public ScopeData()

方法 ​

OnRegisterGameClass 仅客户端 ​

csharp
public static void OnRegisterGameClass()

BuffBar 仅客户端 ​

命名空间 GameSystemUI.BuffSystemUI.Advanced

csharp
public class BuffBar : Panel, IGameObject<GameDataControlBuffBar>, IGameObject

Buff条UI控件 显示单位身上的Buff列表，支持过滤、排序等功能

构造函数 ​

BuffBar 仅客户端 ​

csharp
public BuffBar(IGameLink<GameDataControlBuffBar> link)

BuffBar 仅客户端 ​

csharp
public BuffBar()

属性 ​

BuffUpdateFrameInterval 仅客户端 ​

csharp
public static int BuffUpdateFrameInterval { get; set; }

Buff更新帧间隔

BindUnit 仅客户端 ​

csharp
public Unit? BindUnit { get; set; }

绑定的单位 - 参考AbilityJoyStickGroup的绑定方式

csharp
public new IGameLink<GameDataControlBuffBar> Link { get; }

Cache 仅客户端 ​

csharp
public new GameDataControlBuffBar Cache { get; }

方法 ​

Create 仅客户端 ​

csharp
public static BuffBar Create()

创建BuffBar实例

Create 仅客户端 ​

csharp
public static BuffBar Create(Unit unit)

创建BuffBar实例并绑定单位

SetUnit 仅客户端 ​

csharp
public void SetUnit(Unit? unit)

设置绑定的单位

DisposeManaged 仅客户端 ​

csharp
protected override void DisposeManaged()

事件 ​

OnBuffUpdateRequested 仅客户端 ​

csharp
public static event Action? OnBuffUpdateRequested

字段 ​

DefaultTemplate 仅客户端 ​

csharp
public new static readonly IGameLink<GameDataControlBuffBar> DefaultTemplate

BuffDisplayData 仅客户端 ​

命名空间 GameSystemUI.BuffSystemUI.Advanced

csharp
public class BuffDisplayData

Buff显示数据结构 - 整合所有Buff显示所需的信息

构造函数 ​

BuffDisplayData 仅客户端 ​

csharp
public BuffDisplayData()

属性 ​

Buff 仅客户端 ​

csharp
public Buff? Buff { get; set; }

Name 仅客户端 ​

csharp
public string Name { get; set; }

IconPath 仅客户端 ​

csharp
public Icon IconPath { get; set; }

Polarity 仅客户端 ​

csharp
public BuffPolarity Polarity { get; set; }

Stack 仅客户端 ​

csharp
public int Stack { get; set; }

Remaining 仅客户端 ​

csharp
public float Remaining { get; set; }

Duration 仅客户端 ​

csharp
public float Duration { get; set; }

Description 仅客户端 ​

csharp
public string Description { get; set; }

ShowIcon 仅客户端 ​

csharp
public bool ShowIcon { get; set; }

是否显示这个Buff图标

ShowDuration 仅客户端 ​

csharp
public bool ShowDuration { get; set; }

是否显示持续时间

DurationFormat 仅客户端 ​

csharp
public UIDurationFormat DurationFormat { get; set; }

持续时间显示格式

ShowStack 仅客户端 ​

csharp
public bool ShowStack { get; set; }

是否显示叠加层数

BlinkWhenExpiring 仅客户端 ​

csharp
public bool BlinkWhenExpiring { get; set; }

是否在即将消失时闪烁

BlinkThreshold 仅客户端 ​

csharp
public TimeSpan? BlinkThreshold { get; set; }

闪烁阈值时间（剩余时间小于等于此值时开始闪烁）

MergeInstances 仅客户端 ​

csharp
public bool MergeInstances { get; set; }

是否多个实例合并显示

BuffIcon 仅客户端 ​

命名空间 GameSystemUI.BuffSystemUI.Advanced

csharp
public class BuffIcon : Panel, IGameObject<GameDataControlBuffIcon>, IGameObject

Buff图标UI控件 显示具体的Buff图标，包含图标、CD进度、堆叠数量等

构造函数 ​

BuffIcon 仅客户端 ​

csharp
public BuffIcon(IGameLink<GameDataControlBuffIcon> link)

BuffIcon 仅客户端 ​

csharp
public BuffIcon()

属性 ​

Buff 仅客户端 ​

csharp
public Buff? Buff { get; set; }

绑定的Buff对象

Polarity 仅客户端 ​

csharp
public BuffPolarity Polarity { get; }

Buff极性

CooldownProgress 仅客户端 ​

csharp
public float CooldownProgress { get; }

冷却进度 (0-1)

CooldownText 仅客户端 ​

csharp
public string CooldownText { get; }

冷却时间文本

StackText 仅客户端 ​

csharp
public string StackText { get; }

堆叠数量文本

csharp
public new IGameLink<GameDataControlBuffIcon> Link { get; }

Cache 仅客户端 ​

csharp
public new GameDataControlBuffIcon Cache { get; }

方法 ​

CreateBuffDisplayData 仅客户端 ​

csharp
public static BuffDisplayData? CreateBuffDisplayData(Buff? buff)

创建BuffData - 从Buff对象中提取所有显示信息 这个方法整合了原来BuffBar.CreateBuffData的逻辑

Create 仅客户端 ​

csharp
public static BuffIcon Create()

创建BuffIcon实例

Create 仅客户端 ​

csharp
public static BuffIcon Create(Buff buff)

创建BuffIcon实例并绑定Buff

SetPolarity 仅客户端 ​

csharp
public void SetPolarity(BuffPolarity polarity)

SetIcon 仅客户端 ​

csharp
public void SetIcon(Icon iconPath)

设置Buff图标

SetCooldown 仅客户端 ​

csharp
public void SetCooldown(float remaining, float total, UIDurationFormat format = UIDurationFormat.Numeric)

设置冷却进度 - 支持不同的UI显示格式

SetStack 仅客户端 ​

csharp
public void SetStack(int stack)

设置堆叠数量

csharp
public void SetBlink()

设置闪烁效果

DisposeManaged 仅客户端 ​

csharp
protected override void DisposeManaged()

字段 ​

DefaultTemplate 仅客户端 ​

csharp
public new static readonly IGameLink<GameDataControlBuffIcon> DefaultTemplate

BuffCategoryFilter 双端 ​

命名空间 GameSystemUI.BuffSystemUI.Data

csharp
public enum BuffCategoryFilter

Buff分类过滤标志 可扩展枚举，支持多选 双端通用的数编枚举

枚举值 ​

  • None = 0 — 无过滤
  • Dispellable = 1 — 可被禁用的Buff
  • Debuff = 2 — 负面效果
  • Buff = 4 — 增益效果
  • Status = 8 — 状态效果
  • Aura = 0x10 — 光环效果
  • Passive = 0x20 — 被动效果
  • All = 0x3F — 所有分类

BuffPolarityFilter 双端 ​

命名空间 GameSystemUI.BuffSystemUI.Data

csharp
public enum BuffPolarityFilter

Buff极性过滤标志 可扩展枚举，支持多选 双端通用的数编枚举

枚举值 ​

  • None = 0 — 无过滤
  • Positive = 1 — 正面极性
  • Negative = 2 — 负面极性
  • Neutral = 4 — 中性极性
  • All = 7 — 所有极性

GameDataControlBuffBar 双端 ​

命名空间 GameSystemUI.BuffSystemUI.Data

csharp
public class GameDataControlBuffBar : GameDataControlPanel, IGameData<GameDataControlBuffBar>, IGameData

BuffBar控件数据配置 双端通用的数编配置

构造函数 ​

GameDataControlBuffBar 双端 ​

csharp
public GameDataControlBuffBar(GameLink<GameDataControl, GameDataControlBuffBar> link)

GameDataControlBuffBar 双端 ​

csharp
public GameDataControlBuffBar(IGameLink<GameDataControlBuffBar> link)

属性 ​

BuffWidth 双端 ​

csharp
public int BuffWidth { get; set; }

Buff宽度

BuffHeight 双端 ​

csharp
public int BuffHeight { get; set; }

Buff高度

BuffMargin 双端 ​

csharp
public int BuffMargin { get; set; }

Buff间隔

BuffCategoryFilter 双端 ​

csharp
public BuffCategoryFilter BuffCategoryFilter { get; set; }

Buff分类过滤：符合该字段的Buff分类才会显示在这个控件中

BuffPolarityFilter 双端 ​

csharp
public BuffPolarityFilter BuffPolarityFilter { get; set; }

Buff极性过滤：可选择显示的极性类型

csharp
public new IGameLink<GameDataControlBuffBar> Link { get; }

方法 ​

CreateControl 仅客户端 ​

csharp
public override Control CreateControl()

GameDataControlBuffIcon 双端 ​

命名空间 GameSystemUI.BuffSystemUI.Data

csharp
public class GameDataControlBuffIcon : GameDataControlPanel, IGameData<GameDataControlBuffIcon>, IGameData

BuffIcon控件数据配置 双端通用的数编配置

构造函数 ​

GameDataControlBuffIcon 双端 ​

csharp
public GameDataControlBuffIcon(GameLink<GameDataControl, GameDataControlBuffIcon> link)

GameDataControlBuffIcon 双端 ​

csharp
public GameDataControlBuffIcon(IGameLink<GameDataControlBuffIcon> link)

属性 ​

BuffIcon 双端 ​

csharp
public Icon BuffIcon { get; set; }

Buff图标路径

BuffBackgroundPositiveColor 双端 ​

csharp
public Color BuffBackgroundPositiveColor { get; set; }

正面极性外框颜色

BuffBackgroundNegativeColor 双端 ​

csharp
public Color BuffBackgroundNegativeColor { get; set; }

负面极性外框颜色

BuffBackgroundNeutralColor 双端 ​

csharp
public Color BuffBackgroundNeutralColor { get; set; }

中性极性外框颜色

BuffWidth 双端 ​

csharp
public int BuffWidth { get; set; }

Buff宽度

BuffHeight 双端 ​

csharp
public int BuffHeight { get; set; }

Buff高度

BuffMargin 双端 ​

csharp
public int BuffMargin { get; set; }

Buff间隔

FontSize 双端 ​

csharp
public int FontSize { get; set; }

字体大小

BuffPositiveProgressType 双端 ​

csharp
public ProgressType BuffPositiveProgressType { get; set; }

正面极性CD序列帧类型

BuffNegativeProgressType 双端 ​

csharp
public ProgressType BuffNegativeProgressType { get; set; }

负面极性CD序列帧类型

BuffNeutralProgressType 双端 ​

csharp
public ProgressType BuffNeutralProgressType { get; set; }

中性极性CD序列帧类型

csharp
public new IGameLink<GameDataControlBuffIcon> Link { get; }

方法 ​

CreateControl 仅客户端 ​

csharp
public override Control CreateControl()

ProgressType 双端 ​

命名空间 GameSystemUI.BuffSystemUI.Data

csharp
public enum ProgressType

进度条类型枚举 双端通用的数编枚举

枚举值 ​

  • Clockwise — 顺时针
  • CounterClockwise — 逆时针