星火 2.0 开发文档

主题

EngineInterface.Enum ​

AnimationBodyPart 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum AnimationBodyPart

枚举值 ​

  • FullBody — 指定的动画可能会影响模型的全身。
  • UpperBody — 指定的动画只会影响模型的上半身。
  • LowerBody — 指定的动画只会影响模型的下半身。

AnimationLogicLayer 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum AnimationLogicLayer

逻辑层本质上是另一个层面的动画优先级，拥有着一些内置逻辑用于播放内置动画。动画系统会先考虑层级参数再考虑优先级参数。

枚举值 ​

  • Rollback = 0 — 上层没有动画播放时，都会回滚到这里，主要包含待机、移动等
  • Normal = 1 — 用来播放标准动画。内置一些优先级顶替逻辑。
  • Unrestricted = 2 — 可以随意播放动画不受限制
  • LowerBody = 6 — 用于类似骑马等需要维持下半身姿势的动画。

AnimationStateEvent 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum AnimationStateEvent

Represents the types of events that can occur for an animation.

枚举值 ​

  • Suppressed = 1 — The animation was suppressed by another animation with higher priority or logic layer.
  • Surfaced — The animation has become active, either by being played alone on its actor or by no longer being suppressed.
  • Completed — The animation has finished playing.
  • Removed — The animation was removed from the system, either by being stopped or because its actor was removed.

EngineAnimationType 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum EngineAnimationType

枚举值 ​

  • Normal = 0
  • Birth = 1
  • Idle = 2
  • Move = 3
  • Death = 4
  • Bracket = 6

GameDeploymentEnvironment 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum GameDeploymentEnvironment

当前游戏 Host 所在的部署环境，用于区分官方平台和编辑器发布通道。

备注

项目开发、测试、发布和迁移流程主要需要区分 Alpha（外网公开测试环境）和 Production（线上生产环境）。 Master 是部署通道保留值，不作为项目发布、测试或迁移目标。 部署环境与 GameRuntimeEnvironment 是两个正交维度；云数据等环境侧数据按完整组合隔离。

枚举值 ​

  • Unknown — 客户端尚未取得部署环境，或当前 SDK 暂不认识该部署值。
  • Master — 部署通道保留值，不作为项目发布、测试或迁移目标。
  • Alpha — 外网公开测试部署环境。该环境通常更早收到当周编辑器、SDK 与运行时新能力，适合项目外部验证。
  • Production — 线上生产部署环境。正式面向线上用户的项目运行在该环境，通常在外网公开测试环境验证约两周后获得同批官方能力。

GameRuntimeEnvironment 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum GameRuntimeEnvironment

当前游戏局的运行时环境，用于区分项目自己的调试、内测和正式数据隔离环境。

备注

运行时环境描述当前游戏局的开放范围和数据隔离标签，不等同于官方部署环境。 Debug 用于调试模式，Test 用于项目内测，Formal 用于项目正式环境。 它与 GameDeploymentEnvironment 是两个正交维度；云数据等环境侧数据按完整组合隔离。

枚举值 ​

  • Unknown — 客户端尚未取得运行时环境，或当前 SDK 暂不认识该运行时标签。
  • Debug — 调试运行时环境。通常用于编辑器调试、远端调试或其他开发调试链路。
  • Test — 项目内测运行时环境。用于项目尚未正式上线、但希望邀请玩家参与测试的游戏环境。
  • Formal — 项目正式运行时环境。用于正式发布、上架审核通过后面向公开玩家开放的游戏环境。

OperationMailResult 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum OperationMailResult

Result codes returned by operation mail queries.

枚举值 ​

  • ServiceNotInitialized = -600000 — The operation mail service or provider is not initialized.
  • LocalOperationFailed = -500000 — The query failed before it could be sent to the host.
  • TooManyReadOperations = -400000 — Operation mail queries were issued too frequently in a short period.
  • FailedToSend = -200000 — The operation mail query could not be sent to the service.
  • QueryEnvironmentMissing = -200005 — The environment argument is missing.
  • QueryMapNameMissing = -200004 — The map name argument is missing.
  • QueryUserIdMissing = -200002 — The user id argument is missing or invalid.
  • Success = 0 — The query succeeded.
  • BackendQueryFailed = 3 — The operation mail query failed.
  • MessageSizeTooLarge = 4 — The operation mail request or response exceeded the supported service message size.
  • MySqlOperationLimitExceeded = 20 — The service rejected the request because an operation limit was exceeded.
  • ResultParseFailed = 101 — The operation mail response could not be parsed.
  • QueryConnectionTimeout = 103 — The operation mail query timed out.

Platform 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum Platform

枚举值 ​

  • Windows
  • EditorMobileSimulation
  • Android
  • iOS
  • macOS
  • tvOS
  • Linux
  • Browser
  • RaspberryPi
  • WeChatMiniProgram
  • Unknown

SessionResidenceResult 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum SessionResidenceResult

Result of a request to change whether the current server session is resident.

