Build metadata (engine git commit, build time, third-party version). 更多...

命名空间
namespace	action

namespace	action_editor

namespace	agent

namespace	animation

namespace	animation_editing

namespace	animation_editor

namespace	archspace

namespace	archspace_editing

namespace	archspace_editor

namespace	artifact

namespace	asset

namespace	asset_graphics

namespace	asset_import

namespace	asset_physics

namespace	asset_procgen

namespace	asset_scene

namespace	asset_stylize

namespace	attributes

namespace	audio

namespace	audio_editing

namespace	audio_editor

namespace	authority

namespace	avatar

namespace	avatar_editing

namespace	avatar_editor

namespace	biome_editing

namespace	biome_editor

namespace	boot

namespace	building
	建筑放置模块入口：定义 / 放置世界 / 鬼影 / 变更事件的脚本绑定点。设计文档：docs/dev/建筑放置系统设计.md

namespace	building_editing

namespace	buildingfx

namespace	camera

namespace	camera_editing

namespace	cap

namespace	caps

namespace	card

namespace	climbing

namespace	cloth

namespace	cmd

namespace	cmdline
	Minimal streaming ZIP writer used by `eve zip` / `eve package` to produce a PhysFS-mountable game archive (.eve). Entries are DEFLATE-compressed (method 8) using zlib's raw deflate. The output is a standard ZIP readable by PhysFS.

namespace	combat

namespace	container

namespace	crowd

namespace	crowd_editing

namespace	data

namespace	database

namespace	daynight

namespace	debug

namespace	decal

namespace	decal_editing

namespace	decision

namespace	definition

namespace	definitions

namespace	definitions_editing

namespace	demo

namespace	detail

namespace	dev

namespace	dialogue

namespace	dialogue_editing

namespace	dnut

namespace	domain_gizmo_editing

namespace	economy

namespace	editing

namespace	editor

namespace	effects

namespace	emergence

namespace	filesystem

namespace	fluids
	GLSL compute kernels for the GPU surface-flow solver.

namespace	fluids_editing

namespace	fluids_editor

namespace	font

namespace	game_event

namespace	gpgpu
	Fluids module — interactive surface fluid simulation.

namespace	gpuagents

namespace	gpuagents_editing

namespace	gpuagents_editor

namespace	graphics
	卡牌游戏 UI 工具模块：工厂 + 脚本绑定入口。功能参考 ycarowr/UiCard：扇形手牌布局、抽牌/洗牌、悬浮放大、拖拽到落牌区、敌方手牌（背面/偷看）、费用不足置灰，以及可实时调节的布局参数。数据模型与渲染/交互逻辑见 CardTypes.h。

namespace	graphics_editing

namespace	graphics_editor

namespace	grid

namespace	hd2d

namespace	hd2d_editing

namespace	heightmap_target

namespace	hexmap

namespace	housegen

namespace	housegen_editing

namespace	i18n

namespace	ik

namespace	image

namespace	input_editing

namespace	inventory
	运行时容器：固定格数的背包 / 箱子 / 商店栏等。行为由 InventorySystem 提供；本类暴露便于脚本绑定的薄封装方法。

namespace	joystick

namespace	json

namespace	keyboard

namespace	level_editing

namespace	level_editor

namespace	lighting_editing

namespace	localization_editing

namespace	map
	放置世界：格子占用（多通道）+ 地形语义 + 已放置建筑实例。行为由 PlacementSystem 提供；本类暴露便于脚本绑定的薄封装方法。坐标换算统一走 eve::grid（支持 rectangle / iso / staggered / hex 与 XY/XZ 平面轴）。

namespace	map_editing

namespace	material_editing

namespace	material_editor

namespace	math

namespace	model3d

namespace	mouse

namespace	network

namespace	network_editing

namespace	npc_ai

namespace	npc_ai_editing

namespace	orders

namespace	os

namespace	particles

namespace	particles_editing

namespace	particles_graphics_editing

namespace	physics
	Optional physics backend for vehicle mobility and body attach.

namespace	physics_editing

namespace	physics_editor

namespace	pixelworld

namespace	pixelworld_editor

namespace	pixelworld_graphics

namespace	pixelworld_physics

namespace	pixelworld_replay

namespace	pixelworld_streaming

namespace	pixelworld_thread

namespace	platform_event

namespace	plugins

namespace	policyregistry

namespace	procgen

namespace	procgen_animation

namespace	procgen_editing

namespace	procgen_editor

namespace	procgen_graphics_editing

namespace	procgen_physics

namespace	production

namespace	prof

namespace	profiler

namespace	profiler_editing

namespace	property_access

namespace	queue_editing

namespace	resource

namespace	rpg
	RPG 模块的基础实体：把属性 / 状态 / 技能三张表挂到一个 ECS 实体上。

namespace	rts

namespace	rx

namespace	scene

namespace	scene_editing

namespace	scene_editor

namespace	scene_physics

namespace	sceneloader

namespace	sceneloader_editing

namespace	scheduling

namespace	schema

namespace	script

namespace	sensing

namespace	service

namespace	settlement

namespace	social

namespace	social_editing

namespace	sound

namespace	spatial

namespace	spritestack

namespace	spritestack_editing

namespace	state

namespace	statepatch

namespace	stylize

namespace	stylize_action

namespace	stylize_editing

namespace	tactics

namespace	tags

namespace	tensor

namespace	thread

namespace	tilelayer_target

namespace	timer

namespace	touch

namespace	transaction

namespace	ui

namespace	ui_editing

namespace	ui_editor

namespace	vehicle
	驾驶者接口与玩家控制状态。

namespace	virtualgeometry

namespace	virtualgeometry_editing

namespace	voxel
	方块类型定义：名字、各面图集纹理、方向性、组合声明。方向性方块在注册时按 orientation 绕 Y 轴展开成多个"具体类型"变体，每个变体持有旋转后的各面纹理；渲染端只消费纹理 id，不接触 orientation。

namespace	voxel_editing

namespace	voxel_editor

namespace	voxelworld_target

namespace	weapon
	载具模块入口（eve.Vehicle）：定义注册 / 实体工厂 / RTS 命令 / 帧调度。设计文档：docs/dev/通用载具系统设计.md

namespace	weather

namespace	window

namespace	xml

类
class	AssetRef
	Stable asset identity backed by PersistentId. 更多...

struct	AttachmentPoint
	Plain world-space point shared by animation consumers without a math-library dependency. 更多...

struct	CameraObstructionHit
	Closest hit returned by the optional camera-obstruction provider. 更多...

class	Data
	Data public API. 更多...

class	DefinitionRef
	Stable definition reference backed by LogicalId. 更多...

class	Diagnostic
	A structured explanation of a failed, degraded, or noteworthy result. 更多...

struct	DiagnosticValueTraits
	Customization point for values that cross diagnostic boundaries. 更多...

struct	DiagnosticValueTraits< DiagnosticCode >
	DiagnosticValue mapping for machine-readable diagnostic codes. 更多...

struct	DiagnosticValueTraits< ProtocolDispatch >
	DiagnosticValue mapping for protocol dispatch outcomes. 更多...

struct	DiagnosticValueTraits< Severity >
	DiagnosticValue mapping for diagnostic severities. 更多...

struct	DiagnosticValueTraits< StatusCode >
	DiagnosticValue mapping for operation status categories. 更多...

class	Duration
	Signed, fixed-resolution simulation duration in nanoseconds. 更多...

struct	EntitySpatialPose
	Renderer-neutral owning world pose resolved for an ECS entity. 更多...

class	Exception
	EVENGINE_API_FOUNDATION public API. 更多...

struct	GameplayActionDescriptor
	One discoverable domain action and its owning schema projection. 更多...

struct	GameplayCommand
	One player-semantic command submitted to a domain authority. 更多...

struct	GameplayCommandReceipt
	Owning evidence that a gameplay authority accepted one command. 更多...

struct	GameplayEvent
	Owning event projection safe across frames and process boundaries. 更多...

struct	GameplayObservation
	Immutable owning observation of one authoritative gameplay instance. 更多...

struct	GameplaySession
	Owning authorization context shared by player, script and automation adapters. 更多...

struct	GpuResidentBufferView
	Transient backend buffer slice shared between sibling GPU modules. @ownership Non-owning; nativeHandle is never retained as an owning resource. @lifetime The producing buffer outlives all frame commands that consume this view. @thread Create and consume on the render/submission thread. 更多...

class	IAnimationEventSource
	Read-only cross-module view of animation events emitted by the latest simulation update. @ownership Event names are returned by value; consumers retain no source storage. @thread Affine to the animation source's update thread. @reentrancy Implementations must not invoke callbacks. 更多...

class	IAttachmentPointSource
	Read-only cross-module contract for sampling named animated attachment points. @ownership Implementations retain all pose data; returned points are values. @thread Calls are affine to the source's animation update thread. @reentrancy Implementations must not invoke callbacks. 更多...

class	IAudioQuery
	Audio control surface (provided by the audio module). 更多...

class	ICameraObstructionQuery
	Cross-module query used by camera without linking against physics. 更多...

class	IDecalQuery
	Runtime decal query surface (provided by the decal module). 更多...

class	IEditorAutomation
	Module-neutral bridge from DevTools/MCP to the editor command protocol. 更多...

class	IEditorHost
	Declarative editor-host control (provided by the ui module). 更多...

class	IEmergenceActionHandler
	Capability listener that may consume one emergence action kind. 更多...

class	IEntitySpatialProvider
	One optional domain provider capable of resolving selected ECS entities. 更多...

class	IFramePacing
	Host-loop frame pacing controlled independently of presentation. 更多...

class	IFramePresentation
	Cross-module owner for swapchain presentation cadence. 更多...

class	IGameplayControlProvider
	Multi-provider gameplay boundary consumed by input, scripts and automation. 更多...

class	IGameplayInstanceCatalog
	Optional read-only discovery surface implemented beside a gameplay provider. 更多...

class	IMeshDeformationCompute
	Optional synchronous device-thread service for mesh sculpt and damage compute. 更多...

class	IParticleSdfField
	Borrowed 2D signed-distance field consumed by particle collision. 更多...

class	IParticlesQuery
	Particle system query surface (provided by the particles module). 更多...

class	IPhotoModeApplySink
	IPhotoModeApplySink public API. 更多...

class	IPhotoModeFieldSink
	IPhotoModeFieldSink public API. 更多...

class	IPhysicsQuery
	2D physics world query surface (provided by the physics module). 更多...

class	IPixelWorldAutomation
	Module-neutral JSON bridge from DevTools/MCP to PixelWorld tooling. 更多...

class	IProcgenProbeSink
	Optional graphics consumer for complete generated probe batches. Implementations own all runtime resources and replace a batch atomically. Inputs are borrowed only for the call. 更多...

class	IProcgenQuery
	Procedural generation query surface (provided by the procgen module). 更多...

class	IProcgenSceneSink
	Optional scene consumer for procedural instance batches. 更多...

class	IProcgenWorldQuery
	Optional synchronous world-query capability for procedural generation. 更多...

class	IProfilerQuery
	Runtime profiler read surface (provided by the profiler module). 更多...

class	IRenderCapture
	Frame capture + camera + visible-entity inspection (graphics). 更多...

