ax.mapscene¶
Source: gamemode/modules/mapscene/libraries/sv_mapscene.lua
Server-side map scene management.
Documented functions: 13
Functions¶
ax.mapscene:AddScene(scene)ax.mapscene:ExportToJSON()ax.mapscene:GetDataKey()ax.mapscene:GetScope()ax.mapscene:HandlePairCapture(client, scene, bPair)ax.mapscene:ImportFromJSON(json)ax.mapscene:Load()ax.mapscene:RemoveScenesNear(position, radius)ax.mapscene:Save()ax.mapscene:SendPreview(client, identifier)ax.mapscene:SerializeScenes()ax.mapscene:SetupPlayerVisibility(client)ax.mapscene:Sync(target)
ax.mapscene:AddScene(scene)¶
Add a scene to the registry.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
scene |
table |
- |
Returns
boolean,: string|nil
ax.mapscene:ExportToJSON()¶
Export scenes to JSON for sharing.
Realm: server
Returns
string|nil
ax.mapscene:GetDataKey()¶
Build the persistence key for map scenes.
Realm: server
Returns
string
ax.mapscene:GetScope()¶
Get the configured persistence scope.
Realm: server
Returns
string
ax.mapscene:HandlePairCapture(client, scene, bPair)¶
Queue or complete a paired scene capture.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
client |
Player |
- |
scene |
table |
- |
bPair |
boolean |
- |
Returns
boolean,: string|nil
ax.mapscene:ImportFromJSON(json)¶
Import scenes from JSON.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
json |
string |
- |
Returns
boolean,: string|nil
ax.mapscene:Load()¶
Load scenes from disk.
Realm: server
ax.mapscene:RemoveScenesNear(position, radius)¶
Remove scenes near a position.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
position |
Vector |
- |
radius |
number |
- |
Returns
number
ax.mapscene:Save()¶
Save scenes to disk.
Realm: server
ax.mapscene:SendPreview(client, identifier)¶
Send a preview target to a specific client.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
client |
Player |
- |
identifier |
number\|string\|nil |
- |
ax.mapscene:SerializeScenes()¶
Serialize scenes for network sync using sfs + compression.
Realm: server
Returns
string|nil
ax.mapscene:SetupPlayerVisibility(client)¶
Add map scene origin to the PVS.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
client |
Player |
- |
ax.mapscene:Sync(target)¶
Send a scene sync to a player or broadcast.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
target |
Player\|table\|nil |
- |