A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
// The curated half of the component reference: what each component is for, and
// which guide explains it. The exhaustive half — every field, its type and its
// authoring default — is derived from the engine's own registry into
// `components.generated.json` by `tools/component-reference.mjs`, so it cannot
// drift from the code.
//
// Keep one entry per registered component: `--check` fails when the engine gains
// or loses one. `doc: null` means nothing in the manual explains it yet — the
// reference still lists it, and the check prints it as a documentation gap.
//
// The anchors are real heading ids read off the built pages, not guesses (a
// heading slug is not hand-derivable: "Bodies & colliders" is `bodies--colliders`,
// with two hyphens). `npm run verify:links` resolves every one of them after the
// build, so a wrong anchor fails there.
export type ComponentCategory =
| 'core'
| 'graphics'
| 'ui'
| 'physics'
| 'animation'
| 'world'
| 'gameplay';
export interface ComponentDoc {
/** Which reference page lists it. */
category: ComponentCategory;
/** One line: what it is for. */
summary: string;
/** Slug of the guide that explains it, or null when none does yet. */
doc: string | null;
/** Heading id on that guide, when a section is dedicated to it. */
anchor?: string;
/**
* The same heading on the Chinese page, whose id is its Chinese text. Derived
* by position — the translations are structural mirrors — and then verified
* like every other link by `npm run verify:links`.
*/
anchorZh?: string;
}
export const CATEGORY_LABELS: Record<ComponentCategory, string> = {
core: 'Core',
graphics: 'Graphics',
ui: 'UI',
physics: 'Physics',
animation: 'Animation',
world: 'World',
gameplay: 'Gameplay',
};
export const COMPONENT_DOCS: Record<string, ComponentDoc> = {
// ── Core ───────────────────────────────────────────────────────────────────
NodeVisibility: { category: 'core', summary: 'An animatable visual gate for an entity subtree that preserves authored renderer flags; particle emitters use their enabled flag while hidden.', doc: 'world/scenes' },
Transform: { category: 'core', summary: 'Position, rotation and scale — plus the read-only world-space values the engine composes down the parent chain.', doc: 'core-concepts/transforms', anchor: 'the-transform-component', anchorZh: 'transform-组件' },
Parent: { category: 'core', summary: 'The entity this one hangs under. The engine keeps it and `Children` in step; set it through the hierarchy API.', doc: 'core-concepts/transforms', anchor: 'parenting--hierarchy', anchorZh: '父子层级' },
Children: { category: 'core', summary: "The entity's children, maintained by the engine alongside `Parent`. Its order is the order UI lays out and draws children in, and what hierarchy-order layers stack by.", doc: 'core-concepts/transforms', anchor: 'parenting--hierarchy', anchorZh: '父子层级' },
Name: { category: 'core', summary: "The entity's display name — what the World Outliner shows and what name lookups resolve against.", doc: 'core-concepts/components', anchor: 'the-ones-the-engine-reads-about-your-entities', anchorZh: '引擎用来描述实体的那几个' },
Velocity: { category: 'core', summary: 'Constant linear and angular motion applied every frame, with no physics body involved.', doc: 'scripting/overview', anchor: 'constant-motion-the-velocity-component', anchorZh: '匀速运动velocity-组件' },
SceneOwner: { category: 'core', summary: 'Which additively-loaded scene owns the entity, and whether it survives that scene being unloaded.', doc: 'world/scenes', anchor: 'persistent-entities', anchorZh: '持久化实体' },
Disabled: { category: 'core', summary: 'Tag added by `setEntityActive(false)`: an entity counts as active exactly while it is absent.', doc: 'core-concepts/components', anchor: 'the-ones-the-engine-reads-about-your-entities', anchorZh: '引擎用来描述实体的那几个' },
RuntimeOnly: { category: 'core', summary: 'Tag for a world-only derived entity (the layers a `Tilemap` projects, runtime tile colliders). Scene saves skip it, because persisting one would duplicate it against the next derivation.', doc: 'core-concepts/components', anchor: 'the-ones-the-engine-reads-about-your-entities', anchorZh: '引擎用来描述实体的那几个' },
// ── Graphics ───────────────────────────────────────────────────────────────
Sprite: { category: 'graphics', summary: 'Draws a texture in the world — tint, size, pivot, sorting layer, flipping, tiling and parallax.', doc: 'graphics/sprites', anchor: 'sprite-fields', anchorZh: 'sprite-字段' },
BitmapText: { category: 'graphics', summary: 'Text drawn in world space from a bitmap font, sorted alongside sprites (UI text is `Text`).', doc: 'graphics/sprites', anchor: 'bitmap-text-in-the-world', anchorZh: '世界空间位图文字' },
ShapeRenderer: { category: 'graphics', summary: 'A filled or stroked primitive — rectangle, circle, capsule — with no texture asset.', doc: 'graphics/sprites', anchor: 'shapes-without-a-texture', anchorZh: '不带纹理的图元' },
TrailRenderer: { category: 'graphics', summary: 'A ribbon trailing the entity as it moves, tapering and fading over its lifetime.', doc: 'graphics/sprites', anchor: 'motion-trails', anchorZh: '拖尾' },
Camera: { category: 'graphics', summary: 'A view onto the world — projection, zoom, viewport rect, clear flags and render priority.', doc: 'graphics/camera', anchor: 'the-camera-component', anchorZh: 'camera-组件' },
FollowTarget: { category: 'graphics', summary: 'Makes a camera chase an entity, with an offset, a dead zone and eased catch-up.', doc: 'graphics/camera', anchor: 'follow-a-target', anchorZh: '跟随目标' },
CameraBounds: { category: 'graphics', summary: 'The world rectangle a camera may not look outside of, so the level edge stays at the screen edge.', doc: 'graphics/camera', anchor: 'keep-the-camera-inside-the-level', anchorZh: '把相机限制在关卡内' },
Canvas: { category: 'graphics', summary: 'The design resolution and scale mode a scene is authored against — one per scene root.', doc: 'core-concepts/screen', anchor: 'the-canvas-component', anchorZh: 'canvas-组件' },
Light: { category: 'graphics', summary: 'A light — point, directional, spot or ambient — read by lit renderers, Lit materials and mesh shadow maps.', doc: 'graphics/lighting', anchor: 'light-types', anchorZh: '光源类型' },
ShadowCaster2D: { category: 'graphics', summary: 'Marks a renderer as an occluder, so 2D lights cast shadows from its silhouette.', doc: 'graphics/lighting', anchor: 'casting-shadows', anchorZh: '投射阴影' },
PostProcessVolume: { category: 'graphics', summary: 'A stack of full-screen effects (bloom, vignette, colour grading) applied after the scene is drawn.', doc: 'graphics/post-processing', anchor: 'using-a-postprocessvolume', anchorZh: '使用-postprocessvolume' },
TimeOfDay: { category: 'graphics', summary: 'The time of day of a scene — where the sun and the moon are, and the light, sky, fog and exposure that follow — driving lights, a procedural sky, fog and exposure.', doc: 'graphics/time-of-day' },
Weather: { category: 'graphics', summary: 'The weather of a scene — a preset, a turn toward another, and an optional cycle — driving lights, fog, rain, grade, exposure and reflections.', doc: 'graphics/weather' },
MeshRenderer: { category: 'graphics', summary: 'Geometry drawn as an entity — your own vertices or an imported mesh, with a material and a sorting layer.', doc: 'graphics/drawing', anchor: 'custom-meshes-meshrenderer', anchorZh: '自定义网格meshrenderer' },
MeshSkin: { category: 'graphics', summary: 'The joint entities that deform a MeshRenderer — an imported skin, in the order its bind matrices are in.', doc: 'assets/models', anchor: 'skinning', anchorZh: '蒙皮' },
MeshMorph: { category: 'graphics', summary: 'How far a MeshRenderer is blended towards each of the shapes its mesh carries — one weight per morph target.', doc: 'assets/models', anchor: 'morph-targets', anchorZh: 'morph-target' },
MeshLightmap: { category: 'graphics', summary: 'Where a MeshRenderer\'s baked light comes from — the atlas, and the rectangle of it this object occupies.', doc: 'graphics/lighting', anchor: 'baked-light', anchorZh: '烘焙光照' },
LightProbeVolume: { category: 'graphics', summary: 'A box of baked irradiance on a grid — what lights the things a lightmap cannot hold still, characters included.', doc: 'graphics/lighting', anchor: 'baked-light', anchorZh: '烘焙光照' },
BakedLighting: { category: 'graphics', summary: 'How this scene is baked — atlas size, density, bounces — and a record of what the last bake read.', doc: 'graphics/lighting', anchor: 'baked-light', anchorZh: '烘焙光照' },
DecalProjector: { category: 'graphics', summary: 'Prints this entity\'s material onto what its box covers — the surface is cut to the box and drawn again, so a decal is lit and shadowed as the surface under it.', doc: 'graphics/lighting', anchor: 'baked-light', anchorZh: '烘焙光照' },
BlobShadow: { category: 'graphics', summary: 'A soft dark disc on the ground under an entity — no shadow map, no light, no extra pass — that fades and shrinks as the entity leaves the ground.', doc: 'graphics/lighting', anchor: 'blob-shadows-a-disc-instead-of-a-shadow-map', anchorZh: '假阴影用一个圆片代替阴影图' },
Footsteps: { category: 'graphics', summary: 'Makes what walks leave rings on water and prints on soft ground, by the StepSurface under each step.', doc: 'graphics/sprites', anchor: 'footsteps-and-ripples', anchorZh: '脚印与涟漪' },
StepSurface: { category: 'graphics', summary: 'Makes the ground this sprite covers a surface that steps leave water rings or footprints on.', doc: 'graphics/sprites', anchor: 'footsteps-and-ripples', anchorZh: '脚印与涟漪' },
SwayPusher: { category: 'graphics', summary: 'A body the plants of a sprite-sway material lean away from as it walks through them: the eight nearest the camera are told to the shader.', doc: 'graphics/materials', anchor: 'built-in-shader-templates', anchorZh: '内置着色器模板' },
FogOfWar: { category: 'graphics', summary: 'Names the world rectangle a 2D fog of war covers: ground no SightViewer has seen is dark, ground seen and left is remembered, ground in view is clear.', doc: 'graphics/sprites', anchor: 'fog-of-war', anchorZh: '战争迷雾' },
SightViewer: { category: 'graphics', summary: 'An eye: sprites with a SightTarget are seen while some viewer has a clear line to them past the ShadowCaster2D walls.', doc: 'graphics/sprites', anchor: 'what-the-player-can-see', anchorZh: '玩家能看见什么' },
SightTarget: { category: 'graphics', summary: 'Hides the sprite while no SightViewer has a clear line to it, for what is not lit and so is not hidden by the shadows of walls.', doc: 'graphics/sprites', anchor: 'what-the-player-can-see', anchorZh: '玩家能看见什么' },
CoverFade: { category: 'graphics', summary: 'A roof or a tree crown that thins out while a CoverFadeTarget stands under it, so the player is never hidden by what they walked into.', doc: 'graphics/sprites', anchor: 'fading-a-roof-or-a-crown-over-the-player', anchorZh: '屋顶与树冠遮挡淡出' },
CoverFadeTarget: { category: 'graphics', summary: 'Marks what a CoverFade keeps visible — the player, and anything else that must not be hidden by a roof or a crown.', doc: 'graphics/sprites', anchor: 'fading-a-roof-or-a-crown-over-the-player', anchorZh: '屋顶与树冠遮挡淡出' },
RainUpright: { category: 'graphics', summary: 'Marks a sprite that stands on the ground (a character, a trunk), so the 2D rain draws no rings, splashes or wet darkening over it.', doc: 'graphics/sprites', anchor: 'keeping-the-ground-under-a-roof-dry', anchorZh: '让屋顶下的地面保持干燥' },
RainShelter: { category: 'graphics', summary: 'A roof, awning or crown that keeps the ground under it dry in the 2D rain, as far as the sprite lets that ground be seen.', doc: 'graphics/sprites', anchor: 'keeping-the-ground-under-a-roof-dry', anchorZh: '让屋顶下的地面保持干燥' },
StreamedWorld: { category: 'world', summary: 'Declares the scene a streamed world and how big the cook cuts its cells.', doc: 'world/streaming', anchor: 'declaring-a-streamed-world', anchorZh: '声明一个流送世界' },
WorldPersistent: { category: 'world', summary: 'Keeps an entity\'s whole subtree out of the partition — it belongs to the persistent world.', doc: 'world/streaming', anchor: 'declaring-a-streamed-world', anchorZh: '声明一个流送世界' },
WorldGen: { category: 'world', summary: 'A generated world: names the game\'s rules (biomes, recipes, layers), their version, the world and its seed; what the rules place is laid out round the streaming sources.', doc: 'world/generation', anchor: 'the-worldgen-component', anchorZh: 'worldgen-组件' },
WorldZone: { category: 'world', summary: 'An area of a generated world planned by hand: kept clear of what it excludes, held to a biome, its edge fading out.', doc: 'world/generation', anchor: 'zones', anchorZh: '区域' },
PlacedObject: { category: 'world', summary: 'Written by a generated world on what the game interacts with (ore, a tree to fell): its stable placement id and kind.', doc: 'world/generation', anchor: 'interactive-placements-and-changes', anchorZh: '可交互的放置物与变化' },
WorldStreamingSource: { category: 'world', summary: 'Asks for the places near it to exist; several sources are unioned.', doc: 'world/streaming', anchor: 'asking-for-places-streaming-sources', anchorZh: '请求地方存在流送源' },
SpriteMask: { category: 'graphics', summary: "Turns this entity's Sprite into a stencil that cuts the sprites drawn after it — a window, or a hole.", doc: 'graphics/sprites', anchor: 'sprite-masks', anchorZh: '精灵遮罩' },
SortingGroup: { category: 'graphics', summary: 'Makes an entity and its whole subtree sort as one unit — the group states the layer and order, members state their place inside it.', doc: 'graphics/sprites', anchor: 'sorting-groups', anchorZh: '排序组' },
GroupOpacity: { category: 'graphics', summary: 'Fades an entity and everything under it; the opacities multiply down the hierarchy into each descendant\'s own alpha.', doc: 'graphics/sprites', anchor: 'fading-a-whole-group', anchorZh: '整组淡出' },
CompositeBatch: { category: 'graphics', summary: 'Marks the root of a model built from many parts that moves as a whole, so its parts are drawn in a few draws that follow the root: repeated meshes as instanced sets, the rest merged in chunks of the root\'s space.', doc: 'performance/static-batching', anchor: 'a-model-that-moves-compositebatch', anchorZh: '会移动的组合模型compositebatch' },
StaticBatch: { category: 'graphics', summary: 'Marks a mesh that will not move, so the meshes sharing its material are merged into one draw while the game runs; it also records what became of this one.', doc: 'performance/static-batching', anchor: 'what-happens', anchorZh: '会发生什么' },
Terrain: { category: 'graphics', summary: 'Ground made from a heightmap or noise, painted by height and slope, and drawn in chunks that coarsen with distance.', doc: 'graphics/terrain', anchor: 'the-component', anchorZh: '组件' },
Planet: { category: 'graphics', summary: 'Ground on a sphere, drawn as six quadtrees round the eye from a generator the game registers, finest underfoot and a handful of coarse nodes from space.', doc: 'graphics/terrain', anchor: 'a-planet', anchorZh: '星球' },
Foliage: { category: 'graphics', summary: 'Scatters grass or a mesh across an area and over a terrain, drawn a cell at a time, swaying in the wind and thinning out with distance.', doc: 'graphics/foliage', anchor: 'the-component', anchorZh: '组件' },
PlacedFoliage: { category: 'graphics', summary: 'Keeps every plant an artist placed by hand as data in one entity, grown a cell at a time as instances of the plants\' own meshes.', doc: 'graphics/foliage', anchor: 'placed-plants', anchorZh: '手摆植物' },
MeshInstances: { category: 'graphics', summary: 'Draws the mesh of a MeshRenderer at many places as one renderable, culling each place and choosing its mesh by distance.', doc: 'graphics/foliage', anchor: 'placed-plants', anchorZh: '手摆植物' },
Floating: { category: 'graphics', summary: 'Holds a RigidBody3D up in water and carries it with the current, by forces at a few points of the body.', doc: 'graphics/water', anchor: 'floating', anchorZh: '漂浮' },
Spline: { category: 'graphics', summary: 'A curve through points, each with a width, read by what follows it (a river\'s WaterBody on the same entity); measured by the distance along it.', doc: 'graphics/water', anchor: 'splines', anchorZh: '样条' },
Waterfall: { category: 'graphics', summary: 'Water falling from a lip: sheets thrown level at a speed and taken by gravity until they meet the ground or other water, drawn as the mesh of the entity itself.', doc: 'graphics/water', anchor: 'waterfalls', anchorZh: '瀑布' },
WaterfallAnchor: { category: 'graphics', summary: 'Keeps a child of a Waterfall on the middle of the fall: at its foot wherever the water lands, or a share of the time down. Where the mist goes.', doc: 'graphics/water', anchor: 'waterfalls', anchorZh: '瀑布' },
WaterBody: { category: 'graphics', summary: 'An ocean, a lake or a river: where the water is, how high its waves stand and how it flows; drawn as part of its zone\'s one surface.', doc: 'graphics/water', anchor: 'the-component', anchorZh: '组件' },
WaterZone: { category: 'graphics', summary: 'The region the bodies of water are baked over and drawn from as one surface: the waves they share, the material, the mesh and the ripples.', doc: 'graphics/water', anchor: 'the-zone', anchorZh: '水体区域' },
Billboard: { category: 'graphics', summary: 'Turns the MeshRenderer beside it to face each view that draws it: flat in the view plane, or upright about world up.', doc: 'graphics/drawing', anchor: 'cards-that-face-the-camera-billboard', anchorZh: '朝向相机的卡片billboard' },
Impostor: { category: 'graphics', summary: 'Stands a card showing a picture of the mesh in for the MeshRenderer once the object is small on screen; the pictures are taken from many directions while the game runs.', doc: 'performance/level-of-detail', anchor: 'impostors-a-picture-in-place-of-a-far-mesh', anchorZh: 'impostor用一张图代替远处的网格' },
LODGroup: { category: 'graphics', summary: 'Cheaper stand-in meshes for a MeshRenderer, chosen by how much of the screen the object covers.', doc: 'performance/level-of-detail', anchor: 'the-lodgroup-component', anchorZh: 'lodgroup-组件' },
ReflectionProbe: { category: 'graphics', summary: 'A box inside which reflections come from a bake rather than from the sky — the specular half of what a light probe volume answers.', doc: 'graphics/lighting', anchor: 'baked-light', anchorZh: '烘焙光照' },
PlanarReflection: { category: 'graphics', summary: 'Captures a mirrored view for flat lit surfaces, with layer filtering, capture quality and update controls.', doc: 'graphics/lighting' },
Occluder: { category: 'graphics', summary: 'A box sight does not pass through — what stands behind it is not collected, and the picture is unchanged.', doc: 'performance/occlusion-culling', anchor: 'the-box-is-authored-and-it-belongs-inside-the-wall', anchorZh: '盒子是创作出来的而且它要在墙的里面' },
Video: { category: 'graphics', summary: 'Plays a video stream onto a surface in the world or the UI.', doc: 'graphics/video', anchor: 'the-video-component', anchorZh: 'video-组件' },
// ── UI ─────────────────────────────────────────────────────────────────────
UINode: { category: 'ui', summary: 'The UI box: size, position, margins and padding in design pixels. Every UI entity has one.', doc: 'ui/layout', anchor: 'uinode--the-box', anchorZh: 'uinode盒子' },
UIVisual: { category: 'ui', summary: 'What a UI node actually paints — a colour, a texture, or a nine-sliced sprite.', doc: 'ui/overview', anchor: 'uivisual-and-uimask', anchorZh: 'uivisual-与-uimask' },
UIMask: { category: 'ui', summary: "Clips descendants to this node's rect, with an optional alpha cutoff.", doc: 'ui/lists', anchor: 'clipping--uimask', anchorZh: '裁剪--uimask' },
ContentRect: { category: 'ui', summary: 'The rectangle world content occupies — a size and the pivot the transform sits on — that its sprite, text and clip mask follow.', doc: 'ui/overview', anchor: 'contentrect--a-rectangle-for-world-content', anchorZh: 'contentrect--世界内容的矩形' },
RectAnchors: { category: 'ui', summary: 'Pins content placed by its transform to the edges or the centre of its parent\'s ContentRect, or of the screen: each axis stretched, pinned to an edge, or centred, with margins in units or as a fraction.', doc: 'ui/overview', anchor: 'rectanchors--world-content-that-follows-its-parent', anchorZh: 'rectanchors--跟随父级的世界内容' },
UIWorldAnchor: { category: 'ui', summary: 'Stands a UI node over a point in the 3D world — an objective marker, a name over a head — and keeps it on the screen\'s edge when the point is out of view.', doc: 'ui/overview', anchor: 'uiworldanchor--ui-over-a-point-in-the-world', anchorZh: 'uiworldanchor--立在世界某一点上的-ui' },
UIScroll: { category: 'ui', summary: 'Scrollable content inside a clipped viewport, with momentum and scrollbars.', doc: 'ui/overview', anchor: 'scrolling', anchorZh: '滚动' },
FlexContainer: { category: 'ui', summary: 'Lays children out along an axis — direction, justification, alignment, wrapping and gaps.', doc: 'ui/layout', anchor: 'flexcontainer--laying-out-children', anchorZh: 'flexcontainer排布子项' },
Interactable: { category: 'ui', summary: 'Makes a UI node hit-testable, so pointer events can land on it.', doc: 'ui/interaction', anchor: 'hit-testing-interactable--uiinteraction', anchorZh: '命中测试interactable--uiinteraction' },
UIInteraction: { category: 'ui', summary: "Live pointer state for an interactable node — hovered, pressed, and the frame's transitions.", doc: 'ui/interaction', anchor: 'hit-testing-interactable--uiinteraction', anchorZh: '命中测试interactable--uiinteraction' },
Text: { category: 'ui', summary: 'UI text — font, size, alignment, colour, outline, shadow, rich-text markup and a localization key.', doc: 'ui/text', anchor: 'text-properties', anchorZh: 'text-属性' },
TextInput: { category: 'ui', summary: 'An editable text field with a caret, selection and IME support.', doc: 'ui/widgets', anchor: 'text-input', anchorZh: '文本输入' },
Draggable: { category: 'ui', summary: 'Lets the pointer drag a UI node, optionally constrained to an axis.', doc: 'ui/interaction', anchor: 'drag--drop', anchorZh: '拖放' },
DragState: { category: 'ui', summary: 'Transient per-frame geometry of a drag in progress; the drag system rebuilds it, scene saves omit it.', doc: 'ui/interaction', anchor: 'drag--drop', anchorZh: '拖放' },
UIConsumesDrag: { category: 'ui', summary: 'Transient input ownership for drag controls: enclosing lists keep wheel input but do not start a competing drag scroll.', doc: 'ui/widgets', anchor: 'treeview', anchorZh: 'treeview' },
Focusable: { category: 'ui', summary: 'Puts a widget in the keyboard focus order.', doc: 'ui/interaction', anchor: 'focus--keyboard', anchorZh: '焦点与键盘' },
SafeArea: { category: 'ui', summary: 'Insets an absolute UI node clear of notches and rounded corners.', doc: 'core-concepts/screen', anchor: 'safe-areas-notches--rounded-corners', anchorZh: '安全区刘海与圆角' },
ThemeStyle: { category: 'ui', summary: "Records which theme role an entity's colours came from, so a live theme swap can repaint it.", doc: 'ui/theming', anchor: 'how-widgets-consume-tokens', anchorZh: '控件如何消费令牌' },
UIController: { category: 'ui', summary: 'Shared named page state a whole subtree switches on — no bespoke per-widget state.', doc: 'ui/controllers', anchor: 'controllers', anchorZh: '控制器' },
UIGear: { category: 'ui', summary: 'Per-page field values a controller drives declaratively, authored from the Details panel.', doc: 'ui/controllers', anchor: 'gears', anchorZh: '属性绑定' },
UIDialog: { category: 'ui', summary: 'A modal dialog surface — backdrop, result, and open/close state.', doc: 'ui/widgets', anchor: 'dialog', anchorZh: 'dialog-对话框' },
UIDropdown: { category: 'ui', summary: 'A dropdown selector: its options and the selected index.', doc: 'ui/widgets', anchor: 'dropdown', anchorZh: 'dropdown-下拉框' },
VirtualJoystick: { category: 'ui', summary: 'An independently captured fixed or follow joystick, feeding a named virtual InputMap axis.', doc: 'ui/widgets', anchor: 'virtualjoystick', anchorZh: 'virtualjoystick' },
VirtualButton: { category: 'ui', summary: 'A held virtual InputMap action with independent pointer ownership and normal button appearance.', doc: 'ui/widgets', anchor: 'virtualbutton', anchorZh: 'virtualbutton' },
UISlider: { category: 'ui', summary: 'A draggable value along a range, with an optional step.', doc: 'ui/widgets', anchor: 'slider', anchorZh: 'slider-滑块' },
UIToggle: { category: 'ui', summary: 'A two-state widget — checkbox or switch — and its group membership.', doc: 'ui/widgets', anchor: 'toggle', anchorZh: 'toggle-开关' },
UIToggleGroup: { category: 'ui', summary: 'Makes the toggles beneath it exclusive — a radio group or tab bar. Put it on their common ancestor.', doc: 'ui/widgets', anchor: 'toggle', anchorZh: 'toggle-开关' },
UITabView: { category: 'ui', summary: 'Connects an ordered ToggleGroup to content pages, with keyboard navigation.', doc: 'ui/widgets', anchor: 'tabview', anchorZh: 'tabview' },
UITooltip: { category: 'ui', summary: 'A themed engine tooltip with hover, focus, long press and screen-edge placement.', doc: 'ui/widgets', anchor: 'tooltip', anchorZh: 'tooltip' },
UITreeView: { category: 'ui', summary: 'Adapts project hierarchy data to a virtualized tree with stable IDs and host-owned drop requests.', doc: 'ui/widgets', anchor: 'treeview', anchorZh: 'treeview' },
UIColorPicker: { category: 'ui', summary: 'HSV/RGB/HEX and alpha editing with canonical RGBA events for UI, sprites and materials.', doc: 'ui/widgets', anchor: 'colorpicker', anchorZh: 'colorpicker' },
// ── Physics ────────────────────────────────────────────────────────────────
RigidBody2D: { category: 'physics', summary: 'Puts the entity under the flat solver: static, kinematic or dynamic, with damping, gravity scale and sleep.', doc: 'gameplay/physics', anchor: 'rigidbody2d', anchorZh: 'rigidbody2d' },
BoxCollider2D: { category: 'physics', summary: 'A rectangular collision shape. Sizes are in **metres**, not pixels.', doc: 'gameplay/physics', anchor: 'colliders', anchorZh: '碰撞体' },
CircleCollider2D: { category: 'physics', summary: 'A circular collision shape. Radius is in **metres**.', doc: 'gameplay/physics', anchor: 'colliders', anchorZh: '碰撞体' },
CapsuleCollider2D: { category: 'physics', summary: 'A capsule collision shape — the usual choice for a character body.', doc: 'gameplay/physics', anchor: 'colliders', anchorZh: '碰撞体' },
SegmentCollider2D: { category: 'physics', summary: 'A single line segment — a one-sided wall or edge.', doc: 'gameplay/physics', anchor: 'colliders', anchorZh: '碰撞体' },
PolygonCollider2D: { category: 'physics', summary: 'A convex polygon collision shape from your own points.', doc: 'gameplay/physics', anchor: 'colliders', anchorZh: '碰撞体' },
ChainCollider2D: { category: 'physics', summary: 'A polyline of edges — open or looped — for static terrain.', doc: 'gameplay/physics', anchor: 'colliders', anchorZh: '碰撞体' },
RigidBody3D: { category: 'physics', summary: 'Puts the entity under the 3D solver — its own component set, so a 2D scene keeps the world it already has.', doc: 'gameplay/physics-3d', anchor: 'bodies', anchorZh: '刚体' },
CompoundCollider3D: { category: 'physics', summary: 'Boxes, spheres and capsules with local positions and rotations, combined into one native rigid body using the model placement scale.', doc: 'gameplay/physics-3d' },
BoxCollider3D: { category: 'physics', summary: 'A box collision shape in 3D. Half-extents are in world units.', doc: 'gameplay/physics-3d', anchor: 'shapes', anchorZh: '形状' },
SphereCollider3D: { category: 'physics', summary: 'A sphere collision shape in 3D.', doc: 'gameplay/physics-3d', anchor: 'shapes', anchorZh: '形状' },
CapsuleCollider3D: { category: 'physics', summary: 'An upright capsule — what a 3D character is. Total height is 2*(halfHeight + radius).', doc: 'gameplay/physics-3d', anchor: 'shapes', anchorZh: '形状' },
MeshCollider3D: { category: 'physics', summary: 'Collides against an imported mesh\u2019s own triangles — terrain, stairs, a room. Always static, and one-sided.', doc: 'gameplay/physics-3d', anchor: 'colliding-against-imported-geometry', anchorZh: '用导入的几何做碰撞' },
ConvexCollider3D: { category: 'physics', summary: 'Collides against the convex hull of an imported mesh — the shape a solver can push, unlike a mesh collider.', doc: 'gameplay/physics-3d', anchor: 'colliding-against-imported-geometry', anchorZh: '用导入的几何做碰撞' },
Breakable: { category: 'physics', summary: 'A thing that breaks: drawn whole until `broken` is raised, then its pieces, cut beforehand, are put where it stood and thrown out from where it was struck.', doc: 'gameplay/physics-3d', anchor: 'things-that-break', anchorZh: '会碎的东西' },
CharacterController3D: { category: 'physics', summary: 'A kinematic 3D mover: swept against the world, climbs steps, stays glued to slopes, and reports the ground it is on.', doc: 'gameplay/physics-3d', anchor: 'characters', anchorZh: '角色' },
ThirdPersonController: { category: 'physics', summary: 'Turns input into a movement request for a CharacterController3D, and reports what the character actually did to its Animator.', doc: 'gameplay/physics-3d', anchor: 'third-person', anchorZh: '第三人称' },
ThirdPersonCamera: { category: 'physics', summary: 'An eye that orbits a target under pointer control and pulls in when something solid stands between.', doc: 'gameplay/physics-3d', anchor: 'third-person', anchorZh: '第三人称' },
MeleeAttack: { category: 'physics', summary: 'A swing whose timing is the animation’s and whose reach is the physics world’s: a `hit` beat asks what is around an animated anchor, and gameplay decides who may be hurt.', doc: 'gameplay/physics-3d', anchor: 'melee-combat', anchorZh: '近战' },
Hunter: { category: 'physics', summary: 'A character that hunts what it perceives: it asks navigation for a route, the character controller for the movement, and the animator for a swing — the concrete twin of ThirdPersonController.', doc: 'gameplay/ai/overview', anchor: 'a-melee-enemy-without-writing-one', anchorZh: '不用写代码的近战敌人' },
Health: { category: 'physics', summary: 'What something has left, and what makes it damageable at all — written only by the system that answers the Damage bus.', doc: 'gameplay/physics-3d', anchor: 'melee-combat', anchorZh: '近战' },
Ragdoll: { category: 'physics', summary: 'Turns a skinned character\'s bones into jointed bodies while active, with limits by part of the body and one-way knees and elbows, and blends back to the animation when it is switched off.', doc: 'gameplay/physics-3d', anchor: 'ragdoll', anchorZh: '布娃娃' },
Hitboxes: { category: 'physics', summary: 'A box on each bone of a skinned character that follows the animation: a kinematic sensor a ray meets and names, so a shot can tell a head from a boot.', doc: 'gameplay/physics-3d', anchor: 'telling-the-parts-of-a-character-apart', anchorZh: '分辨角色的部位' },
RagdollJoint: { category: 'physics', summary: 'What the author says of one bone of a ragdoll: no body of its own, or limits (and a one-way bend) of its own.', doc: 'gameplay/physics-3d', anchor: 'ragdoll', anchorZh: '布娃娃' },
FirstPersonController: { category: 'physics', summary: 'Looks, walks, jumps and crouches in a CharacterController3D from the keyboard, the pointer and the touch screen, through a camera on a child.', doc: 'gameplay/physics-3d', anchor: 'first-person', anchorZh: '第一人称' },
FirstPersonViewModel: { category: 'physics', summary: 'On the player\'s camera: draws what is held with a second camera over the world\'s, with its own field of view and near plane, so it does not go through walls.', doc: 'gameplay/physics-3d', anchor: 'a-view-model', anchorZh: '视图模型' },
Bone2D: { category: 'animation', summary: 'A bone of a 2D rig: an entity whose Transform is its joint, reaching a length along its own +x.', doc: 'animation/rig-2d' },
IK2D: { category: 'animation', summary: 'Bends the last bones of a limb after the animation has played, so the end of this bone reaches a target.', doc: 'animation/rig-2d' },
BoneConstraint2D: { category: 'animation', summary: "Limits a bone's rotation, or makes it copy another entity's rotation or position, or look at it.", doc: 'animation/rig-2d' },
PathFollower: { category: 'graphics', summary: 'Moves its entity along the Spline of another at a steady speed, once, round or back and forth, turning to face along it if asked.', doc: null },
TerrainBand2D: { category: 'graphics', summary: 'A 2D ground drawn along the Spline of the same entity: a filled body, a lip along the surface with an optional image, and an optional chain collider.', doc: null },
SwingTwistJoint3D: { category: 'physics', summary: 'A ball joint with independent twist limits, an elliptical swing cone and optional angular velocity motors.', doc: 'gameplay/physics-3d', anchor: 'joints', anchorZh: '关节' },
SixDOFJoint3D: { category: 'physics', summary: 'Locks, limits or frees each translation and rotation axis independently, with optional velocity motors.', doc: 'gameplay/physics-3d', anchor: 'joints', anchorZh: '关节' },
PointJoint3D: { category: 'physics', summary: 'Holds two 3D bodies at a shared point, free to turn on all three axes — a chain link, a ragdoll limb.', doc: 'gameplay/physics-3d', anchor: 'joints', anchorZh: '关节' },
HingeJoint3D: { category: 'physics', summary: 'One axis of rotation between two 3D bodies — a door or a driven wheel, with optional limits and a motor.', doc: 'gameplay/physics-3d', anchor: 'joints', anchorZh: '关节' },
SliderJoint3D: { category: 'physics', summary: 'One axis of travel between two 3D bodies — a lift or a piston, with optional limits and a motor.', doc: 'gameplay/physics-3d', anchor: 'joints', anchorZh: '关节' },
DistanceJoint3D: { category: 'physics', summary: 'Keeps two 3D bodies a distance apart: a rope, a rod, or a spring when a frequency is given.', doc: 'gameplay/physics-3d', anchor: 'joints', anchorZh: '关节' },
FixedJoint3D: { category: 'physics', summary: 'Locks two 3D bodies together in the pose they were placed in — no freedom at all.', doc: 'gameplay/physics-3d', anchor: 'joints', anchorZh: '关节' },
CharacterController2D: { category: 'physics', summary: 'Kinematic character movement that slides along walls, climbs slopes and reports ground contact.', doc: 'gameplay/physics', anchor: 'character-controller', anchorZh: '角色控制器' },
PlatformerController2D: { category: 'physics', summary: 'Runs and jumps a CharacterController2D from the keyboard or a game, with coyote time, a jump buffer and dropping through one-way platforms.', doc: 'gameplay/physics', anchor: 'platformer-controller' },
FoliageContact: { category: 'physics', summary: 'Something plants feel: grass parts around it, shrubs lean away, and placed plants near it become entities with colliders.', doc: 'graphics/foliage', anchor: 'touching-plants' },
PlantProxy: { category: 'physics', summary: 'The entity standing in for a placed plant while something is near it, which a ray or a collision finds.', doc: 'graphics/foliage', anchor: 'touching-plants' },
VoxelTerrain: { category: 'world', summary: 'Ground that is a volume, so it can hold caves and overhangs, and be carved while the game runs.', doc: 'world/voxel-terrain' },
RoadDecal: { category: 'world', summary: 'Lays the entity\'s mesh along a Spline and over the ground, its edges fading into what it lies on.', doc: 'graphics/terrain', anchor: 'blending-what-stands-on-the-ground' },
OneWayPlatform2D: { category: 'physics', summary: 'Makes a collider solid from one side only, so a body passes up through it and lands on top.', doc: 'gameplay/physics', anchor: 'one-way-platforms', anchorZh: '单向平台' },
DistanceJoint2D: { category: 'physics', summary: 'Holds two bodies a fixed (or spring-limited) distance apart.', doc: 'gameplay/physics', anchor: 'joints', anchorZh: '关节' },
HingeJoint2D: { category: 'physics', summary: 'Pins two bodies at a point and lets them rotate — a hinge, with optional limits and a motor.', doc: 'gameplay/physics', anchor: 'joints', anchorZh: '关节' },
SliderJoint2D: { category: 'physics', summary: 'Constrains two bodies to slide along one axis — a piston or lift.', doc: 'gameplay/physics', anchor: 'joints', anchorZh: '关节' },
FixedJoint2D: { category: 'physics', summary: 'Locks two bodies rigidly together, with optional spring give.', doc: 'gameplay/physics', anchor: 'joints', anchorZh: '关节' },
MotorJoint2D: { category: 'physics', summary: 'Drives one body toward a target offset and angle — moving platforms and conveyors.', doc: 'gameplay/physics', anchor: 'joints', anchorZh: '关节' },
WheelJoint2D: { category: 'physics', summary: 'A suspension axis plus a spinning axle — the wheel half of a vehicle.', doc: 'gameplay/physics', anchor: 'joints', anchorZh: '关节' },
// ── Animation ──────────────────────────────────────────────────────────────
Animator: { category: 'animation', summary: 'Runs an animator controller — states, transitions and blend trees — over the entity.', doc: 'animation/overview', anchor: 'animator-state-machine', anchorZh: '动画状态机' },
AnimatorRootMotion: { category: 'animation', summary: 'Publishes how far the active animation asks the character to move, for gameplay to hand to a character controller — a request, never a result.', doc: 'animation/overview', anchor: 'root-motion', anchorZh: '根运动' },
GripProfile: { category: 'animation', summary: 'Where on an object each palm sits, and how its fingers are held there.', doc: 'animation/grip-pose', anchor: 'holding-an-object' },
GripSurface: { category: 'animation', summary: 'A cylinder, capsule, sphere or box on a held object that its holder\'s fingers close onto and stop at.', doc: 'animation/grip-pose', anchor: 'closing-onto-the-object' },
GripHolder: { category: 'animation', summary: 'Holds an object in its GripProfile\'s grip: the arms bent to its anchors, the fingers posed, in one order that cannot loop.', doc: 'animation/grip-pose', anchor: 'holding-an-object' },
GripPose: { category: 'animation', summary: 'Holds a rig\'s hands in a named pose, a pistol grip, a handle, a cup, that fits any rig with fingers.', doc: 'animation/grip-pose' },
SpringBone: { category: 'animation', summary: 'Makes every bone below this root a spring: the chain trails the animated pose by inertia, falls with gravity and is pulled back toward it (hair, tails, cords).', doc: 'animation/spring-bones', anchor: 'the-component', anchorZh: '组件' },
SpringBoneCollider: { category: 'animation', summary: 'A sphere or capsule that the spring-bone chains naming it are kept out of.', doc: 'animation/spring-bones', anchor: 'the-component', anchorZh: '组件' },
SpriteAnimator: { category: 'animation', summary: 'Plays a flipbook clip by swapping the sprite frame, with speed, looping and frame events.', doc: 'animation/overview', anchor: 'sprite-animation', anchorZh: '精灵动画' },
TimelinePlayer: { category: 'animation', summary: 'Plays a timeline asset — keyframed tracks across many entities — with wrap modes and playback control.', doc: 'animation/timeline', anchor: 'attach-a-timeline', anchorZh: '附加时间轴' },
SpineAnimation: { category: 'animation', summary: 'A Spine skeleton: its skeleton and atlas assets, current animation, skin and mix settings.', doc: 'animation/spine', anchor: 'the-spineanimation-component', anchorZh: 'spineanimation-组件' },
DragonBonesAnimation: { category: 'animation', summary: 'A DragonBones armature: its skeleton and atlas assets, armature choice and playback state.', doc: 'animation/dragonbones', anchor: 'the-dragonbonesanimation-component', anchorZh: 'dragonbonesanimation-组件' },
// ── World ──────────────────────────────────────────────────────────────────
Tilemap: { category: 'world', summary: 'A Tiled map asset projected into the scene; the engine derives one layer entity per map layer.', doc: 'world/tilemaps', anchor: 'load-a-tiled-map', anchorZh: '加载-tiled-地图' },
TilemapLayer: { category: 'world', summary: 'One layer of tiles — its tileset, cell size, orientation, sorting and collision.', doc: 'world/tilemaps', anchor: 'the-tilemaplayer-component', anchorZh: 'tilemaplayer-组件' },
ParticleModelUnits: { category: 'world', summary: 'Imported particle sizes, speeds and gravity in model units; the particle plugin applies the largest absolute world-scale axis to the emitter.', doc: 'world/particles' },
ParticleEmitter: { category: 'world', summary: 'A particle system: emission, lifetime, shape, forces, noise, colour and size over life, sub-emitters and trails.', doc: 'world/particles', anchor: 'particleemitter-reference', anchorZh: 'particleemitter-字段参考' },
ParticleCollider: { category: 'world', summary: 'A sphere, box or capsule particles bounce off with no physics, for an emitter in Sdf collision mode, on the GPU or the CPU.', doc: 'world/particles', anchor: 'gpu-collision' },
ParticleForceField: { category: 'world', summary: 'A field that pushes particles around — point, directional, vortex or drag.', doc: 'world/particles', anchor: 'force-fields', anchorZh: '力场' },
Marker: { category: 'world', summary: 'A named point or region of gameplay interest — spawn point, waypoint, trigger zone — queryable like any component.', doc: 'gameplay/markers', anchor: 'marker-component-reference', anchorZh: 'marker-组件参考' },
// ── Gameplay ───────────────────────────────────────────────────────────────
NavAgent: { category: 'gameplay', summary: 'Steers an entity along a path found on the navigation grid.', doc: 'gameplay/ai/navigation' },
NavVolume: { category: 'gameplay', summary: 'The box a navigation mesh is baked over, out of the scene\u2019s own collision geometry.', doc: 'gameplay/ai/navigation' },
NavObstacle: { category: 'gameplay', summary: 'A box that blocks without being geometry \u2014 a door, a gate, a placed building.', doc: 'gameplay/ai/navigation' },
NavLink: { category: 'gameplay', summary: 'A way between two places the ground does not join \u2014 a drop, a ladder, a plank.', doc: 'gameplay/ai/navigation' },
NavArea: { category: 'gameplay', summary: 'A box of ground that costs more or less to cross \u2014 mud, water, a road.', doc: 'gameplay/ai/navigation' },
Perceiver: { category: 'gameplay', summary: 'Senses nearby perception targets within a sight cone and range.', doc: 'gameplay/ai/perception' },
Perception: { category: 'gameplay', summary: "What a perceiver currently sees — written each frame for the entity's own logic to read.", doc: 'gameplay/ai/perception' },
PerceptionTarget: { category: 'gameplay', summary: 'Tag: perceivers can see this entity.', doc: 'gameplay/ai/perception' },
StateMachineAgent: { category: 'gameplay', summary: 'Runs a gameplay state machine asset, calling registry actions as states enter, update and exit.', doc: 'gameplay/ai/state-machines' },
BehaviorTreeAgent: { category: 'gameplay', summary: 'Ticks a behavior tree asset against a blackboard, calling registry actions at its leaves.', doc: 'gameplay/ai/behavior-trees' },
ScriptGraphAgent: { category: 'gameplay', summary: 'Runs a script graph asset on this entity — events, an exec wire, and data wires between registered names.', doc: null },
EventBinding: { category: 'gameplay', summary: 'Wires an event on this entity to named actions — gameplay authored in the inspector, with no script.', doc: 'scripting/events', anchor: 'the-data', anchorZh: '数据本身' },
AudioSource: { category: 'gameplay', summary: 'Declarative playback attached to an entity, attenuated by distance when spatial.', doc: 'assets/audio', anchor: 'declarative-playback--audiosource', anchorZh: '声明式播放--audiosource' },
AudioListener: { category: 'gameplay', summary: 'The ear spatial audio is mixed relative to — usually the camera or the player.', doc: 'assets/audio', anchor: 'spatial-audio', anchorZh: '空间音频' },
SoundEventSource: { category: 'gameplay', summary: 'An entity-owned sound event with reproducible variation and shared voice limits.', doc: 'assets/audio', anchor: 'sound-event-source', anchorZh: '音效事件源' },
Replicated: { category: 'gameplay', summary: 'Marks an entity the server replicates to every client.', doc: 'scripting/networking', anchor: 'state-replication--multiplayer-entities', anchorZh: '状态复制多人实体同步' },
NetGhost: { category: 'gameplay', summary: 'Tag: this entity is a client-side proxy of one the server owns.', doc: 'scripting/networking', anchor: 'state-replication--multiplayer-entities', anchorZh: '状态复制多人实体同步' },
};