class	ISceneQuery
	Scene graph query/mutation surface (provided by the scene module). 更多...

class	ISensingQuery
	Runtime sensing read surface (provided by the sensing module). 更多...

class	ISnapshotContentHasher
	One content-digest implementation usable for snapshot sealing and verification. 更多...

class	ITimeSource
	Injectable source for elapsed and metadata time. 更多...

class	IUIAutomation
	Semantic retained-UI automation provided by the ui module. 更多...

class	IWindowSurfaceHost
	Render-surface host for the window module (provided by graphics). 更多...

class	LogicalId
	Human-readable, scoped identifier in the form `namespace:name`. 更多...

struct	MeshDeformationComputeRequest
	Owning, backend-neutral input for one synchronous GPU mesh deformation. 更多...

class	Module
	EVENGINE_API_FOUNDATION public API. 更多...

struct	ModuleBindAccess

class	ModuleManager
	EVENGINE_API_FOUNDATION public API. 更多...

struct	ModuleRegister
	EVENGINE_API_FOUNDATION public API. 更多...

class	MonotonicTimestamp
	Timestamp from a monotonic source. 更多...

class	ObjectRef
	Stable world/object identity backed by PersistentId. 更多...

class	Observer
	Thread-affine callback registry with mutation-safe dispatch. 更多...

struct	PhotoModeAssignment
	One reversible field assignment in a photo-mode transaction. 更多...

struct	PhotoModeColor
	RGBA payload used by the cross-module photo-mode application contract. 更多...

struct	ProcgenBatchSnapshot
	One complete cell snapshot participating in an atomic multi-batch publication. 更多...

struct	ProcgenInstanceDelta
	Identity-based, revision-checked mutation of one procedural scene batch. 更多...

struct	ProcgenInstanceDesc
	Engine-neutral description of one procedural scene instance. 更多...

struct	ProcgenProbeDesc
	Engine-neutral description of one generated reflection or light probe. 更多...

struct	ProcgenSurfaceHit
	Value result for a procedural world-surface projection query. 更多...

struct	RayHitInfo
	Ray-cast result (value type). 更多...

struct	Rect
	Axis-aligned integer rectangle (screen/tile space). 更多...

struct	ReflectedAttribute
	EVENGINE_API_FOUNDATION_INLINE public API. 更多...

struct	ReflectedClass
	EVENGINE_API_FOUNDATION_INLINE public API. 更多...

struct	ReflectedMember
	EVENGINE_API_FOUNDATION public API. 更多...

struct	ReflectedValue
	Typed snapshot of one live instance property. 更多...

struct	Renderable3DInfo
	Generation-qualified snapshot of one live field-backed Renderable3D. 更多...

struct	RenderStatusInfo
	Render surface / frame state snapshot (value type). 更多...

class	Resource
	Resource is a game object that is managed by the ResourceManager. It can be loaded from a file or generated at runtime. If the resource is loaded from file, a monitor will be created to watch the file changes. When the file is modified, the resource will be reloaded. If the resource is generated at runtime, it can depend on a few other resources and the ResourceManager will update the resource when the dependencies are changed. 更多...

class	ResourceManager
	ResourceManager is a singleton that manages all resources in the game. It provides a way to load, reload, and unload resources. 更多...

class	ResourceRef
	Type-safe union of the reference forms accepted by resource-facing APIs. 更多...

class	ResourceUri
	A semantically named resource locator. 更多...

class	Result
	Move-only operation result carrying either a value or Status. 更多...

class	Result< void >
	Move-only operation result for actions with no value payload. 更多...

class	Runtime
	EVENGINE_API_FOUNDATION public API. 更多...

class	RuntimeHandle
	Process-local slot identity tagged by the registry that owns it. 更多...

struct	SceneNodeInfo
	Serializable snapshot of one scene node (value type, no scene types). 更多...

class	ScriptException
	Exception raised at the public Runtime boundary. 更多...

struct	ScriptInfo
	EVENGINE_API_FOUNDATION_INLINE public API. 更多...

struct	SensingWorldQuery
	Last completed query of one live sensing world. 更多...

class	SimulationClock
	Owner-thread fixed-step scheduler driven by an injected time source. 更多...

struct	SimulationStep
	One deterministic fixed-step emitted by SimulationClock. 更多...

struct	SnapshotEnvelope
	Stable outer format shared by persistence and cross-process snapshots. 更多...

class	SnapshotMigrationChain
	One directed payload migration step. 更多...

class	StartupStage
	StartupStage public API. 更多...

class	StateValue
	JSON-compatible state value tree used by state hot reload. 更多...

class	Status
	Structured status and zero or more diagnostics for an operation. 更多...

class	SubjectRef
	Strong, domain-neutral reference to a runtime subject. 更多...

class	Subscription
	Move-only RAII token that owns one observer registration. 更多...

class	Uri
	An immutable, canonical URI value. 更多...

class	UuidIdAdapter
	UUID-backed identifier adapter for legacy textual boundaries. 更多...

class	UuidV7Generator
	Injectable UUIDv7 generator. 更多...

class	Value
	The canonical owning dynamic value used by data-facing protocols. 更多...

class	VersionedRegistry
	A registry whose live values are qualified by a monotonically increasing runtime generation. 更多...

class	WallClockTimestamp
	Wall-clock timestamp used only for metadata and diagnostics. 更多...

概念
concept	DiagnosticValue
	A value with a stable protocol name and machine-readable diagnostic code.

类型定义
template<typename T >
using	OptionalRef = std::optional< std::reference_wrapper< T > >
	Optional borrowed reference; it does not extend `T`'s lifetime.

template<typename T >
using	ResultRef = Result< std::reference_wrapper< T > >
	Checked borrowed reference carried by `Result`; it does not own `T`.

using	DiagnosticDetail = std::pair< std::string, std::string >
	A structured detail attached to a Diagnostic.

using	DiagnosticDetails = std::vector< DiagnosticDetail >
	Owning collection of diagnostic details with stable insertion order.

using	CppEntityViewFn = std::function< void(ssq::Array &out)>
	C++ 实体 → 脚本 eve.view() 桥接。用 registerCppEntityView(cls, fn) 登记脚本类的收集函数；脚本 eve.view(cls) 沿类链找到登记的 C++ 类型后调用 fn 填充输出数组。

using	PostEcsHook = std::function< void(ssq::Table &table)>
	在脚本 ECS 基类（eve.Component / eve.Entity / eve.System）注入之后执行的回调。模块用它注入"extends eve.Entity"的脚本基类（例如 eve.SceneEntity）。在 exposeECS / exposeECSToVM 末尾运行，早于任何游戏脚本。

using	EventSequence = detail::StrongUint64< detail::EventSequenceTag >
	Stream-local event ordering value; it is not a global event identity.

using	Generation = detail::StrongUint64< detail::GenerationTag >
	Registry/object replacement generation used to reject stale handles.

template<typename Tag >
using	StrongUuid = detail::Id128< Tag >
	Public alias for a tag-safe 128-bit UUID identity.

using	PersistentId = StrongUuid< detail::PersistentIdTag >
	Stable instance identity for persistence, networking and process boundaries.

using	ContentId = StrongUuid< detail::ContentIdTag >
	Deterministic identity of equivalent canonical content.

using	AssetGuid = StrongUuid< detail::AssetGuidTag >
	Stable asset identity used by sidecars, package manifests and caches.

using	DocumentId = StrongUuid< detail::DocumentIdTag >
	Stable document identity for persisted/editor-facing documents.

using	SceneObjectId = StrongUuid< detail::SceneObjectIdTag >
	Stable persisted scene-object identity; distinct from an ECS handle.

using	ArtifactId = StrongUuid< detail::ArtifactIdTag >
	Stable generated-artifact identity; content equivalence remains ContentId.

using	EventId = StrongUuid< detail::EventIdTag >
	Stable event identity for event envelopes and causal references.

using	CommandId = StrongUuid< detail::CommandIdTag >
	Stable command identity for causal references.

using	TransactionId = StrongUuid< detail::TransactionIdTag >
	Stable transaction identity for cross-module coordination and snapshots.

using	OperationId = StrongUuid< detail::OperationIdTag >
	Stable operation identity inside a persisted transaction plan.

using	EffectId = StrongUuid< detail::EffectIdTag >
	Stable effect-instance identity when an effect crosses a persistence/event boundary.

using	UuidEntropySource = std::function< bool(std::span< std::uint8_t > bytes)>
	Entropy callback used by UUIDv7 generation.

using	UuidClock = std::function< std::chrono::system_clock::time_point()>
	Clock callback used by the injectable UUIDv7 generator.

using	PhotoModeValue = std::variant< bool, std::int64_t, float, std::string, PhotoModeColor >
	Typed payload accepted by authoritative photo-mode domain owners.

using	ProtocolDispatchResult = Result< ProtocolDispatch >
	Structured result returned by protocol dispatch boundaries.

using	Color = glm::vec4
	Render-neutral RGBA color shared by graphics-facing modules.

using	ResourcePin = script::RuntimePin< Resource, ResourceCacheTag >
	Keep-alive pin on one cached resource; see script::RuntimePin.

using	Revision = detail::StrongUint64< detail::RevisionTag >
	Monotonic content/state revision used for optimistic-concurrency checks.

using	SchemaVersion = detail::StrongUint64< detail::SchemaVersionTag >
	Persistent data-format version; not a runtime replacement generation.

using	SnapshotHashProvider = std::function< Result< ContentId >(std::string_view canonicalInput)>
	Injected content-digest implementation used by snapshots.

using	IStateQuery = state::IStateQuery

using	IStateMutation = state::IStateMutation

using	StateMutation = state::StateMutation

using	MutationKind = state::MutationKind

using	MutationContext = state::MutationContext

using	MutationReceipt = state::MutationReceipt

using	SimulationTick = detail::StrongUint64< detail::SimulationTickTag >
	Deterministic simulation time step; it is not wall-clock time.

using	FrameIndex = detail::StrongUint64< detail::FrameIndexTag >
	Render/presentation frame ordinal; it is not a simulation tick.

枚举
enum class	Severity : uint8_t { Info , Warning , Error , Fatal }
	Stable severity of a diagnostic, independent of its display text. 更多...

enum class	DiagnosticCode : uint32_t { None = 0 , InvalidArgument = 1 , PreconditionViolation = 2 , NotFound = 3 , AlreadyExists = 4 , Conflict = 5 , Unsupported = 6 , Cancelled = 7 , StaleHandle = 8 , ParseError = 9 , SerializationError = 10 , InvariantViolation = 11 , Failed = 12 , HashMismatch = 13 , UnknownVersion = 14 , CallbackFailure = 15 , DialogueNotWaitingForChoice = 16 , DialogueNotWaitingForCommand = 17 , DialogueConditionRejected = 18 , DialogueRouteNotFound = 19 , ProcgenGroupDataInvalid = 20 , TypeMismatch = 21 }
	Stable machine-readable diagnostic codes. 更多...

enum class	GameplayAccess : std::uint8_t { PlayerEquivalent , TestDriver , DeveloperCheat }
	Authority profile applied by a gameplay provider before domain validation. 更多...

