sc_cvars_v1.get_bool
Read one exact allowlisted SQ42 bool; copied 0 or 1, output unchanged on failure.
Signature
Section titled “Signature”sco_result (*)(sco_plugin *, const char *, uint32_t, uint32_t *)Service and availability
Section titled “Service and availability”| Property | Value |
|---|---|
| Symbol | sc_cvars_v1.get_bool |
| Record ID | sc-cvars-v1-get-bool |
| Service | game.cvars |
| Table | sc_cvars_v1 |
| Version macro | SC_CVARS_VERSION |
| Packed table version | 65536 |
| Since / availability | size >= 16; 1.0 |
| Complete member extent (x64 bytes) | 16 |
| Table size (x64 bytes) | 16 |
Parameters and buffers
Section titled “Parameters and buffers”sco_result (*get_bool)(sco_plugin* self, const char* name, uint32_t type, uint32_t* out);
Read one exact allowlisted SQ42 bool; copied 0 or 1, output unchanged on failure.
Results and failures
Section titled “Results and failures”BAD_ARG invalid name/type/output/self or released handle; UNAVAILABLE absent capability/admission/adapter/session; FAILED noncanonical backend bool; CRASHED adapter fault latches restart-required.
Absent capability
Section titled “Absent capability”Table absent: query_service NOT_FOUND; feature unavailable: UNAVAILABLE.
Ownership
Section titled “Ownership”Live caller handle; copied output; host session-lifetime borrowed table; no allocation transfer.
Thread affinity
Section titled “Thread affinity”Game thread only; WRONG_THREAD elsewhere; non-reentrant (FAILED).
Callback context
Section titled “Callback context”Host-only verified offline engine port; no plugin callbacks.
Reentrancy
Section titled “Reentrancy”Refused with FAILED.
Cleanup and cancellation
Section titled “Cleanup and cancellation”No mutation in this table. Stop withdraws discovery and refuses cached calls; fault retains adapter context and prevents restart.
Language mappings
Section titled “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_cvars.h(*get_bool) |
| cpp | typed-wrapper | include/scosdk/game/cvars.hpptable_->get_bool(self_, name, SC_CVAR_BOOL, &out) |
| csharp | unsupported | docs/game/cvars.mdC# and Lua routes are |
| lua | unsupported | docs/game/cvars.mdexplicitly unsupported |
Examples
Section titled “Examples”None identified in the catalogue; this is not proof none can exist.
- tests/abi_game_cvars.c
- tests/test_cvars.cpp
- tests/test_cvars_extent.cpp
- tests/fixtures/cvars_probe.c
ABI pins prove layout, not semantic behavior or a live game session.