SA:O APINative CULL zones

Enables or disables a custom zone or a vanilla zone claimed by the caller.

Syntax

Copy signature

bool engineSetCullZoneEnabled(int id, bool enabled)

Arguments

idint

Stable zone ID.

enabledbool

Desired state.

Returns

true when ownership and state checks pass; false otherwise.

Ownership and lifecycle

When the owner stops, San Andreas Online deletes its custom zones and restores any vanilla zones it claimed.

Where this comes from

SOURCECLuaEngineDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaEngineDefs.cpp INTRODUCED / EXTENDED89558e874Read the commit and why the change was made RELATED CATEGORY HARNESS cull-zone-test Category-level coverage · test-resources/cull-zone-test

RELATED SA:O APIS

Continue exploring

Read the system guide →

engineGetCullZones Lists adopted vanilla and custom CULL zones, optionally filtered by zone type. engineCreateCullZone Creates a resource-owned native CULL zone and returns its stable ID. engineSetCullZone Replaces an owned or claimed zone definition while retaining its stable ID.

← Previous in categoryengineSetCullZone Next in category →engineRemoveCullZone

← Back to the SA:O Lua API · How Native CULL zones works →