enum class	GpuResidentBackend : uint8_t { Unknown , Vulkan , WebGpu }
	Backend identity for a transient, non-owning resident GPU buffer view. 更多...

enum class	MeshDeformationComputeOperation : std::uint8_t { Inflate , Dent , Flatten , Directional , Smooth , Impact }
	Operation executed by an optional mesh-deformation compute provider. 更多...

enum class	ParticleSdfGradientStatus { Defined , Undefined }
	Outcome of sampling an SDF gradient for particle collision. 更多...

enum class	PhotoModeDomain { Photo =0 , FramePacing =1 , Graphics =2 , Camera =3 , Streaming =4 , Weather =5 , Lighting =6 , Water =7 , PostFx =8 , Terrain =9 , Grass =10 , Audio =11 }
	Authoritative owner selected for a Pcg photo-mode field. 更多...

enum class	PhotoModeFieldAcceptance { Rejected =0 , Accepted =1 }
	Capability implemented by the composition root that routes assignments to domain owners. 更多...

enum class	ProtocolDispatch { ReplySent , NotificationHandled , Rejected , Terminate }
	Observable disposition of one protocol input message. 更多...

enum class	BlendMode { Alpha = 0 , Additive = 1 , Opaque = 2 , Premultiplied = 3 , Multiply = 4 }
	Render-neutral 2D blend mode shared by graphics-facing modules. 更多...

enum class	ResourceRefKind : std::uint8_t { Asset , Uri , Definition , Object }
	The alternative held by a generic ResourceRef. 更多...

enum class	ScriptState { Compiled , Running , Loaded , Unloading , Unloaded , Failed }
	ScriptState public API. 更多...

enum class	ScriptStage { Compile , Execute , Reflect , Unload , Shutdown }
	ScriptStage public API. 更多...

enum class	ContentDigestKind : std::uint8_t { NonCryptographic , Cryptographic }
	What a digest implementation actually guarantees, stated rather than implied. 更多...

enum class	StatusCode : uint8_t { Ok , Applied , NoOp , Pending , Rejected , Conflict , NotFound , Unsupported , Cancelled , Failed }
	Stable outcome category for an operation. 更多...

enum class	UriScheme : std::uint8_t { Asset , Project , Builtin , Generated , Memory }
	URI schemes understood by the resource layer. 更多...

enum class	Utf8NullPolicy : std::uint8_t { Allow , Reject }
	Policy for embedded U+0000 in otherwise valid UTF-8 text. 更多...

enum class	RegistryOperation : std::uint8_t { Insert , Replace , Remove }
	Canonical mutation kind emitted by a VersionedRegistry. 更多...

函数
char *	b64_encode (const char *src, size_t srclen, size_t linelen, size_t &dstlen)
	Base64-encode data.

char *	b64_decode (const char *src, size_t srclen, size_t &dstlen)
	Decode base64 encoded data.

void	initSystemLogging (const std::string &logDir={})
	Opens (append) the crash/error log file and records a session marker.

void	recordLogEvent (const std::string &level, const std::string &message)
	Appends a timestamped event line to the crash/error log.

void	recordCrashEvent (const std::string &report)
	Records a crash report, safe to call from a crash/exception handler.

std::string	crashLogPath ()
	Path of the open crash/error log file.

void	recordSessionStart ()
	Appends a session-start marker.

void	recordSessionEnd (int exitCode)
	Appends the session-end marker carrying the process exit code.

constexpr std::string_view	severityName (Severity severity) noexcept
	Returns the stable lowercase severity spelling.

std::ostream &	operator<< (std::ostream &stream, Severity severity)
	Writes a severity for diagnostics and test output.

constexpr std::string_view	diagnosticCodeName (DiagnosticCode code) noexcept
	Return a stable, compact spelling useful for logs and diagnostics.

std::ostream &	operator<< (std::ostream &stream, DiagnosticCode code)
	Writes the stable diagnostic-code spelling to a stream.

template<DiagnosticValue T>
constexpr std::string_view	diagnosticValueName (T value) noexcept
	Return the stable name supplied by a DiagnosticValue specialization.

template<DiagnosticValue T>
constexpr DiagnosticCode	diagnosticValueCode (T value) noexcept
	Return the stable machine-readable code supplied by a DiagnosticValue specialization.

void	exposeECS (ssq::Table &table)
	脚本侧 ECS：Entity / Component / System / ShaderSystem / view（见 ECS.cpp）。 C++ 游戏实体仍直接用 ECS.hpp 的 ENTITY / COMPONENT / View。 GPU System：eve.ShaderSystem + gpgpu::ShaderSystem / EcsGpu.h。

void	prepareEcsScriptInjection ()
	Resets per-VM script injection bookkeeping before a new VM is exposed.

void	registerCppEntityView (const ssq::Class &cls, CppEntityViewFn fn)
	Registers cpp entity view.

void	registerPostEcsHook (PostEcsHook fn)
	Registers post ecs hook.

void	flushPostEcsHooks (ssq::Table &table)
	Run post-ECS hooks that were registered after `exposeECS` already ran.

void	exposeECSToVM (ssq::VM &vm)
	在 ModuleManager::expose 之后调用；保证 eve.Component 等不被其它模块覆盖。

Result< EntitySpatialPose >	resolveEntitySpatialPose (ecs::EntityHandle entity, std::string_view bone={})
	Resolve through registered providers in deterministic registration order.

Result< Value >	executeGameplayControlRequest (const Value &request)
	Routes one versioned owning request to the uniquely matching gameplay provider.

Result< std::string >	executeGameplayControlJson (std::string_view requestJson)
	Parse, execute and serialize one gameplay-control JSON request.

std::optional< PersistentId >	generateUuidV7 (std::chrono::system_clock::time_point timestamp, const UuidEntropySource &entropy)
	Constructs a UUIDv7 without owning a clock or generator object.

void	exposeReflection (Runtime &runtime, ssq::Table eveTable)
	Exposes the Runtime reflection API to scripts as `eve.reflect`.

constexpr std::string_view	resourceRefKindName (ResourceRefKind kind) noexcept
	Returns the stable resource-reference alternative spelling.

std::ostream &	operator<< (std::ostream &stream, ResourceRefKind kind)
	Writes a resource-reference alternative for diagnostics.

template<typename... Results>
bool	everyResultValid (const Results &... results) noexcept
	True only when every argument Result succeeded, observing all of them.

std::string	reflectedFloatString (double value)
	Shortest round-trip float formatting (portable).

Result< std::string >	snapshotHashInput (const SnapshotEnvelope &snapshot)
	Produce the canonical JSON input used for a snapshot content hash.

Result< void >	verifySnapshotEnvelope (const SnapshotEnvelope &snapshot, const SnapshotHashProvider &hashProvider)
	Verify an envelope's content hash without modifying it.

Result< void >	validateSnapshotPayloadMetadata (const Value &payload, Revision revision, SimulationTick tick)
	Validate optional payload copies of envelope revision and tick.

Result< SnapshotEnvelope >	makeSnapshotEnvelope (std::string type, LogicalId schema, SchemaVersion schemaVersion, PersistentId instanceId, Revision revision, SimulationTick tick, Value payload, const SnapshotHashProvider &hashProvider)
	Construct and seal a snapshot envelope.

Result< Value >	snapshotEnvelopeValue (const SnapshotEnvelope &snapshot)
	Convert an envelope to its strict canonical value representation.

Result< SnapshotEnvelope >	parseSnapshotEnvelopeValue (const Value &value, const SnapshotHashProvider &hashProvider)
	Parse and verify an envelope from an owning Value.

Result< std::string >	serializeSnapshotEnvelope (const SnapshotEnvelope &snapshot)
	Serialize an envelope as deterministic compact JSON.

Result< SnapshotEnvelope >	parseSnapshotEnvelope (std::string_view json, const SnapshotHashProvider &hashProvider)
	Parse and verify an envelope from canonical or compatible JSON text.

std::string_view	contentDigestKindName (ContentDigestKind kind) noexcept
	Stable protocol spelling of a digest kind.

std::shared_ptr< ISnapshotContentHasher >	builtinSnapshotContentHasher ()
	The engine's built-in content hasher.

ISnapshotContentHasher *	registeredSnapshotContentHasher () noexcept
	The currently registered hasher, if a module registered one.

Result< void >	registerBuiltinSnapshotHasher ()
	Register the built-in hasher, unless a module already registered one.

SnapshotHashProvider	snapshotContentHashProvider ()
	A `SnapshotHashProvider` backed by the active hasher.

std::string_view	activeSnapshotHashAlgorithm () noexcept
	Id of the algorithm `snapshotContentHashProvider` currently uses.

constexpr std::string_view	statusCodeName (StatusCode code) noexcept
	Return the stable protocol spelling of a status code.

std::ostream &	operator<< (std::ostream &stream, StatusCode code)
	Write the stable StatusCode spelling to a stream.

const char *	uriSchemeName (UriScheme scheme) noexcept
	Return the stable lower-case spelling of a resource URI scheme.

size_t	utf8_codepoint_count (const std::string &s)
	Count UTF-8 code points in a string. Invalid / truncated sequences stop the scan.

size_t	utf8_byte_offset_for_codepoints (const std::string &s, size_t codepoints)
	Byte offset of the N-th UTF-8 code point (0-based count of code points). Returns s.size() if there are fewer than N code points.

bool	isValidUtf8 (std::string_view text, Utf8NullPolicy nullPolicy=Utf8NullPolicy::Allow) noexcept
	Validate shortest-form UTF-8, Unicode scalar range and optional NUL exclusion.

const char *	gitCommit ()
	Git commit.

const char *	thirdPartyVersion ()
	Third party version.

std::string	buildInfo ()
	One-line build metadata for diagnostics (printed by `eve --version`).

const char *	registryOperationName (RegistryOperation operation) noexcept
	Stable lowercase name for a registry mutation kind.

std::ostream &	operator<< (std::ostream &stream, RegistryOperation operation)
	Writes the stable registry-operation protocol name.

变量
constexpr const char *	kSessionStartMarker = "EVEngine session start"
	Marker text that opens a session block in `eve.log`.

constexpr const char *	kSessionEndMarker = "session end (exit code"
	Marker text that closes a session block (followed by the exit code). @ownership Borrowed pointer to a static string literal; the caller owns nothing. @lifetime Static storage duration; valid for the whole process.

constexpr uint64_t	kGpuResidentStorageOffsetAlignment = 256
	Portable alignment required for resident storage-buffer slice offsets.

enum EVENGINE_API_FOUNDATION	ReflectedValueKind
	Runtime value kind read from a live script instance slot.

enum EVENGINE_API_FOUNDATION	Bool = 1
	OT_BOOL.

enum EVENGINE_API_FOUNDATION	Integer = 2
	OT_INTEGER.

enum EVENGINE_API_FOUNDATION	Float = 3
	OT_FLOAT.

enum EVENGINE_API_FOUNDATION	String = 4
	OT_STRING.

enum EVENGINE_API_FOUNDATION	Array = 5
	OT_ARRAY (editable via Runtime array APIs / ReflectedPropertyModel).

enum EVENGINE_API_FOUNDATION	Table = 6
	OT_TABLE (editable via Runtime table APIs / ReflectedPropertyModel).

