Home > @esengine/ecs-framework-monorepo

ecs-framework-monorepo package

Classes

Class	Description
BandwidthMonitor	带宽监控器 负责监控网络带宽使用情况并提供自适应调整
DeltaSync	差量同步器 负责计算和应用数据差量，减少网络传输量
ErrorHandler	网络错误处理器
EventEmitter	网络事件发射器，专为网络层设计 使用字符串或symbol作为事件类型，简化API
HeartbeatManager	心跳管理器
JSONSerializer	JSON序列化器
LZCompressionAlgorithm	LZ字符串压缩算法实现
MessageCompressor	消息压缩器
MessageManager	消息管理器
NetworkEventUtils	网络事件工具类
NetworkIdentity	网络身份组件 为实体提供网络同步能力的核心组件。 每个需要网络同步的实体都必须拥有此组件。 集成了事件系统，当属性变化时自动发射事件用于网络同步。
NoCompressionAlgorithm	无压缩算法实现（默认）
RpcCallHandler	RPC调用处理器 负责处理来自客户端的RPC调用请求
RpcCallProxy	RPC调用代理 负责发送RPC调用并处理响应
RpcMetadataManager	RPC元数据管理器 负责管理所有RPC方法的元数据和注册信息
RpcMethodValidator	RPC方法验证器
RpcReliabilityManager	RPC可靠性管理器 提供重复检测、幂等性、顺序执行和事务支持
SyncVarManager	SyncVar管理器 负责管理所有带有SyncVar的实例，追踪变化并生成同步批次
SyncVarSerializer	SyncVar专用序列化器 针对SyncVar数据进行优化的序列化系统

Enumerations

Enumeration	Description
AuthorityType	同步权限类型
BandwidthWarningLevel	带宽警告级别
ConnectionState	连接状态
DeltaOperationType	差量操作类型
ErrorSeverity	错误严重级别
MessageIdGeneratorType	消息ID生成器类型
MessageType	网络消息类型枚举
NetworkErrorType	网络错误类型
NetworkEventPriority	网络事件优先级
NetworkEventType	网络事件类型枚举 定义网络层中的所有事件类型
NetworkScope	网络作用域
RecoveryStrategy	错误恢复策略
RoomState	房间状态
RpcCallStatus	RPC调用状态
RpcErrorType	RPC错误类型
RpcTarget	RPC目标
SyncMode	同步模式

Functions

Function	Description
clearDirtyFlags(target)	清理所有脏标记
ClientRpc(options)	客户端RPC装饰器 标记方法可以调用到客户端
getDirtySyncVars(target)	获取对象的所有脏SyncVar属性
getRpcMethodMetadata(target, methodName)	获取特定方法的RPC元数据
getRpcMethods(target)	获取类的所有RPC方法元数据
getSyncVarMetadata(target)	获取对象的所有SyncVar元数据
getSyncVarPropertyMetadata(target, propertyKey)	获取特定属性的SyncVar元数据
getSyncVarStats(target)	获取SyncVar统计信息
hasSyncVars(target)	检查对象是否有SyncVar属性
isClientRpcMethod(target, methodName)	检查方法是否为客户端RPC
isRpcMethod(target, methodName)	检查方法是否为RPC方法
isServerRpcMethod(target, methodName)	检查方法是否为服务端RPC
resetSyncVarStats(target)	重置SyncVar统计信息
ServerRpc(options)	服务端RPC装饰器 标记方法可以被客户端调用
SyncVar(options)	SyncVar装饰器 用于标记需要网络同步的属性

Interfaces

