sc_gamerules_v1.read

Catalogue snapshot — development preview

SDK 2.4.0 · game pack 0.8.0 · source d16f013c629797275e40124184b261da54cce0ef Published release: sdk-v2.4.0-rc.1 (release candidate 1, attested assets; the final signed release follows; this development preview is not an approved release). Source-backed inventory is not a runtime or in-game verification claim.

Copy the client’s current server GameRules parameter snapshot into out (caller sets out->size). Read-only: values are what the server sent and the client applied for the current session; they cannot be written through this ABI. generation changes when a new parameter set is applied.

Limitations / unestablished guarantees

• No backend bound in the default production configuration; nothing has run in game.
• Snapshot freshness follows provider binding; no push notification of parameter changes in 1.0.
• Parameter set covers the quantum-travel gate fields observed in the corpus (F-4.10.196.36804-007/-008); the wider GameRules schema is not exposed in 1.0.
• C++/C#/Lua Read wrappers keep the 1.0 snapshot route; separate 1.1 ListParams/list_params wrappers copy static definitions only. The table has no last_error.

Signature

sco_result (*)(sco_plugin *, sc_gamerules_state *)

Service and availability

Service index

Property	Value
Symbol	sc_gamerules_v1.read
Record ID	sc-gamerules-v1-read
Service	game.gamerules
Table	sc_gamerules_v1
Version macro	SC_GAMERULES_VERSION_1_1
Packed table version	65537
Since / availability	size >= 16; 1.0
Complete member extent (x64 bytes)	16
Table size (x64 bytes)	24

Header source

Parameters and buffers

sco_result (*read)(sco_plugin* self, sc_gamerules_state* out);
Copy the client’s current server GameRules parameter snapshot into out (caller sets out->size). Read-only: values are what the server sent and the client applied for the current session; they cannot be written through this ABI. generation changes when a new parameter set is applied.

Results and failures

OK snapshot copied, UNAVAILABLE service off, no backend bound, out null or out->size too small, BAD_ARG invalid self.

Absent capability

game.gamerules.read defaults false; the table publishes UNAVAILABLE until a host binds a backend grounded on the build’s gamerules.params_sync row.

Ownership

Provider owns the snapshot storage; a plain copy crosses to the caller. No allocation, no engine pointer transfer, nothing retained from out.

Thread affinity

Game thread only.

Callback context

No plugin callback.

Reentrancy

Read-only snapshot copy; no engine re-entry.

Cleanup and cancellation

StopGameRules withdraws the service and clears the bound backend; no engine state to restore (read-only).

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_gamerules.h (*read)
cpp	typed-wrapper	include/scosdk/game/gamerules.hpp return t_->read(self_, &out);
csharp	typed-wrapper	sdk/csharp/Sco.Sdk/Game/GameRules.cs ScoResult r = !Covers(8) || _t->read == null ? ScoResult.Unavailable : _t->read(Self, &s);
lua	typed-wrapper	plugins/lua/sco_lua_game.c const sco_result r = GAME_MEMBER(g, sc_gamerules_v1, read) ? g->read(self, &s) : SCO_UNAVAILABLE;

Examples

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

Tests

• tests/abi_game_gamerules.c
• tests/test_language_routes.cpp
• tests/test_lua.cpp
• tests/test_sdk.cpp
• sdk/csharp/Sco.Sdk.Tests/GameFakeHost.cs

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