enum EVENGINE_API_FOUNDATION	Instance = 7
	Nested script instance (navigate; ObjectRef in property schema).

enum EVENGINE_API_FOUNDATION	Other = 8
	Any other slot kind.

const char *	boot_content
	嵌入式脚本 / 着色器源码常量（构建时由集成脚本生成）。

const char *	load_content

const char *	module_list_content

const char *	async_content

const char *	scene_director_content

const char *	demo_content

const char *	vertex_content

const char *	fragment_content

详细描述

Build metadata (engine git commit, build time, third-party version).

RPG 模块入口：属性 / 效果 / 状态 / 技能 / 结算 / 任务 / 成长 / 生命的脚本绑定与帧调度点。

各系统的完整设计说明见对应头文件： AttributeSystem.h / AttributeTypes.h — 属性 Effect.h — 效果（数据驱动定义） StatusSystem.h / StatusTypes.h — 状态（运行时实例，buff/debuff） Skill.h / SkillSystem.h / SkillTypes.h — 技能 Settlement.h — 结算流水线 Quest.h / Tracker.h / QuestSystem.h — 任务/成就/教程追踪器 LevelSystem.h — 等级 / 经验 VitalsSystem.h — 当前资源 / 受伤 / 死亡以及总体设计文档：docs/dev/RPG系统设计.md

类型定义说明

◆ ArtifactId

using eve::ArtifactId = typedef StrongUuid<detail::ArtifactIdTag>

Stable generated-artifact identity; content equivalence remains ContentId.

在文件 Identity.h 第 282 行定义.

◆ AssetGuid

using eve::AssetGuid = typedef StrongUuid<detail::AssetGuidTag>

Stable asset identity used by sidecars, package manifests and caches.

This is a domain tag over the common UUID representation, not a second UUID implementation. It is distinct from a URI, a content digest and every runtime handle.

在文件 Identity.h 第 273 行定义.

◆ Color

using eve::Color = typedef glm::vec4

Render-neutral RGBA color shared by graphics-facing modules.

在文件 RenderTypes.h 第 8 行定义.

◆ CommandId

using eve::CommandId = typedef StrongUuid<detail::CommandIdTag>

Stable command identity for causal references.

在文件 Identity.h 第 288 行定义.

◆ ContentId

using eve::ContentId = typedef StrongUuid<detail::ContentIdTag>

Deterministic identity of equivalent canonical content.

ContentId stores a caller-supplied 128-bit digest. This common layer does not silently choose a weak hash or pretend to provide cryptographic security; the digest algorithm and canonicalization policy belong to the content producer and must be part of its schema contract.

在文件 Identity.h 第 264 行定义.

◆ CppEntityViewFn

using eve::CppEntityViewFn = typedef std::function<void(ssq::Array& out)>

C++ 实体 → 脚本 eve.view() 桥接。用 registerCppEntityView(cls, fn) 登记脚本类的收集函数；脚本 eve.view(cls) 沿类链找到登记的 C++ 类型后调用 fn 填充输出数组。

在文件 ECS.h 第 39 行定义.

◆ DiagnosticDetail

using eve::DiagnosticDetail = typedef std::pair<std::string, std::string>

A structured detail attached to a Diagnostic.

Keys and values are intentionally strings at this foundation layer. Domain modules can project their canonical Value type into this representation without making common depend on data, graphics, physics, or scripting.

在文件 Diagnostic.h 第 85 行定义.

◆ DiagnosticDetails

using eve::DiagnosticDetails = typedef std::vector<DiagnosticDetail>

Owning collection of diagnostic details with stable insertion order.

在文件 Diagnostic.h 第 88 行定义.

◆ DocumentId

using eve::DocumentId = typedef StrongUuid<detail::DocumentIdTag>

Stable document identity for persisted/editor-facing documents.

在文件 Identity.h 第 276 行定义.

◆ EffectId

using eve::EffectId = typedef StrongUuid<detail::EffectIdTag>

Stable effect-instance identity when an effect crosses a persistence/event boundary.

在文件 Identity.h 第 297 行定义.

◆ EventId

using eve::EventId = typedef StrongUuid<detail::EventIdTag>

Stable event identity for event envelopes and causal references.

在文件 Identity.h 第 285 行定义.

◆ EventSequence

using eve::EventSequence = typedef detail::StrongUint64<detail::EventSequenceTag>

Stream-local event ordering value; it is not a global event identity.

在文件 EventSequence.h 第 13 行定义.

◆ FrameIndex

using eve::FrameIndex = typedef detail::StrongUint64<detail::FrameIndexTag>

Render/presentation frame ordinal; it is not a simulation tick.

在文件 Time.h 第 34 行定义.

◆ Generation

using eve::Generation = typedef detail::StrongUint64<detail::GenerationTag>

Registry/object replacement generation used to reject stale handles.

在文件 Generation.h 第 13 行定义.

◆ IStateMutation

using eve::IStateMutation = typedef state::IStateMutation

在文件 StateAccess.h 第 125 行定义.

◆ IStateQuery

using eve::IStateQuery = typedef state::IStateQuery

在文件 StateAccess.h 第 124 行定义.

◆ MutationContext

using eve::MutationContext = typedef state::MutationContext

在文件 StateAccess.h 第 128 行定义.

◆ MutationKind

using eve::MutationKind = typedef state::MutationKind

在文件 StateAccess.h 第 127 行定义.

◆ MutationReceipt

using eve::MutationReceipt = typedef state::MutationReceipt

在文件 StateAccess.h 第 129 行定义.

◆ OperationId

using eve::OperationId = typedef StrongUuid<detail::OperationIdTag>

Stable operation identity inside a persisted transaction plan.

在文件 Identity.h 第 294 行定义.

◆ OptionalRef

template<typename T >

using eve::OptionalRef = typedef std::optional<std::reference_wrapper<T> >

Optional borrowed reference; it does not extend T's lifetime.

模板参数

T	Referenced object type, possibly const-qualified.

在文件 BorrowedRef.h 第 24 行定义.

◆ PersistentId

using eve::PersistentId = typedef StrongUuid<detail::PersistentIdTag>

Stable instance identity for persistence, networking and process boundaries.

PersistentId is a UUID value, not an ECS or registry handle. It remains meaningful after a runtime object is rebuilt, while the runtime handle may change or become stale.

在文件 Identity.h 第 254 行定义.

◆ PhotoModeValue

using eve::PhotoModeValue = typedef std::variant<bool, std::int64_t, float, std::string, PhotoModeColor>

Typed payload accepted by authoritative photo-mode domain owners.

在文件 PcgPhotoModeApply.h 第 11 行定义.

◆ PostEcsHook

using eve::PostEcsHook = typedef std::function<void(ssq::Table& table)>

在脚本 ECS 基类（eve.Component / eve.Entity / eve.System）注入之后执行的回调。模块用它注入"extends eve.Entity"的脚本基类（例如 eve.SceneEntity）。在 exposeECS / exposeECSToVM 末尾运行，早于任何游戏脚本。

在文件 ECS.h 第 48 行定义.

◆ ProtocolDispatchResult

using eve::ProtocolDispatchResult = typedef Result<ProtocolDispatch>

Structured result returned by protocol dispatch boundaries.

注解: Transport/parse failures belong in the Result status; successful values describe every valid protocol disposition exhaustively.

在文件 ProtocolDispatch.h 第 28 行定义.

◆ ResourcePin

using eve::ResourcePin = typedef script::RuntimePin<Resource, ResourceCacheTag>

Keep-alive pin on one cached resource; see script::RuntimePin.

在文件 Resource.h 第 30 行定义.

◆ ResultRef

template<typename T >

using eve::ResultRef = typedef Result<std::reference_wrapper<T> >

Checked borrowed reference carried by Result; it does not own T.

模板参数

T	Referenced object type, possibly const-qualified.

在文件 BorrowedRef.h 第 31 行定义.

◆ Revision

using eve::Revision = typedef detail::StrongUint64<detail::RevisionTag>

Monotonic content/state revision used for optimistic-concurrency checks.

在文件 Revision.h 第 13 行定义.

◆ SceneObjectId

using eve::SceneObjectId = typedef StrongUuid<detail::SceneObjectIdTag>

Stable persisted scene-object identity; distinct from an ECS handle.

在文件 Identity.h 第 279 行定义.

◆ SchemaVersion

using eve::SchemaVersion = typedef detail::StrongUint64<detail::SchemaVersionTag>

Persistent data-format version; not a runtime replacement generation.

在文件 SchemaVersion.h 第 13 行定义.

◆ SimulationTick

using eve::SimulationTick = typedef detail::StrongUint64<detail::SimulationTickTag>

Deterministic simulation time step; it is not wall-clock time.

在文件 Time.h 第 31 行定义.

◆ SnapshotHashProvider

using eve::SnapshotHashProvider = typedef std::function<Result<ContentId>(std::string_view canonicalInput)>

Injected content-digest implementation used by snapshots.

参数

canonicalInput Canonical JSON containing stable header fields and payload.

返回: A ContentId, or a structured failure when the provider is unavailable.

备注: No default hash or security claim is made. Providers must document their digest algorithm and collision/security properties.

在文件 Snapshot.h 第 36 行定义.

◆ StateMutation

using eve::StateMutation = typedef state::StateMutation

在文件 StateAccess.h 第 126 行定义.

◆ StrongUuid

template<typename Tag >

using eve::StrongUuid = typedef detail::Id128<Tag>

Public alias for a tag-safe 128-bit UUID identity.

模板参数

Tag	Empty domain tag that prevents accidental cross-domain mixing.

备注: All UUID aliases in the common layer use the same representation, parser, formatter, hash and child-derivation implementation.

在文件 Identity.h 第 245 行定义.

◆ TransactionId

using eve::TransactionId = typedef StrongUuid<detail::TransactionIdTag>

Stable transaction identity for cross-module coordination and snapshots.

在文件 Identity.h 第 291 行定义.

◆ UuidClock

using eve::UuidClock = typedef std::function<std::chrono::system_clock::time_point()>

Clock callback used by the injectable UUIDv7 generator.

在文件 Identity.h 第 469 行定义.

◆ UuidEntropySource

using eve::UuidEntropySource = typedef std::function<bool(std::span<std::uint8_t> bytes)>

Entropy callback used by UUIDv7 generation.

参数

bytes A writable span that the callback must fill completely on success.

返回: true only when all requested bytes were filled with suitable entropy.

备注: Callers must provide a seed; no implicit pseudo-random source or random_device path is used. Security-sensitive callers must inject a cryptographically secure source.

在文件 Identity.h 第 466 行定义.

枚举类型说明

◆ BlendMode

enum class eve::BlendMode

strong

Render-neutral 2D blend mode shared by graphics-facing modules.

枚举值
Alpha
Additive
Opaque
Premultiplied
Multiply

在文件 RenderTypes.h 第 11 行定义.

◆ ContentDigestKind

enum class eve::ContentDigestKind : std::uint8_t

strong

What a digest implementation actually guarantees, stated rather than implied.

枚举值
NonCryptographic	Fast, deterministic, collision-resistant enough for storage identity only.
Cryptographic	A cryptographic digest; the provider documents its algorithm and properties.