Interface	Description
BandwidthLimit	带宽限制
BandwidthMonitorConfig	带宽监控配置
BandwidthMonitorEvents	带宽事件
BandwidthSample	带宽样本
BandwidthStats	带宽统计
ChatData	聊天数据
ClientInfo	客户端信息
ClientRpcOptions	客户端RPC装饰器选项
ComponentData	组件数据
ComponentSyncData	组件同步数据
CompressionConfig	压缩配置
CompressionMetadata	压缩元数据
CompressionResult	压缩结果
CompressionStats	压缩统计信息
ConnectData	连接数据
ConnectionEventData	连接事件数据
ConnectResponseData	连接响应数据
ContainerHeader	容器头结构
CustomData	自定义数据
DecompressionResult	解压缩结果
DeltaData	差量数据
DeltaOperation	差量操作
DeltaSyncConfig	差量同步配置
DeltaSyncStats	差量同步统计
DeserializationResult	反序列化结果
DisconnectData	断开连接数据
DuplicateCallCheckResult	重复调用检查结果
EntityCreateData	实体创建数据
EntityDestroyData	实体销毁数据
ErrorData	错误数据
ErrorHandlerConfig	错误处理配置
ErrorHandlerEvents	错误处理事件
ErrorStats	错误统计信息
ErrorTrendAnalysis	错误趋势分析结果
HeartbeatConfig	心跳配置
HeartbeatData	心跳数据
HeartbeatEvents	心跳事件接口
HeartbeatMessage	心跳消息接口
HeartbeatStatus	心跳状态
IClientInfo	客户端信息
IClientTransport	客户端传输层接口
ICompressionAlgorithm	压缩算法接口
IConnectionOptions	连接选项
IConnectionStats	连接统计信息
IConnectMessage	连接请求消息
IConnectResponseMessage	连接响应消息
ICustomSerializer	自定义序列化器接口
IEntityCreateMessage	实体创建消息
IEntityDestroyMessage	实体销毁消息
IErrorMessage	错误消息
IGameEventMessage	游戏事件消息
IHeartbeatMessage	心跳消息
IJoinRoomMessage	加入房间消息
ILeaveRoomMessage	离开房间消息
INetworkError	网络错误信息
INetworkMessage	网络消息基础接口
INetworkStats	网络统计信息
IQuaternion	四元数
IRoomInfo	房间信息
IRoomStateMessage	房间状态消息
IRpcCallMessage	RPC调用消息
IRpcResponseMessage	RPC响应消息
ISyncBatchMessage	批量同步消息
ISyncVarMessage	同步变量消息
ITransform	变换信息
ITransport	传输层抽象接口
ITransportClientInfo	传输层客户端信息
ITransportConfig	传输层配置
IVector2	向量2D
IVector3	向量3D
JoinRoomData	加入房间数据
JsonMessageValidationResult	JSON序列化消息验证结果
LeaveRoomData	离开房间数据
MessageCreateOptions	消息创建选项
MessageEventData	消息事件数据
MessageManagerConfig	消息管理器配置
MessageStats	消息统计信息
MessageValidationResult	消息验证结果
NetworkEventData	网络事件数据基础接口
NetworkIdentityEventData	网络身份事件数据
NetworkSender	网络发送器接口
OverLimitResult	超限检查结果
ParsedHeader	容器头解析结果
PerformanceEventData	性能事件数据
PlayerInfo	玩家信息
PlayerJoinedData	玩家加入数据
PlayerLeftData	玩家离开数据
Position3D	3D位置信息
RoomEventData	房间事件数据
RpcCallHandlerConfig	RPC调用处理器配置
RpcCallHandlerEvents	RPC调用处理器事件
RpcCallInfo	RPC调用信息
RpcCallProxyConfig	RPC调用代理配置
RpcCallProxyEvents	RPC调用代理事件
RpcCallRequest	RPC调用请求
RpcCallResponse	RPC调用响应
RpcError	RPC错误信息
RpcEventData	RPC事件数据
RpcMetadataManagerEvents	RPC元数据管理器事件
RpcMethodMetadata	RPC方法元数据
RpcMethodSearchQuery	方法搜索查询条件
RpcOptions	RPC调用配置
RpcRegistryStats	RPC注册统计信息
RpcReliabilityConfig	RPC可靠性管理器配置
RpcReliabilityManagerEvents	RPC可靠性管理器事件
RpcReliabilityStats	RPC可靠性管理器统计信息
RpcRequestData	RPC请求数据
RpcResponseData	RPC响应数据
RpcStats	RPC统计信息
RpcValidationResult	RPC验证结果
SerializationResult	序列化结果
SerializationStats	序列化统计信息
SerializerConfig	序列化器配置
ServerInfo	服务器信息
ServerRpcOptions	服务端RPC装饰器选项
SSLConfig	SSL配置
StateSyncData	状态同步数据
SyncBatch	同步批次数据
SyncVarDeltaData	序列化差量数据
SyncVarDeserializationResult	反序列化结果
SyncVarMetadata	SyncVar元数据
SyncVarOptions	SyncVar配置选项
SyncVarSerializationResult	序列化结果
SyncVarSerializerConfig	序列化配置
SyncVarStatEntry	SyncVar统计信息条目
SyncVarStatsMap	SyncVar统计信息映射
VersionedData	版本化数据

Variables

Variable	Description
DEFAULT_SYNCVAR_OPTIONS	默认SyncVar配置
globalCompressor	全局压缩器实例
SYNCVAR_METADATA_KEY	存储SyncVar元数据的Symbol键

Type Aliases

Type Alias	Description
ClientRpcInvoker	客户端RPC调用接口类型
NetworkMessage	消息类型联合
RpcMethod	RPC方法签名类型
RpcMethodRegistry	RPC方法注册表类型
ServerRpcInvoker	服务端RPC调用接口类型
SyncVarValue	SyncVar支持的值类型