枚举值 ​

  • Success — The requested state is active, or was already active.
  • ProjectLimitReached — The project already has the maximum of three resident sessions.
  • ServiceUnavailable — The request could not be processed because the required platform service is unavailable.
  • InvalidSessionState — The current game session is ending, the runtime environment does not support resident sessions, or the session otherwise cannot change residence state.

TransactionOperationType 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum TransactionOperationType

事务操作类型

枚举值 ​

  • SetBlob
  • DeleteBlob
  • SetBigInt
  • AddBigInt
  • DeleteBigInt
  • SetVarChar255
  • DeleteVarChar255
  • AddCurrency
  • CostCurrency
  • AddListItem
  • UpdateListItem
  • DeleteListItem
  • MoveListItem
  • ModifyCapped
  • ResetCapped
  • ClaimNewName
  • DeleteName
  • PlatformMoneyCost

UserCloudDataResult 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum UserCloudDataResult

枚举值 ​

  • ServiceNotInitialized = -600000 — Indicates that the UserCloudData service has not been initialized yet. Operations cannot be performed until the Game.OnUserCloudDataServiceInitialization event has been triggered.
  • LocalOperationFailed = -500000 — Indicates that an unexpected exception occurred during local code execution, such as when constructing requests, making cloud calls, parsing responses, or processing data. This is not an error returned by the cloud server, but rather a local runtime error.
  • TooManyReadOperations = -400000 — Indicates that cloud data read operations were issued too frequently in a short period. Batch reads and avoid tight retry loops before trying again.
  • TooManyWriteOperations = -300000 — Indicates that cloud data transaction submissions were issued too frequently in a short period. Merge related changes into fewer transactions and retry later.
  • FailedToSend = -200000 — Indicates that the cloud data request could not be sent to the service.
  • QueryNameMissing = -200003
  • QueryUserIdMissing = -200002 — Represents an error code indicating that a required user ID is missing in the query.
  • QueryKeyMissing = -200001 — Indicates that a required query key is missing in the query parameters.
  • TransactionCommitEmpty = -100001 — Represents an error code indicating that a transaction commit operation was attempted with no changes to commit.
  • Success = 0
  • InsufficientCurrency = 1 — 货币金额不足，无法完成操作。
  • NameAlreadyExists = 2
  • DatabaseQueryFailed = 3
  • MessageSizeTooLarge = 4 — The cloud data message exceeded the supported service message size. Reduce payload size or split the work across later requests.
  • InsufficientPermission = 5
  • UnknownMessage = 6
  • TransactionProtocolParseFailed = 7
  • UnknownTransactionOperation = 8
  • QueryProtocolParseFailed = 9
  • UpdateQueryParameterMissing = 10
  • UnknownUpdateQueryMessage = 11
  • ParameterMissing = 12
  • Unauthorized = 13
  • TooManyUserIdsForQuery = 14
  • NameQueryFailed = 15
  • NameDeleteFailed = 16
  • ListQueryFailed = 17
  • ListItemNotFoundForUserKey = 18 — Indicates that the specified list item UUID does not exist in the list associated with the given key and user ID, but may exist in the database.
  • UnexpectedRuntimeEnvironment = 19
  • MySqlOperationLimitExceeded = 20 — The cloud data service rejected the request because an operation limit was exceeded.
  • NegativeCurrencyCostNotAllowed = 21
  • CapExceeded = 22 — 上限数据值超出设定的上限，无法完成操作。通常发生在 ModifyCappedData 操作中。
  • DataLogQueryFailed = 23
  • MemoryLimitExceeded = 24
  • InputTableMissingForMerge = 25
  • UnknownMySqlExceptionDuringTransaction = 99
  • UnknownMySqlException = 100
  • ResultParseFailed = 101
  • UnknownCloudServerMessage = 102
  • QueryConnectionTimeout = 103
  • DeadlockDetected = 1213
  • LockWaitTimeout = 1205
  • SortingConversionError = 3988
  • TableNotFound = 1146
  • DataSizeExceeded = 1406 — A single stored value exceeded the size supported by its cloud data field type.
  • SqlSyntaxError = 1064
  • UnsignedIntegerOverflow = 1690
  • DuplicateEntry = 1062
  • ItemCountLimitExceeded = 1235
  • ConnectionLost = 2013
  • UnknownColumn = 1054
  • ConcurrentWaitCountExceeded = 7534

UserDataResetPeriod 双端 ​

命名空间 EngineInterface.Enum

csharp
public enum UserDataResetPeriod

枚举值 ​

  • Hourly — 每X小时重置一次，注意重置时机是每小时的整点
  • Daily — 每X天重置一次，注意重置时机是每天的0点
  • Weekly — 每X周重置一次，需要结合具体的周几来使用，注意重置时机是每周的0点
  • Monthly — 每X月重置一次，注意重置时机是每月的1号
  • Yearly — 每X年重置一次，注意重置时机是每年的1月1日
  • Never — 永不重置