在文件 SnapshotHash.h 第 38 行定义.

◆ DiagnosticCode

enum class eve::DiagnosticCode : uint32_t

strong

Stable machine-readable diagnostic codes.

Numeric values are part of the public contract. Messages are intended for people and must not be used as program-branch conditions.

枚举值
None
InvalidArgument
PreconditionViolation
NotFound
AlreadyExists
Conflict
Unsupported
Cancelled
StaleHandle
ParseError
SerializationError
InvariantViolation
Failed
HashMismatch
UnknownVersion
CallbackFailure
DialogueNotWaitingForChoice	Dialogue runner is not positioned at a choice suspension point.
DialogueNotWaitingForCommand	Dialogue runner is not positioned at an asynchronous command.
DialogueConditionRejected	A dialogue condition rejected the requested route.
DialogueRouteNotFound	A requested dialogue route does not exist on the current node.
ProcgenGroupDataInvalid	Mesh group sidecar data is inconsistent with its dense streams.
TypeMismatch	A stable reference resolved to a different canonical domain type.

在文件 Diagnostic.h 第 47 行定义.

◆ GameplayAccess

enum class eve::GameplayAccess : std::uint8_t

strong

Authority profile applied by a gameplay provider before domain validation.

枚举值
PlayerEquivalent
TestDriver
DeveloperCheat

在文件 GameplayControl.h 第 22 行定义.

◆ GpuResidentBackend

enum class eve::GpuResidentBackend : uint8_t

strong

Backend identity for a transient, non-owning resident GPU buffer view.

枚举值
Unknown
Vulkan
WebGpu

在文件 GpuResidentBufferView.h 第 8 行定义.

◆ MeshDeformationComputeOperation

enum class eve::MeshDeformationComputeOperation : std::uint8_t

strong

Operation executed by an optional mesh-deformation compute provider.

枚举值
Inflate
Dent
Flatten
Directional
Smooth
Impact

在文件 MeshDeformationCompute.h 第 11 行定义.

◆ ParticleSdfGradientStatus

enum class eve::ParticleSdfGradientStatus

strong

Outcome of sampling an SDF gradient for particle collision.

枚举值
Defined	Finite outward unit gradient written to the output components.
Undefined	Empty field or singularity; output components are unspecified.

在文件 ParticleSdf.h 第 8 行定义.

◆ PhotoModeDomain

enum class eve::PhotoModeDomain

strong

Authoritative owner selected for a Pcg photo-mode field.

枚举值
Photo
FramePacing
Graphics
Camera
Streaming
Weather
Lighting
Water
PostFx
Terrain
Grass
Audio

在文件 PcgPhotoModeApply.h 第 13 行定义.

◆ PhotoModeFieldAcceptance

enum class eve::PhotoModeFieldAcceptance

strong

Capability implemented by the composition root that routes assignments to domain owners.

Calls are synchronous on the game thread. Implementations must either apply one assignment fully or leave its domain unchanged. They must not retain references to the assignment or invoke scripts.

Optional per-field provider used by the built-in photo-mode capability router.

Providers register as capability listeners. Exactly one provider must accept an assignment. This extension point is reserved for optional domain-owned settings whose provider cannot be named by the UI module at link time. Stable engine controls use their narrow capabilities directly, such as IFramePacing and IFramePresentation, instead of making foundation modules parse PCG field names.

Named ownership response from a photo-mode field provider.

枚举值
Rejected
Accepted

在文件 PcgPhotoModeApply.h 第 32 行定义.

◆ ProtocolDispatch

enum class eve::ProtocolDispatch

strong

Observable disposition of one protocol input message.

枚举值
ReplySent
NotificationHandled
Rejected
Terminate

在文件 ProtocolDispatch.h 第 16 行定义.

◆ RegistryOperation

enum class eve::RegistryOperation : std::uint8_t

strong

Canonical mutation kind emitted by a VersionedRegistry.

枚举值
Insert
Replace
Remove

在文件 VersionedRegistry.h 第 75 行定义.

◆ ResourceRefKind

enum class eve::ResourceRefKind : std::uint8_t

strong

The alternative held by a generic ResourceRef.

枚举值
Asset
Uri
Definition
Object

在文件 ResourceRef.h 第 22 行定义.

◆ ScriptStage

enum class eve::ScriptStage

strong

ScriptStage public API.

枚举值
Compile
Execute
Reflect
Unload
Shutdown

在文件 Runtime.h 第 52 行定义.

◆ ScriptState

enum class eve::ScriptState

strong

ScriptState public API.

枚举值
Compiled
Running
Loaded
Unloading
Unloaded
Failed

在文件 Runtime.h 第 42 行定义.

◆ Severity

enum class eve::Severity : uint8_t

strong

Stable severity of a diagnostic, independent of its display text.

枚举值
Info
Warning
Error
Fatal

在文件 Diagnostic.h 第 20 行定义.

◆ StatusCode

enum class eve::StatusCode : uint8_t

strong

Stable outcome category for an operation.

Ok, Applied, NoOp, and Pending are non-failure outcomes. The other values require the caller to inspect the diagnostics or otherwise make an explicit policy decision.

枚举值
Ok
Applied
NoOp
Pending
Rejected
Conflict
NotFound
Unsupported
Cancelled
Failed

在文件 Status.h 第 27 行定义.

◆ UriScheme

enum class eve::UriScheme : std::uint8_t

strong

URI schemes understood by the resource layer.

These schemes identify virtual resource namespaces, not operating-system paths. A URI has the canonical shape scheme://path[?query][#fragment].

枚举值
Asset
Project
Builtin
Generated
Memory

在文件 Uri.h 第 25 行定义.

◆ Utf8NullPolicy

enum class eve::Utf8NullPolicy : std::uint8_t

strong

Policy for embedded U+0000 in otherwise valid UTF-8 text.

枚举值
Allow
Reject

在文件 Utf8Validation.h 第 13 行定义.

函数说明

◆ activeSnapshotHashAlgorithm()

std::string_view eve::activeSnapshotHashAlgorithm ( )

noexcept

Id of the algorithm snapshotContentHashProvider currently uses.

返回: The active hasher's id, so a caller can record what produced a hash.

在文件 SnapshotHash.cpp 第 97 行定义.

引用了 eve::ISnapshotContentHasher::id() , 以及 registeredSnapshotContentHasher().

被这些函数引用 eve::tactics::Tactics::snapshotHashAlgorithm().

◆ b64_decode()

EVENGINE_API_FOUNDATION char * eve::b64_decode	(	const char *	src,
		size_t	srclen,
		size_t &	dstlen
	)

Decode base64 encoded data.

参数

src	The string containing the base64 data.
srclen	The length of the string.
dstlen	The size of the binary data is stored here.

返回: A chunk of memory containing the binary data (allocated with new[]). @ownership Caller owns the returned buffer and releases it with delete[]. @lifetime The returned buffer is independent of src and remains valid until freed.

在文件 b64.cpp 第 102 行定义.

引用了 d, size , 以及 v.

被这些函数引用 eve::data::decode().

◆ b64_encode()

EVENGINE_API_FOUNDATION char * eve::b64_encode	(	const char *	src,
		size_t	srclen,
		size_t	linelen,
		size_t &	dstlen
	)

Base64-encode data.

参数

src	The data to encode.
srclen	The size in bytes of the data.
linelen	The maximum length of each line in the encoded string. 0 indicates no maximum length.
dstlen	The length of the encoded string is stored here.

返回: A string containing the base64-encoded data (allocated with new[]). @ownership Caller owns the returned buffer and releases it with delete[]. @lifetime The returned buffer is independent of src and remains valid until freed.

在文件 b64.cpp 第 28 行定义.

被这些函数引用 eve::data::encode().

◆ buildInfo()

EVENGINE_API_FOUNDATION std::string eve::buildInfo ( )

One-line build metadata for diagnostics (printed by eve --version).

返回: "v<engine version> git=<commit> built=<time> [<build type>] tp=<third-party version>"

在文件 Version.cpp 第 20 行定义.

引用了 info.

被这些函数引用 eve::cmd::Cmdline::runArgs().

◆ builtinSnapshotContentHasher()

std::shared_ptr< ISnapshotContentHasher > eve::builtinSnapshotContentHasher ( )

The engine's built-in content hasher.

返回: A process-wide immutable hasher whose id is fnv1a64x2-noncrypto. @ownership Shared; the object is immutable and may be handed to cap::provide.

在文件 SnapshotHash.cpp 第 79 行定义.

◆ contentDigestKindName()

EVENGINE_API_FOUNDATION std::string_view eve::contentDigestKindName ( ContentDigestKind kind )

noexcept

Stable protocol spelling of a digest kind.

在文件 SnapshotHash.cpp 第 71 行定义.

引用了 Cryptographic, kind , 以及 NonCryptographic.

◆ crashLogPath()

EVENGINE_API_FOUNDATION std::string eve::crashLogPath ( )

Path of the open crash/error log file.

返回: Absolute/relative path as opened; empty when logging is not available.

在文件 CrashLog.cpp 第 89 行定义.

被这些函数引用 eve::dev::crashLogSummary().

◆ diagnosticCodeName()

constexpr std::string_view eve::diagnosticCodeName ( DiagnosticCode code )

constexprnoexcept

Return a stable, compact spelling useful for logs and diagnostics.

返回: Borrowed static text for code; unknown values return "unknown". @thread Thread-safe and side-effect free. @reentrancy Does not invoke callbacks or alter diagnostic state.

在文件 Diagnostic.h 第 176 行定义.

引用了 AlreadyExists, CallbackFailure, Cancelled, code, Conflict, DialogueConditionRejected, DialogueNotWaitingForChoice, DialogueNotWaitingForCommand, DialogueRouteNotFound, Failed, HashMismatch, InvalidArgument, InvariantViolation, None, NotFound, ParseError, PreconditionViolation, ProcgenGroupDataInvalid, SerializationError, StaleHandle, TypeMismatch, UnknownVersion , 以及 Unsupported.

被这些函数引用 eve::DiagnosticValueTraits< DiagnosticCode >::name(), operator<<() , 以及 eve::script::projectDiagnostic().

◆ diagnosticValueCode()

template<DiagnosticValue T>

constexpr DiagnosticCode eve::diagnosticValueCode ( T value )

constexprnoexcept

Return the stable machine-readable code supplied by a DiagnosticValue specialization.

Diagnostic value code.

Code.

在文件 DiagnosticValue.h 第 42 行定义.

引用了 value.

◆ diagnosticValueName()

template<DiagnosticValue T>

constexpr std::string_view eve::diagnosticValueName ( T value )

constexprnoexcept

Return the stable name supplied by a DiagnosticValue specialization.

Diagnostic value name.

Name.

在文件 DiagnosticValue.h 第 34 行定义.

引用了 value.

◆ everyResultValid()

template<typename... Results>

bool eve::everyResultValid ( const Results &... results )

noexcept

True only when every argument Result succeeded, observing all of them.

