主题
枚举 Enum
共 66 个类型。
- AccessoryBindType: 该枚举表示蛋仔配饰的挂接部位,用于确定配饰佩戴在蛋仔身上的具体位置,涵盖头部、腰部和背部三种挂点。在装扮相关逻辑中,通过该枚举可以统一描述配饰的佩戴位置,并据此进行展示或挂载处理。
- ActivePayerStatus: ActivePayerStatus 枚举表示平台定义的玩家付费活跃度分层。
- ActuatorRelativeTo: ActuatorRelativeTo 枚举定义执行器参考坐标系的三种语义:Attachment0、Attachment1 与 World。
- ActuatorType: ActuatorType 枚举定义了物理约束的驱动方式,用于指定马达或伺服机构的行为模式。它包含三种成员:None 表示无驱动,Motor 表示以恒定速度驱动,Servo 表示以目标位置驱动。
- AnimationFilterType: AnimationFilterType 枚举用于限定动画影响的身体部位,可分别选择头部、躯干、左臂、右臂、左腿或右腿。
- AnimationPriority: AnimationPriority 枚举定义了动画轨道的播放覆盖顺序,用于控制多个动画同时播放时哪个动画的姿势优先显示。开发者可用的优先级从低到高依次为 Idle、Movement、Action、Action2、Action3、Action4,其中 Action4 是最高优先级,会覆盖所有低优先级动画;Core 是引擎内部保留的最低优先级,供默认动画兜底使用,开发者不应主动设置。
- AssetPermission: AssetPermission 枚举表示从不可用、无访问权到拥有资产的权限等级。
- AxisType: AxisType 枚举表示 RIGHT、UP 与 FORWARD 三个标准轴向。
- BakeMode: BakeMode 是寻路烘焙模式枚举,用于控制 PathfindingModifier 对导航网格烘焙的参与方式。它提供 Auto、Force、Ignore、Disable 四种模式,便于按区域决定是否自动烘焙、强制烘焙、忽略或禁用导航烘焙。
- BodyType: BodyType 枚举定义物理刚体的运动行为:None 不参与物理模拟,Static 为固定碰撞体,Kinematic 由脚本驱动位置,Dynamic 完全由物理引擎模拟。
- CameraMode: CameraMode 枚举定义了相机单元的行为模式,用于控制相机如何跟随或观察场景中的目标。通过设置 CameraUnit 的 Mode 属性为不同枚举值,可以切换相机的跟踪方式,例如绑定到角色、自由脚本控制或固定视角。
- CameraProjection: 相机投影方式枚举定义了摄像机将三维场景投射到二维屏幕时采用的投影模型。透视投影模拟人眼近大远小的视觉效果,正交投影则保持物体尺寸不随距离变化,常用于二维界面或等距视角。
- CameraShakeCurve: 相机震动曲线枚举定义了相机震动时使用的波形类型,用于控制震动的节奏和强度变化模式。它提供正弦波和噪声两种曲线,分别产生平滑周期震动和随机不规则震动效果。
- CameraShakeType: 相机震动类型枚举定义了相机震动时可用的不同运动模式,用于控制震动效果的表现形式。它提供了前后移动、上下移动和旋转三种震动方式,供开发者在调用相机震动接口时选择。
- CameraType: CameraType 枚举定义 CameraUnit 的镜头行为类型,包括固定、附着、注视、追踪、跟随、自定义、脚本控制与环绕模式。
- CampRelationType: CampRelationType 枚举定义阵营关系标签,用于表达自身、敌对、友好、中立、除自身外全部和全部阵营等筛选语义。
- ChatStyle: ChatStyle 枚举定义当前客户端聊天 UI 的经典面板与头顶气泡显示组合。
- ColorGradingFilter: 色彩分级滤镜枚举定义了可应用于 ColorGradingEffect 的预设色彩风格,如复古、黑白、冷暖色调等。通过设置 Filter 属性为枚举成员,可快速切换画面的整体色彩氛围,配合 FilterStrength 调整强度。
- ConstraintType: ConstraintType 枚举列出 Spring、Hinge、BallAndSocket、Fixed、Slider、D6、Weld 与 Rod 等约束类别。
- ConsumptionMode: ConsumptionMode 枚举定义商品或资源的消耗策略,用于区分永久拥有、按数量扣减和按时间限制三类模式。
- ControllerStateType: ControllerStateType 枚举定义了角色控制器可能处于的各种行为状态,如待机、移动、跳跃、攀爬、死亡等。通过监听控制器的状态变化事件,可以在不同状态间切换时触发对应的游戏逻辑。
- CoreGuiType: CoreGuiType 枚举定义了可控制显示或隐藏的核心界面控件类型,包括摇杆、跳跃按钮、冲刺按钮、翻滚按钮、举人按钮、战斗按钮、重置按钮、聊天按钮、表情按钮、玩家列表、生命值、背包、聊天框、顶部栏容器、退出菜单、控制栏和表情菜单。通过该枚举,开发者可以精确管理玩家界面上特定控件的可见性。
- DataStoreErrorCode: DataStoreErrorCode 枚举定义 DataStore 与 OrderedDataStore 相关操作可能涉及的数据存储错误状态,例如参数非法、请求限流、存储不存在、版本无效等。
- DataStoreType: DataStoreType 枚举用于标识数据存储集合类型,包括普通数据存储、有序数据存储和全局数据存储。
- DefaultCameraPresetType: DefaultCameraPresetType 枚举定义 CameraService.DefaultCameraPreset 可使用的默认相机预设。
- DevCameraOcclusionMode: DevCameraOcclusionMode 枚举定义了相机在遇到遮挡物时的处理策略。它提供了三种模式:Zoom 表示拉近相机距离以避免遮挡,Invisicam 表示使遮挡物透明化,EggyHybrid 表示混合使用前两种策略。开发者可通过 CameraUnit 的 DevCameraOcclusionMode 属性来切换这些模式。
- DevTouchMovementMode: DevTouchMovementMode 是移动端触摸移动模式枚举,用于配置玩家在触屏设备上的虚拟摇杆行为。通过 Enums.DevTouchMovementMode 引用其成员,可设置固定摇杆、动态摇杆或跟随用户偏好等模式。
- DisplayDistanceType: DisplayDistanceType 枚举控制生物头顶名字与血条的显示距离判定方式。它提供三种模式:不显示、按观察者距离显示、按被观察者距离显示,用于灵活适配不同视角下的信息可见性。
- EasingDirection: EasingDirection 枚举定义缓动曲线在补间时间轴上的作用阶段:In 表示缓动效果主要作用于开始阶段,Out 表示作用于结束阶段,InOut 表示两端都应用,OutIn 表示先按 Out 再按 In 组合。
- EasingStyle: EasingStyle 定义了动画缓动曲线类型,用于控制补间动画在时间进程中的速度变化模式。它提供了从线性匀速到弹性、弹跳等多种预设曲线,让开发者可以精细调整动画的加速与减速效果。
- EffectBindType: 特效绑定类型枚举定义了特效挂载到目标对象时的空间变换方式。它控制特效是否跟随目标的位置、旋转或缩放,从而影响特效在场景中的表现形态。
- FaceStatus: FaceStatus 枚举定义蛋仔角色可播放的动态表情状态,包含开心、伤心、生气、思考、震惊、大笑、说话等常见表情。
- FashionPartType: 蛋仔散件时装的部位类型枚举,用于区分头部、上半身与下半身三个换装部位。它配合蛋仔外观接口实现按部位设置或读取时装,也用于按部位重置外观。
- FieldOfViewMode: FieldOfViewMode 枚举定义了摄像机视场角的计算基准,决定视野范围以哪个轴向为准。它提供 Vertical、Diagonal 和 MaxAxis 三种模式,用于控制画面中可见区域的宽窄。
- GradientSkyDirection: 渐变天空渐变轴向枚举,用于控制 GradientSky 组件中颜色渐变的方向。它提供 X 轴和 Y 轴两个选项,分别对应水平渐变和垂直渐变,从而改变天空背景的视觉效果。
- HorizontalAlignmentType: HorizontalAlignmentType 枚举定义 TextUnit 文本的左对齐、居中和右对齐方式。
- HpBarShowMode: HpBarShowMode 枚举控制角色头顶血条的显示策略,支持始终隐藏、始终显示或仅在生命值不满时显示三种模式。通过 BaseController 的 HPBarShowMode 属性设置,可灵活适配不同游戏场景的 UI 需求。
- HumanMeshColor: HumanMeshColor 枚举标识人形模型或蒙皮的染色区域,公开成员 COLOR1 至 COLOR4 分别对应四个材质染色槽。
- KeyCode: KeyCode 枚举定义了键盘、鼠标等输入设备的按键标识符,用于在输入事件中判断具体按下了哪个键。通过 Enums.KeyCode 命名空间引用成员,可配合 UserInputService 的输入事件获取当前按键信息。
- MemoryStoreErrorCode: MemoryStoreErrorCode 枚举定义 MemoryStore 数据结构操作可能涉及的错误状态,例如未发布作品不可用、客户端非法访问、请求限流、容量超限、键不存在或更新条件不满足等。
- MessageType: 日志消息类型枚举,用于区分日志输出的严重程度或类别。它定义了四种标准消息类型:普通输出、信息、警告和错误,供日志系统在记录和过滤时使用。
- MouseBehavior: 鼠标行为枚举,用于设定鼠标光标在屏幕上的工作方式,例如是否锁定到屏幕中心或保持默认自由移动。它配合用户输入服务中的相关接口使用,以便切换不同的鼠标控制模式。
- NetworkOwnerChangeType: NetworkOwnerChangeType 枚举定义网络所有权策略值,用于表达物理对象由系统自动处理所有权,或由脚本按业务逻辑手动处理。
- PathStatus: 路径计算状态枚举,用于表示寻路请求的最终结果。包含成功和无路径两种状态,帮助开发者判断路径是否有效。
- PathWaypointAction: PathWaypointAction 枚举定义了寻路路径点上的行为类型,用于标记角色到达该点后应执行的动作。它包含 Walk(行走)、Jump(跳跃)和 Custom(自定义)三种选项,供寻路系统在生成路径时使用。
- PlayerPlatformSpenderStatus: PlayerPlatformSpenderStatus 枚举表示平台定义的玩家跨平台消费状态分类。
- PresetLinkStatus: 预设链接状态枚举用于表示预设资源链接的同步状态,帮助判断本地预设是否与源资源保持一致。它提供了四种状态:已是最新、本地已修改、有新版本可用、以及同时存在本地修改和新版本。
- PresetSkyTemplate: PresetSkyTemplate 枚举定义 PresetSky.Template 可使用的固定天空模板。
- RaycastFilterType: 射线过滤类型枚举用于控制射线检测或重叠检测时,如何对待传入的实例列表。Exclude 表示跳过列表中的实例,Include 表示仅检测列表中的实例。
- SkeletalSocketType: SkeletalSocketType 枚举定义蛋仔外观挂接可用的标准骨骼挂点,如 Head、Spine、LHand、RHand 等。
- SkyTemplate: 天空模板枚举定义了引擎内置的天空视觉效果预设,每个成员代表一种完整的天空外观方案。通过将枚举值赋给 Sky 对象的 Template 属性,可以快速切换场景的天空氛围,无需手动调整多个参数。
- SortDirection: SortDirection 枚举定义 MemoryStoreSortedMap 范围查询的排序方向,Ascending 表示按排序键升序返回,Descending 表示按排序键降序返回。
- TableMajorAxis: TableMajorAxis 枚举用于指定表格布局的主轴方向,决定子元素按行优先还是列优先排列。它直接影响 EUITableLayout 等 UI 组件的自动布局行为。
- TeleportErrcode: TeleportErrcode 枚举定义传送初始化失败或传送结果通知中可能出现的错误码,用于区分成功、失败、地图不存在、服务器已满、权限不足、请求过频、超时等状态。
- TeleportState: 传送状态枚举描述了玩家在跨服务器传送过程中所处的各个阶段。它覆盖了从发起请求到最终完成或失败的完整生命周期,帮助开发者在不同阶段执行对应的逻辑处理。
- TextChatChannelType: TextChatChannelType 枚举定义文字聊天的官方频道类型,目前包含全体频道与阵营频道两类。
- TextFontType: TextFontType 枚举定义了文本组件可用的字体样式,包含黑体、圆体、标宋、魏碑等多种中文字体。通过设置 TextUnit 的 FontName 属性或 EUITextLabel/EUIRichTextLabel/EUIInputField 的 Font 属性,可以切换文本的显示字体。
- TextOverflowStrategy: TextOverflowStrategy 枚举定义了文本内容超出显示区域时的三种处理策略。它允许开发者选择不处理溢出、直接截断超出部分,或启用跑马灯滚动效果来完整展示长文本。该枚举通常与 TextUnit 的 OverflowStrategy 属性配合使用,以控制文本的溢出行为。
- ThumbnailSize: ThumbnailSize 枚举表示 Players:GetUserThumbnailAsync 的名义头像尺寸规格,成员名覆盖 48x48 至 720x720。
- ThumbnailType: ThumbnailType 枚举定义 Players:GetUserThumbnailAsync 可请求的头像缩略图类型。
- TweenPlayState: TweenPlayState 枚举定义 Tween.PlaybackState 属性可能返回的播放阶段,包括 Begin、Delayed、Playing、Paused、Completed 和 Cancelled。
- TweenStatus: TweenStatus 枚举表示 EUI 节点补间动画的结束状态,用于区分补间是正常播放完成还是被同通道的新补间抢占取消。
- UserInputState: UserInputState 枚举描述用户输入事件的生命周期阶段,包括开始、变化、结束、取消和未知状态。它用于在输入处理流程中标识当前输入动作所处的具体阶段,帮助开发者精确响应不同类型的输入变化。
- UserInputType: UserInputType 枚举定义了用户输入设备的类型,用于区分鼠标、键盘、触屏、手柄等不同输入来源。在输入事件中,通过该枚举可以判断当前操作由哪种设备触发,从而针对不同设备实现差异化的交互逻辑。
- VerticalAlignmentType: VerticalAlignmentType 枚举定义 TextUnit 文本的顶部、居中和底部对齐方式。
- WhenUserFirstPlayed: WhenUserFirstPlayed 枚举表示玩家首次进入游戏的时间段划分,用于区分新老玩家群体。它提供了一组预定义的区间值,如 Unknown、Days0To30、Days31To90 等,帮助开发者根据玩家注册时长进行差异化处理。
