BuiltinBridge
此内容尚不支持你的语言。
Defined in: ecs/BuiltinBridge.ts:312
Accessors
Section titled “Accessors”hasCpp
Section titled “hasCpp”Get Signature
Section titled “Get Signature”get hasCpp():
boolean
Defined in: ecs/BuiltinBridge.ts:377
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”connect()
Section titled “connect()”connect(
cppRegistry,module?,options?):void
Defined in: ecs/BuiltinBridge.ts:332
Bind to a C++ Registry.
Production call sites should pass { strict: true } so the bridge
verifies that every component declared in COMPONENT_META has its four
bindings (add/get/has/remove) and throws a single aggregated diagnostic
if any are missing. This surfaces drift between the WASM build and the
generated metadata at startup rather than on first component use.
In non-strict mode (default, used by unit tests with partial mock
registries) the cache is pre-populated for whatever bindings exist and
individual getBuiltinMethods() calls throw lazily on missing ones.
Parameters
Section titled “Parameters”cppRegistry
Section titled “cppRegistry”module?
Section titled “module?”options?
Section titled “options?”BridgeConnectOptions = {}
Returns
Section titled “Returns”void
deleteFromEntitySets()
Section titled “deleteFromEntitySets()”deleteFromEntitySets(
entity):string[]
Defined in: ecs/BuiltinBridge.ts:535
Removes the entity from every builtin set; returns the cppNames it was in.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”string[]
disconnect()
Section titled “disconnect()”disconnect():
void
Defined in: ecs/BuiltinBridge.ts:369
Returns
Section titled “Returns”void
get<
T>(entity,component):T
Defined in: ecs/BuiltinBridge.ts:585
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”entity
Section titled “entity”number
component
Section titled “component”Returns
Section titled “Returns”T
getBuiltinMethods()
Section titled “getBuiltinMethods()”getBuiltinMethods(
cppName):BuiltinMethods
Defined in: ecs/BuiltinBridge.ts:466
Parameters
Section titled “Parameters”cppName
Section titled “cppName”string
Returns
Section titled “Returns”BuiltinMethods
getCppRegistry()
Section titled “getCppRegistry()”getCppRegistry():
CppRegistry|null
Defined in: ecs/BuiltinBridge.ts:381
Returns
Section titled “Returns”CppRegistry | null
getEntitySet()
Section titled “getEntitySet()”getEntitySet(
cppName):Set<number> |undefined
Defined in: ecs/BuiltinBridge.ts:521
Parameters
Section titled “Parameters”cppName
Section titled “cppName”string
Returns
Section titled “Returns”Set<number> | undefined
getMethodCache()
Section titled “getMethodCache()”getMethodCache():
Map<string,BuiltinMethods>
Defined in: ecs/BuiltinBridge.ts:517
Returns
Section titled “Returns”Map<string, BuiltinMethods>
getOrCreateEntitySet()
Section titled “getOrCreateEntitySet()”getOrCreateEntitySet(
cppName):Set<number>
Defined in: ecs/BuiltinBridge.ts:525
Parameters
Section titled “Parameters”cppName
Section titled “cppName”string
Returns
Section titled “Returns”Set<number>
getWasmModule()
Section titled “getWasmModule()”getWasmModule():
ESEngineModule|null
Defined in: ecs/BuiltinBridge.ts:385
Returns
Section titled “Returns”ESEngineModule | null
has(
entity,component):boolean
Defined in: ecs/BuiltinBridge.ts:601
Parameters
Section titled “Parameters”entity
Section titled “entity”number
component
Section titled “component”BuiltinComponentDef<any>
Returns
Section titled “Returns”boolean
insert()
Section titled “insert()”insert<
T>(entity,component,data?):object
Defined in: ecs/BuiltinBridge.ts:543
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”entity
Section titled “entity”number
component
Section titled “component”Partial<T>
Returns
Section titled “Returns”object
isNew:
boolean
merged
Section titled “merged”merged:
T
remove()
Section titled “remove()”remove(
entity,component):void
Defined in: ecs/BuiltinBridge.ts:613
Parameters
Section titled “Parameters”entity
Section titled “entity”number
component
Section titled “component”BuiltinComponentDef<any>
Returns
Section titled “Returns”void
resolvePtrFn()
Section titled “resolvePtrFn()”resolvePtrFn(
cppName): ((entity) =>number) |null
Defined in: ecs/BuiltinBridge.ts:631
The wasm-exported pointer function for cppName — (entity) => byte offset of that entity's component in the wasm heap. Web/emscripten only (there is
no such numeric address on native); the fast path itself goes through the
MemoryProvider, so this is a lower-level convenience.
Parameters
Section titled “Parameters”cppName
Section titled “cppName”string
Returns
Section titled “Returns”((entity) => number) | null
resolvePtrGetter()
Section titled “resolvePtrGetter()”resolvePtrGetter(
cppName): ((entity) =>unknown) |null
Defined in: ecs/BuiltinBridge.ts:651
Returns a getter that reads C++ component data into a shared preallocated object. WARNING: The returned object is reused across calls — copy it if you need to retain the values.
Parameters
Section titled “Parameters”cppName
Section titled “cppName”string
Returns
Section titled “Returns”((entity) => unknown) | null
resolvePtrSetter()
Section titled “resolvePtrSetter()”resolvePtrSetter(
cppName): ((entity,data) =>void) |null
Defined in: ecs/BuiltinBridge.ts:635
Parameters
Section titled “Parameters”cppName
Section titled “cppName”string
Returns
Section titled “Returns”((entity, data) => void) | null
verify()
Section titled “verify()”verify():
BridgeVerification
Defined in: ecs/BuiltinBridge.ts:393
Describe the current binding state without throwing. Useful for diagnostics and tests that want to inspect coverage.
Returns
Section titled “Returns”BridgeVerification