Use this helper for any condition that combines several Results instead of a short-circuiting chain such as if (!first || !second). || stops at the first failing operand, so the operands after it are never observed; destroying an unobserved Result asserts in Debug, and when two such destructors run during the same unwinding the second throw terminates the process instead of reporting the intended structured failure. The fold below uses & rather than && for exactly that reason: every argument is observed before the answer is computed.

参数

results One or more Results to observe; pass them as lvalues.

返回: True when every argument represents a successful outcome.

备注: Evaluation order follows the fold's grouping and is deterministic; the helper never throws, never allocates, and invokes no callbacks.

Every result valid.

在文件 Result.h 第 586 行定义.

◆ executeGameplayControlJson()

EVENGINE_API_FOUNDATION Result< std::string > eve::executeGameplayControlJson ( std::string_view requestJson )

Parse, execute and serialize one gameplay-control JSON request.

参数

requestJson Strict UTF-8 JSON request.

返回: Deterministic compact response JSON or structured diagnostics.

在文件 GameplayControlJson.cpp 第 376 行定义.

引用了 executeGameplayControlJson(), executeGameplayControlRequest() , 以及 request.

被这些函数引用 executeGameplayControlJson() , 以及 eve::dev::DevTool::exposeScriptApi().

◆ executeGameplayControlRequest()

EVENGINE_API_FOUNDATION Result< Value > eve::executeGameplayControlRequest ( const Value & request )

Routes one versioned owning request to the uniquely matching gameplay provider.

参数

request Request object with schema id evengine.gameplay-control-request and version 1.

返回: Owning response object, or structured parse/routing/domain diagnostics.

备注: Unknown root fields are rejected. Provider callbacks execute synchronously on the gameplay owner thread; this function retains no request or provider pointer.

在文件 GameplayControlJson.cpp 第 219 行定义.

引用了 executeGameplayControlRequest(), left, operation, output, request, right, root , 以及 valid.

被这些函数引用 executeGameplayControlJson() , 以及 executeGameplayControlRequest().

◆ exposeECS()

void eve::exposeECS ( ssq::Table & table )

脚本侧 ECS：Entity / Component / System / ShaderSystem / view（见 ECS.cpp）。 C++ 游戏实体仍直接用 ECS.hpp 的 ENTITY / COMPONENT / View。 GPU System：eve.ShaderSystem + gpgpu::ShaderSystem / EcsGpu.h。

在文件 ECS.cpp 第 829 行定义.

引用了 cls, flushPostEcsHooks() , 以及 name.

被这些函数引用 exposeECSToVM().

◆ exposeECSToVM()

void eve::exposeECSToVM ( ssq::VM & vm )

在 ModuleManager::expose 之后调用；保证 eve.Component 等不被其它模块覆盖。

在文件 ECS.cpp 第 883 行定义.

引用了 exposeECS() , 以及 vm.

◆ exposeReflection()

EVENGINE_API_FOUNDATION void eve::exposeReflection	(	Runtime &	runtime,
		ssq::Table	eveTable
	)

Exposes the Runtime reflection API to scripts as eve.reflect.

Adds a reflect sub-table to the eve table with class/instance introspection, typed property read/write and array/table member editing. Script-facing schema projection for the shared property UI lives on ui.propertySchema(instance) (built by ReflectedPropertyModel).

local info = eve.reflect.classInfo("Hero")     // class metadata table
local hero = eve.reflect.createInstance("Hero")
eve.reflect.write(hero, "hp", 42.5)
local hp = eve.reflect.read(hero, "hp")        // 42.5
local members = eve.reflect.inspect(hero)      // member metadata + live values

Scalar reads/writes keep the slot's own type (bool stays bool, integer stays integer, ...), mirroring Runtime::writeProperty; array, table and instance slots are read as their live script objects. classInfo() returns null for an unknown class, and every mutator returns false instead of throwing when the member is missing, is a method, or is not editable.

参数

runtime	Runtime whose reflection data the bindings operate on.
eveTable	Root `eve` table to add the `reflect` sub-table to.

在文件 ReflectScript.cpp 第 163 行定义.

引用了 cls, index, info, key, member, name , 以及 value.

被这些函数引用 eve::Runtime::initialize().

◆ flushPostEcsHooks()

void eve::flushPostEcsHooks ( ssq::Table & table )

Run post-ECS hooks that were registered after exposeECS already ran.

Native module classes bind on first script access. A module may therefore register a hook (or depend on Entity already existing) after the initial exposeECS call; this flushes those pending hooks onto the live eve table.

在文件 ECS.cpp 第 869 行定义.

引用了 n.

被这些函数引用 eve::ModuleManager::expose_pending() , 以及 exposeECS().

◆ generateUuidV7()

EVENGINE_API_FOUNDATION std::optional< PersistentId > eve::generateUuidV7	(	std::chrono::system_clock::time_point	timestamp,
		const UuidEntropySource &	entropy
	)

Constructs a UUIDv7 without owning a clock or generator object.

参数

timestamp	Unix time used for the UUIDv7 millisecond field.
entropy	Source for the UUID random portion.

返回: A generated PersistentId, or empty when entropy/time is unavailable or out of range.

在文件 Identity.cpp 第 89 行定义.

引用了 bytes, index , 以及 milliseconds.

被这些函数引用 eve::UuidV7Generator::generate().

◆ gitCommit()

EVENGINE_API_FOUNDATION const char * eve::gitCommit ( )

Git commit.

返回: Short engine git commit, or "unknown" when not built from a git checkout.

在文件 Version.cpp 第 17 行定义.

◆ initSystemLogging()

EVENGINE_API_FOUNDATION void eve::initSystemLogging ( const std::string & logDir = {} )

Opens (append) the crash/error log file and records a session marker.

参数

logDir Directory for the eve.log file. Empty selects EVE_LOG_DIR or the current working directory.

Idempotent: subsequent calls are no-ops. If the file cannot be opened, logging silently stays disabled (stderr output is unaffected).

在文件 CrashLog.cpp 第 64 行定义.

被这些函数引用 main().

◆ isValidUtf8()

EVENGINE_API_FOUNDATION bool eve::isValidUtf8	(	std::string_view	text,
		Utf8NullPolicy	nullPolicy = `Utf8NullPolicy::Allow`
	)

noexcept

Validate shortest-form UTF-8, Unicode scalar range and optional NUL exclusion.

参数

text	Borrowed bytes used only for this call.
nullPolicy	Whether U+0000 is accepted.

返回: True only for a complete sequence containing no surrogate code points. @thread Worker-safe; no shared state or allocation.

在文件 Utf8Validation.cpp 第 5 行定义.

引用了 index, Reject , 以及 text.

被这些函数引用 eve::asset_procgen::EvpackInstanceSetLoader::load(), eve::asset_procgen::EvpackTerrainMaterialLoader::load(), eve::asset_import::unity_detail::metaScalar(), eve::asset_import::prepareCanonicalTerrainImport(), eve::asset_import::prepareUnityVegetationPreset() , 以及 eve::asset_import::unity_detail::validPath().

◆ makeSnapshotEnvelope()

EVENGINE_API_FOUNDATION Result< SnapshotEnvelope > eve::makeSnapshotEnvelope	(	std::string	type,
		LogicalId	schema,
		SchemaVersion	schemaVersion,
		PersistentId	instanceId,
		Revision	revision,
		SimulationTick	tick,
		Value	payload,
		const SnapshotHashProvider &	hashProvider
	)

Construct and seal a snapshot envelope.

参数

type	Stable runtime/domain snapshot type.
schema	Stable `namespace:name` payload schema identifier.
schemaVersion	Version of the payload schema.
instanceId	Stable identity of the state owner; nil is allowed for legacy anonymous stores.
revision	State revision at capture time.
tick	Simulation tick at capture time; wall-clock time is not accepted.
payload	Owning domain payload.
hashProvider	Injected digest provider; must not be empty.

返回: A sealed envelope, or a structured validation/hash failure.

在文件 Snapshot.cpp 第 103 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), hash, input, eve::detail::Id128< Tag >::nil(), payload, revision, snapshotHashInput(), eve::Result< T >::success(), tick, type, Unsupported , 以及 valid.

被这些函数引用 eve::pixelworld_streaming::archiveChunkBatch(), eve::SnapshotMigrationChain::migrate(), eve::tactics::TacticsPersistence::snapshot(), eve::procgen::ArtifactPublisher::snapshot(), eve::authority::Store::snapshot(), eve::definitions::DefinitionRegistry::snapshot(), eve::game_event::GameEventLog::snapshot(), eve::physics::World::snapshot(), eve::physics::World3D::snapshot(), eve::policyregistry::PolicyRegistry::snapshot(), eve::production::WorkQueue::snapshot(), eve::statepatch::Store::snapshot(), eve::transaction::Ledger::snapshot(), eve::pixelworld_replay::PixelReplayLog::snapshot(), eve::rpg::RPGSaveSession::snapshotJson() , 以及 eve::definition::snapshotRuntimeInstance().

◆ operator<<() [1/5]

std::ostream & eve::operator<<	(	std::ostream &	stream,
		DiagnosticCode	code
	)

inline

Writes the stable diagnostic-code spelling to a stream.

Diagnostic code name.

在文件 Diagnostic.h 第 205 行定义.

引用了 code , 以及 diagnosticCodeName().

◆ operator<<() [2/5]

std::ostream & eve::operator<<	(	std::ostream &	stream,
		RegistryOperation	operation
	)

inline

Writes the stable registry-operation protocol name.

Registry operation name.

在文件 VersionedRegistry.h 第 100 行定义.

引用了 operation , 以及 registryOperationName().

◆ operator<<() [3/5]

std::ostream & eve::operator<<	(	std::ostream &	stream,
		ResourceRefKind	kind
	)

inline

Writes a resource-reference alternative for diagnostics.

Resource ref kind name.

在文件 ResourceRef.h 第 41 行定义.

引用了 kind , 以及 resourceRefKindName().

◆ operator<<() [4/5]

std::ostream & eve::operator<<	(	std::ostream &	stream,
		Severity	severity
	)

inline

Writes a severity for diagnostics and test output.

在文件 Diagnostic.h 第 39 行定义.

引用了 severityName().

◆ operator<<() [5/5]

std::ostream & eve::operator<<	(	std::ostream &	stream,
		StatusCode	code
	)

inline

Write the stable StatusCode spelling to a stream.

在文件 Status.h 第 62 行定义.

引用了 code , 以及 statusCodeName().

◆ parseSnapshotEnvelope()

EVENGINE_API_FOUNDATION Result< SnapshotEnvelope > eve::parseSnapshotEnvelope	(	std::string_view	json,
		const SnapshotHashProvider &	hashProvider
	)

Parse and verify an envelope from canonical or compatible JSON text.

参数

json	UTF-8 JSON object containing the strict envelope shape.
hashProvider	Provider used to verify contentHash.

返回: A verified envelope, or a parse/version/hash failure.

在文件 Snapshot.cpp 第 190 行定义.

引用了 eve::Result< T >::failure(), eve::Value::fromJson(), parseSnapshotEnvelopeValue() , 以及 value.

