sc_entities_v1.spawn

Catalogue snapshot — development preview

SDK 2.3.0 · game pack 0.6.0 · source e616ed69d8f9f77b0f4827881c86d91e4a7d1689 Published release: sdk-v2.3.0 (immutable approved assets; this development preview is not an approved release). Source-backed inventory is not a runtime or in-game verification claim.

Spawns an entity of entity_class (a class name, as in sc-offline’s npcs.txt or spawn.entities) at pos, facing rot, in zone zone_id’s local frame: anywhere, not only near the player. *out_id = the new entity id, 0 on failure. The id is final at once; the entity streams in a few seconds later. It is yours (see Ownership above). SCO_BAD_ARG: a null or released self, a null class, pos, rot or out_id, zone 0, or a position that isn’t finite or a zero rotation. SCO_NOT_FOUND: the zone isn’t streamed in, or the class doesn’t exist on this game build. SCO_TOO_MANY: SC_ENTITIES_MAX_OWNED are alive. SCO_UNAVAILABLE: no “game.entities.spawn”, or the host couldn’t remove your entities when you unload. SCO_FAILED: the game refused or faulted.

Limitations / unestablished guarantees

• Internal allocation unspecified.
• Recursive reentrancy unspecified except unwatch in callback.
• Additional failures/output state unspecified unless described in the buffer contract.
• Game-service behavior not verified in a game session.

Signature

sco_result (*)(sco_plugin *, const char *, uint64_t, const double *, const double *, uint64_t *)

Service and availability

Service index

Property	Value
Symbol	sc_entities_v1.spawn
Record ID	sc-entities-v1-spawn
Service	game.entities
Table	sc_entities_v1
Version macro	SC_ENTITIES_VERSION_1_1
Packed table version	65537
Since / availability	size >= 48; 1.0
Complete member extent (x64 bytes)	48
Table size (x64 bytes)	96

Header source

Parameters and buffers

sco_result (*spawn)(sco_plugin* self, const char* entity_class, uint64_t zone_id, const double pos[3], const double rot_xyzw[4], uint64_t* out_id);
Spawns an entity of entity_class (a class name, as in sc-offline’s npcs.txt or spawn.entities) at pos, facing rot, in zone zone_id’s local frame: anywhere, not only near the player. *out_id = the new entity id, 0 on failure. The id is final at once; the entity streams in a few seconds later. It is yours (see Ownership above). SCO_BAD_ARG: a null or released self, a null class, pos, rot or out_id, zone 0, or a position that isn’t finite or a zero rotation. SCO_NOT_FOUND: the zone isn’t streamed in, or the class doesn’t exist on this game build. SCO_TOO_MANY: SC_ENTITIES_MAX_OWNED are alive. SCO_UNAVAILABLE: no “game.entities.spawn”, or the host couldn’t remove your entities when you unload. SCO_FAILED: the game refused or faulted.

Results and failures

Absent table: query_service NOT_FOUND; missing operation capability: UNAVAILABLE (alive: 0); invalid/released self: BAD_ARG. Additional failures/output state unspecified unless described in the buffer contract.

Absent capability

Absent table: query_service NOT_FOUND

Ownership

Caller buffers; no allocation crosses boundary. Host owns entity/watch tracking; IDs are session values. Internal allocation unspecified.

Thread affinity

Game thread only (WRONG_THREAD elsewhere, alive returns 0); last_error any thread. Recursive reentrancy unspecified except unwatch in callback.

Callback context

unspecified

Reentrancy

unspecified

Cleanup and cancellation

No in-flight cancellation entrypoint; owned entities removed and watches ended on ordinary unload/non-retained crash cleanup, except kept entities. Retained-provider faults skip owner resource-release hooks and require restart; backing resources remain retained, not safe for cached calls.

Language mappings

Status labels are copied verbatim from the catalogue: direct is native access; typed-wrapper is wrapper-backed; restricted is a subset/adaptation; unsupported means no supported route is established. No status implies universal safety.

Language	Catalogue status	Source evidence / wrapper tokens
c	direct	include/sc_entities.h (*spawn)
cpp	typed-wrapper	include/scosdk/game/entities.hpp return t_ && Covers(t_->size, offsetof(sc_entities_v1, spawn)) && t_->spawn ? t_->spawn(self_, entityClass, zoneId, pos, rot, &id) : SCO_UNAVAILABLE;
csharp	typed-wrapper	sdk/csharp/Sco.Sdk/Game/Entities.cs r = _t->spawn(Self, c, zoneId, p, q, &n);
lua	unsupported	sdk/docs/lua.md Read-only: a Lua plugin owns no entities, so there is no spawn, despawn, move or watch. plugins/lua/sco_lua_game.c { “alive”, L_ent_alive }, { “class_of”, L_ent_class_of }, { “get_transform”, L_ent_get_transform },

Examples

None identified in the catalogue; this is not proof none can exist.

Tests

• tests/abi_game_entities.c
• tests/test_app.cpp
• tests/test_lua.cpp
• tests/test_language_routes.cpp
• sdk/csharp/Sco.Sdk.Tests/GameFakeHost.cs
• tests/test_language_routes.c
• tools/test.sh
• sdk/csharp/Sco.Sdk.Tests/GameLayout.cs

ABI pins prove layout, not semantic behavior or a live game session.