被这些函数引用 eve::tactics::Tactics::restoreJson(), eve::authority::Store::restoreSnapshotJson(), eve::definitions::DefinitionRegistry::restoreSnapshotJson(), eve::game_event::GameEventLog::restoreSnapshotJson(), eve::policyregistry::PolicyRegistry::restoreSnapshotJson(), eve::production::WorkQueue::restoreSnapshotJson(), eve::statepatch::Store::restoreSnapshotJson() , 以及 eve::transaction::Ledger::restoreSnapshotJson().

◆ parseSnapshotEnvelopeValue()

EVENGINE_API_FOUNDATION Result< SnapshotEnvelope > eve::parseSnapshotEnvelopeValue	(	const Value &	value,
		const SnapshotHashProvider &	hashProvider
	)

Parse and verify an envelope from an owning Value.

参数

value	Object containing exactly the envelope fields.
hashProvider	Provider used to verify contentHash.

返回: A verified envelope, or a parse/version/hash failure.

在文件 Snapshot.cpp 第 136 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), object, eve::LogicalId::parse(), eve::detail::Id128< Tag >::parse(), ParseError, payload, revision, eve::Result< T >::success(), tick, type, value , 以及 verifySnapshotEnvelope().

被这些函数引用 parseSnapshotEnvelope().

◆ prepareEcsScriptInjection()

void eve::prepareEcsScriptInjection ( )

Resets per-VM script injection bookkeeping before a new VM is exposed.

在文件 ECS.cpp 第 853 行定义.

被这些函数引用 eve::ModuleManager::exposeVM().

◆ recordCrashEvent()

EVENGINE_API_FOUNDATION void eve::recordCrashEvent ( const std::string & report )

Records a crash report, safe to call from a crash/exception handler.

参数

report Multi-line crash report (e.g. exception code + backtrace).

Uses a try-lock so it never deadlocks if the crashing thread already held the log mutex; on contention the report is dropped rather than hanging. Best used by the unhandled-exception filter, which also prints the same report to stderr.

在文件 CrashLog.cpp 第 78 行定义.

◆ recordLogEvent()

EVENGINE_API_FOUNDATION void eve::recordLogEvent	(	const std::string &	level,
		const std::string &	message
	)

Appends a timestamped event line to the crash/error log.

参数

level	Severity tag (e.g. "info", "warn", "error").
message	The event text (a trailing newline is added).

Thread-safe and blocking so normal error reporting never drops a line. No-op (besides the implicit lazy open) when logging is unavailable.

在文件 CrashLog.cpp 第 70 行定义.

引用了 level , 以及 message.

被这些函数引用 eve::graphics::vulkan::Graphics::initHeadless(), eve::graphics::vulkan::Graphics::initWithWindow(), recordSessionEnd() , 以及 eve::cmd::Cmdline::Run().

◆ recordSessionEnd()

void eve::recordSessionEnd ( int exitCode )

Appends the session-end marker carrying the process exit code.

A session block without this marker is how a reader recognises a run that did not finish (crash, kill, power loss).

参数

exitCode Process exit code that ended the session.

在文件 CrashLog.cpp 第 102 行定义.

引用了 kSessionEndMarker , 以及 recordLogEvent().

被这些函数引用 main().

◆ recordSessionStart()

void eve::recordSessionStart ( )

Appends a session-start marker.

initSystemLogging() writes one when it opens the log. A host that runs more than one game session inside one process (a launcher, a test harness) calls this to delimit them, so a reader can still tell which run a failure belongs to.

在文件 CrashLog.cpp 第 94 行定义.

引用了 kSessionStartMarker.

◆ reflectedFloatString()

std::string eve::reflectedFloatString ( double value )

inline

Shortest round-trip float formatting (portable).

std::to_chars(float/double) is unavailable on Apple platforms with an iOS deployment target below 16.3, so reflection/editor code must not use it. snprintf with max_digits10 guarantees round-tripping at the cost of not being the shortest spelling.

Snprintf.

在文件 Runtime.h 第 33 行定义.

引用了 value.

◆ registerBuiltinSnapshotHasher()

Result< void > eve::registerBuiltinSnapshotHasher ( )

Register the built-in hasher, unless a module already registered one.

返回: Applied when this call registered the built-in, or NoOp when a provider was already present (an existing, possibly stronger, provider is never replaced).

备注: Host boot calls this once so script and tooling paths have a working default without every caller having to inject one.

在文件 SnapshotHash.cpp 第 85 行定义.

引用了 Applied, NoOp, registeredSnapshotContentHasher(), eve::Status::success() , 以及 eve::Result< T >::success().

被这些函数引用 main().

◆ registerCppEntityView()

EVENGINE_API_FOUNDATION void eve::registerCppEntityView	(	const ssq::Class &	cls,
		CppEntityViewFn	fn
	)

Registers cpp entity view.

在文件 ECS.cpp 第 861 行定义.

引用了 cls , 以及 fn.

◆ registeredSnapshotContentHasher()

ISnapshotContentHasher * eve::registeredSnapshotContentHasher ( )

noexcept

The currently registered hasher, if a module registered one.

返回: Borrowed pointer to the registered implementation, or nullptr when none is. @ownership Borrowed; the registering module owns the object and must outlive its use. @nullable Yes. @lifetime Valid until another module registers a replacement or revokes this one. @thread Safe to call concurrently with queries; registration is not synchronized with use.

在文件 SnapshotHash.cpp 第 81 行定义.

被这些函数引用 activeSnapshotHashAlgorithm() , 以及 registerBuiltinSnapshotHasher().

◆ registerPostEcsHook()

EVENGINE_API_FOUNDATION void eve::registerPostEcsHook ( PostEcsHook fn )

Registers post ecs hook.

在文件 ECS.cpp 第 865 行定义.

引用了 fn.

◆ registryOperationName()

const char * eve::registryOperationName ( RegistryOperation operation )

inlinenoexcept

Stable lowercase name for a registry mutation kind.

返回: Borrowed, non-null, null-terminated static text. @ownership Borrowed; the returned text is not allocated. @nullable No; unknown enum values return "unknown". @lifetime Static for the process lifetime. @thread Thread-safe and side-effect free. @reentrancy Does not access or mutate a registry.

在文件 VersionedRegistry.h 第 90 行定义.

引用了 Insert, operation, Remove , 以及 Replace.

被这些函数引用 operator<<().

◆ resolveEntitySpatialPose()

EVENGINE_API_FOUNDATION Result< EntitySpatialPose > eve::resolveEntitySpatialPose	(	ecs::EntityHandle	entity,
		std::string_view	bone = `{}`
	)

Resolve through registered providers in deterministic registration order.

返回: First successful pose; the first non-NotFound failure; or NotFound. @thread Owner thread only; provider registration must be settled before dispatch. @reentrancy Providers must not mutate the capability listener registry.

在文件 EntitySpatialResolver.cpp 第 9 行定义.

引用了 bone, eve::Diagnostic::error(), eve::Result< T >::failure(), NotFound, pose, eve::IEntitySpatialProvider::resolve() , 以及 eve::Result< T >::success().

◆ resourceRefKindName()

constexpr std::string_view eve::resourceRefKindName ( ResourceRefKind kind )

constexprnoexcept

Returns the stable resource-reference alternative spelling.

在文件 ResourceRef.h 第 30 行定义.

引用了 Asset, Definition, kind, Object , 以及 Uri.

被这些函数引用 operator<<().

◆ serializeSnapshotEnvelope()

EVENGINE_API_FOUNDATION Result< std::string > eve::serializeSnapshotEnvelope ( const SnapshotEnvelope & snapshot )

Serialize an envelope as deterministic compact JSON.

参数

snapshot Envelope to serialize.

返回: Canonical JSON, or a serialization failure.

备注: Serialization does not silently recalculate or repair contentHash; call verifySnapshotEnvelope when accepting an external envelope.

在文件 Snapshot.cpp 第 184 行定义.

引用了 eve::Result< T >::failure(), owned, snapshotEnvelopeValue() , 以及 value.

被这些函数引用 eve::authority::Store::snapshotEnvelopeJson(), eve::definitions::DefinitionRegistry::snapshotEnvelopeJson(), eve::game_event::GameEventLog::snapshotEnvelopeJson(), eve::policyregistry::PolicyRegistry::snapshotEnvelopeJson(), eve::production::WorkQueue::snapshotEnvelopeJson(), eve::statepatch::Store::snapshotEnvelopeJson(), eve::transaction::Ledger::snapshotEnvelopeJson(), eve::rpg::RPGSaveSession::snapshotJson(), eve::tactics::Tactics::snapshotJson(), eve::card::CardDefinitionRuntime::snapshotJson(), eve::rpg::SkillDefinitionRuntime::snapshotJson(), eve::vehicle::VehicleDefinitionRuntime::snapshotJson() , 以及 eve::weapon::WeaponDefinitionRuntime::snapshotJson().

◆ severityName()

constexpr std::string_view eve::severityName ( Severity severity )

constexprnoexcept

Returns the stable lowercase severity spelling.

在文件 Diagnostic.h 第 28 行定义.

引用了 Error, Fatal, Info , 以及 Warning.

被这些函数引用 eve::DiagnosticValueTraits< Severity >::name() , 以及 operator<<().

◆ snapshotContentHashProvider()

SnapshotHashProvider eve::snapshotContentHashProvider ( )

A SnapshotHashProvider backed by the active hasher.

返回: A callable suitable for the snapshot/restore entry points. @ownership The returned callable borrows the active hasher; it must not outlive it, and it must not be stored beyond the registration's lifetime.

备注: Uses the registered hasher when there is one, otherwise builtinSnapshotContentHasher. Callers that must not accept a weak digest ask activeSnapshotHashAlgorithm or registeredSnapshotContentHasher first.

在文件 SnapshotHash.cpp 第 92 行定义.

被这些函数引用 eve::tactics::Tactics::restoreJson() , 以及 eve::tactics::Tactics::snapshotJson().

◆ snapshotEnvelopeValue()

EVENGINE_API_FOUNDATION Result< Value > eve::snapshotEnvelopeValue ( const SnapshotEnvelope & snapshot )

Convert an envelope to its strict canonical value representation.

参数

snapshot Envelope to encode.

返回: An owning object with exactly the public envelope fields.

在文件 Snapshot.cpp 第 121 行定义.

引用了 eve::SnapshotEnvelope::contentHash, eve::Result< T >::failure(), eve::detail::Id128< Tag >::format(), eve::LogicalId::format(), eve::SnapshotEnvelope::instanceId, object, eve::SnapshotEnvelope::payload, eve::SnapshotEnvelope::revision, eve::SnapshotEnvelope::schema, eve::SnapshotEnvelope::schemaVersion, eve::Result< T >::success(), eve::SnapshotEnvelope::tick, eve::SnapshotEnvelope::type, valid , 以及 eve::detail::StrongUint64< Tag >::value().

被这些函数引用 serializeSnapshotEnvelope().

◆ snapshotHashInput()

EVENGINE_API_FOUNDATION Result< std::string > eve::snapshotHashInput ( const SnapshotEnvelope & snapshot )

Produce the canonical JSON input used for a snapshot content hash.

参数

snapshot Envelope whose content hash is excluded from the input.

返回: Deterministic JSON containing stable header fields and payload.

备注: There is intentionally no createdAt or wall-clock field.

在文件 Snapshot.cpp 第 57 行定义.

引用了 eve::Result< T >::failure() , 以及 valid.

被这些函数引用 makeSnapshotEnvelope() , 以及 verifySnapshotEnvelope().

◆ statusCodeName()

constexpr std::string_view eve::statusCodeName ( StatusCode code )

constexprnoexcept

Return the stable protocol spelling of a status code.

参数

code	Status category to name.

返回: Static non-owning text; unknown values return "unknown".

在文件 Status.h 第 45 行定义.

引用了 Applied, Cancelled, code, Conflict, Failed, NoOp, NotFound, Ok, Pending, Rejected , 以及 Unsupported.

被这些函数引用 eve::Status::describe(), eve::dev::DevTool::exposeScriptApi(), eve::DiagnosticValueTraits< StatusCode >::name() , 以及 operator<<().

◆ thirdPartyVersion()

EVENGINE_API_FOUNDATION const char * eve::thirdPartyVersion ( )

Third party version.

返回: Third-party version this build was linked against (source<commit> / prebuilt<commit>).

在文件 Version.cpp 第 18 行定义.

◆ uriSchemeName()

EVENGINE_API_FOUNDATION const char * eve::uriSchemeName ( UriScheme scheme )

noexcept

Return the stable lower-case spelling of a resource URI scheme.

在文件 Uri.cpp 第 130 行定义.

引用了 Asset, Builtin, Generated, Memory , 以及 Project.

◆ utf8_byte_offset_for_codepoints()

EVENGINE_API_FOUNDATION size_t eve::utf8_byte_offset_for_codepoints	(	const std::string &	s,
		size_t	codepoints
	)

Byte offset of the N-th UTF-8 code point (0-based count of code points). Returns s.size() if there are fewer than N code points.

在文件 utf8.cpp 第 37 行定义.

引用了 n, s , 以及 step.

被这些函数引用 eve::dialogue::Dialogue::getVisibleText().

◆ utf8_codepoint_count()

EVENGINE_API_FOUNDATION size_t eve::utf8_codepoint_count ( const std::string & s )

Count UTF-8 code points in a string. Invalid / truncated sequences stop the scan.

在文件 utf8.cpp 第 23 行定义.

引用了 n, s , 以及 step.

被这些函数引用 eve::dialogue::Dialogue::getVisibleText(), eve::dialogue::Dialogue::skipTyping() , 以及 eve::dialogue::Dialogue::update().

◆ validateSnapshotPayloadMetadata()

EVENGINE_API_FOUNDATION Result< void > eve::validateSnapshotPayloadMetadata	(	const Value &	payload,
		Revision	revision,
		SimulationTick	tick
	)

Validate optional payload copies of envelope revision and tick.

参数

payload	Domain payload after any schema migration.
revision	Authoritative envelope revision.
tick	Authoritative envelope simulation tick.

返回: Success when omitted or exactly equal; Conflict/ParseError on a duplicate field that disagrees or is not a decimal string.

备注: Consumers may omit duplicate fields from new payloads. This helper gives legacy payloads one uniform compatibility rule before any consumer state is mutated.

在文件 Snapshot.cpp 第 80 行定义.

引用了 Conflict, eve::Diagnostic::error(), eve::Result< T >::failure(), found, object, payload, revision, eve::Result< T >::success(), tick , 以及 eve::detail::StrongUint64< Tag >::value().

被这些函数引用 eve::tactics::TacticsPersistence::restore(), eve::definition::restoreRuntimeInstance(), eve::authority::Store::restoreSnapshot(), eve::definitions::DefinitionRegistry::restoreSnapshot(), eve::game_event::GameEventLog::restoreSnapshot(), eve::production::WorkQueue::restoreSnapshot(), eve::statepatch::Store::restoreSnapshot() , 以及 eve::transaction::Ledger::restoreSnapshot().

◆ verifySnapshotEnvelope()

EVENGINE_API_FOUNDATION Result< void > eve::verifySnapshotEnvelope	(	const SnapshotEnvelope &	snapshot,
		const SnapshotHashProvider &	hashProvider
	)

Verify an envelope's content hash without modifying it.

参数

snapshot	Envelope to verify.
hashProvider	Injected digest provider used when the envelope was sealed.

返回: Success when the computed digest equals contentHash.

在文件 Snapshot.cpp 第 63 行定义.

引用了 eve::SnapshotEnvelope::contentHash, eve::Diagnostic::error(), eve::Result< T >::failure(), HashMismatch, input, snapshotHashInput(), eve::Result< T >::success(), Unsupported , 以及 valid.

被这些函数引用 eve::pixelworld_streaming::decodeChunkBatchArchive(), eve::SnapshotMigrationChain::migrate(), parseSnapshotEnvelopeValue(), eve::tactics::TacticsPersistence::restore(), eve::physics::World::restore(), eve::physics::World3D::restore(), eve::procgen::ArtifactPublisher::restore(), eve::definition::restoreRuntimeInstance() , 以及 eve::pixelworld_replay::PixelReplayLog::restoreSnapshot().

变量说明

◆ Array

enum EVENGINE_API_FOUNDATION eve::Array = 5

OT_ARRAY (editable via Runtime array APIs / ReflectedPropertyModel).

在文件 Runtime.h 第 120 行定义.

被这些函数引用 eve::ui::EditorHost::consumeEvents(), eve::ui::EditorHost::editorState(), eve::pixelworld::encodeMaterialCatalogJson(), eve::pixelworld::encodePixelWorldGenerationRequestJson(), eve::ui::EditorHost::listEditors() , 以及 eve::ui::EditorHost::status().

◆ async_content

const char* eve::async_content

extern

被这些函数引用 eve::cmd::Cmdline::Run().

◆ Bool

enum EVENGINE_API_FOUNDATION eve::Bool = 1

OT_BOOL.

在文件 Runtime.h 第 116 行定义.

◆ boot_content

const char* eve::boot_content

extern

嵌入式脚本 / 着色器源码常量（构建时由集成脚本生成）。

◆ demo_content

const char* eve::demo_content

extern

被这些函数引用 eve::cmd::Cmdline::Run().

◆ Float

enum EVENGINE_API_FOUNDATION eve::Float = 3

OT_FLOAT.

在文件 Runtime.h 第 118 行定义.

◆ fragment_content

const char* eve::fragment_content

extern

◆ Instance

enum EVENGINE_API_FOUNDATION eve::Instance = 7

Nested script instance (navigate; ObjectRef in property schema).

在文件 Runtime.h 第 122 行定义.

◆ Integer

enum EVENGINE_API_FOUNDATION eve::Integer = 2

OT_INTEGER.

在文件 Runtime.h 第 117 行定义.

◆ kGpuResidentStorageOffsetAlignment

constexpr uint64_t eve::kGpuResidentStorageOffsetAlignment = 256

constexpr

Portable alignment required for resident storage-buffer slice offsets.

在文件 GpuResidentBufferView.h 第 11 行定义.

被这些函数引用 eve::graphics::vulkan::Graphics::gpuDrivenSubmitResident() , 以及 eve::graphics::webgpu::Graphics::gpuDrivenSubmitResident().

◆ kSessionEndMarker

constexpr const char* eve::kSessionEndMarker = "session end (exit code"

inlineconstexpr

Marker text that closes a session block (followed by the exit code). @ownership Borrowed pointer to a static string literal; the caller owns nothing. @lifetime Static storage duration; valid for the whole process.

在文件 CrashLog.h 第 46 行定义.

被这些函数引用 recordSessionEnd().

◆ kSessionStartMarker

constexpr const char* eve::kSessionStartMarker = "EVEngine session start"

inlineconstexpr

Marker text that opens a session block in eve.log.

Writers and readers of the log share these constants so an external tool can delimit sessions without duplicating a literal that could silently drift. @ownership The pointer is borrowed, not owned: it addresses a string literal with static storage duration. @lifetime Static: valid for the whole process, never freed by the caller.

在文件 CrashLog.h 第 39 行定义.

被这些函数引用 recordSessionStart().

◆ load_content

const char* eve::load_content

extern

被这些函数引用 eve::cmd::RunArgs::parse().

◆ module_list_content

const char* eve::module_list_content

extern

Generated slot -> class table for the modules in this build.

被这些函数引用 eve::dev::LanguageServer::Impl::Impl() , 以及 eve::cmd::Cmdline::Run().

◆ Other

enum EVENGINE_API_FOUNDATION eve::Other = 8

Any other slot kind.

在文件 Runtime.h 第 123 行定义.

◆ ReflectedValueKind

enum EVENGINE_API_FOUNDATION eve::ReflectedValueKind

strong

Runtime value kind read from a live script instance slot.

Missing / null slot.

在文件 Runtime.h 第 114 行定义.

◆ scene_director_content

const char* eve::scene_director_content

extern

被这些函数引用 eve::cmd::Cmdline::Run().

◆ String

enum EVENGINE_API_FOUNDATION eve::String = 4

OT_STRING.

在文件 Runtime.h 第 119 行定义.

◆ Table

enum EVENGINE_API_FOUNDATION eve::Table = 6

OT_TABLE (editable via Runtime table APIs / ReflectedPropertyModel).

在文件 Runtime.h 第 121 行定义.

◆ vertex_content

const char* eve::vertex_content

extern

命名空间

类

概念

类型定义

枚举

函数

变量

详细描述

类型定义说明

◆ ArtifactId

◆ AssetGuid

◆ Color

◆ CommandId

◆ ContentId

◆ CppEntityViewFn

◆ DiagnosticDetail

◆ DiagnosticDetails

◆ DocumentId

◆ EffectId

◆ EventId

◆ EventSequence

◆ FrameIndex

◆ Generation

◆ IStateMutation

◆ IStateQuery

◆ MutationContext

◆ MutationKind

◆ MutationReceipt

◆ OperationId

◆ OptionalRef

◆ PersistentId

◆ PhotoModeValue

◆ PostEcsHook

◆ ProtocolDispatchResult

◆ ResourcePin

◆ ResultRef

◆ Revision

◆ SceneObjectId

◆ SchemaVersion

◆ SimulationTick

◆ SnapshotHashProvider

◆ StateMutation

◆ StrongUuid

◆ TransactionId

◆ UuidClock

◆ UuidEntropySource

枚举类型说明

◆ BlendMode

◆ ContentDigestKind

◆ DiagnosticCode

◆ GameplayAccess

◆ GpuResidentBackend

◆ MeshDeformationComputeOperation

◆ ParticleSdfGradientStatus

◆ PhotoModeDomain

◆ PhotoModeFieldAcceptance

◆ ProtocolDispatch

◆ RegistryOperation

◆ ResourceRefKind

◆ ScriptStage

◆ ScriptState

◆ Severity

◆ StatusCode

◆ UriScheme

◆ Utf8NullPolicy

函数说明

◆ activeSnapshotHashAlgorithm()

◆ b64_decode()

◆ b64_encode()

◆ buildInfo()

◆ builtinSnapshotContentHasher()

◆ contentDigestKindName()

◆ crashLogPath()

◆ diagnosticCodeName()

◆ diagnosticValueCode()

◆ diagnosticValueName()

◆ everyResultValid()

◆ executeGameplayControlJson()

◆ executeGameplayControlRequest()

◆ exposeECS()