ax.mapscene¶
Source: gamemode/modules/mapscene/libraries/sh_mapscene.lua
Map scene library shared helpers.
Documented functions: 15
Functions¶
ax.mapscene:FindByName(name)ax.mapscene:GetCount()ax.mapscene:GetScenes()ax.mapscene:IsFiniteNumber(value)ax.mapscene:IsPair(scene)ax.mapscene:IsValidAngle(ang)ax.mapscene:IsValidVector(vec)ax.mapscene:NormalizeName(name)ax.mapscene:NormalizeTags(tags)ax.mapscene:OnConfigChanged(key, oldValue, value)ax.mapscene:PackScene(scene)ax.mapscene:ParseTags(tagString)ax.mapscene:ResolveScene(identifier)ax.mapscene:SanitizeScene(scene)ax.mapscene:UnpackScene(data)
ax.mapscene:FindByName(name)¶
Find a scene by name (case-insensitive).
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
- |
Returns
table|nil,: number|nil
ax.mapscene:GetCount()¶
Returns the number of stored scenes.
Realm: shared
Returns
number
ax.mapscene:GetScenes()¶
Returns all stored scenes.
Realm: shared
Returns
table
ax.mapscene:IsFiniteNumber(value)¶
Check if a number is finite and non-NaN.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
value |
any |
- |
Returns
boolean
ax.mapscene:IsPair(scene)¶
Check if a scene entry is a paired scene.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
scene |
table |
- |
Returns
boolean
ax.mapscene:IsValidAngle(ang)¶
Validate an Angle.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
ang |
any |
- |
Returns
boolean
ax.mapscene:IsValidVector(vec)¶
Validate a Vector.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
vec |
any |
- |
Returns
boolean
ax.mapscene:NormalizeName(name)¶
Normalize a name string.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
name |
any |
- |
Returns
string|nil
ax.mapscene:NormalizeTags(tags)¶
Normalize tags to a cleaned list of unique, lowercase strings.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
tags |
table |
- |
Returns
table
ax.mapscene:OnConfigChanged(key, oldValue, value)¶
Handle config changes relevant to map scenes.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
key |
string |
- |
oldValue |
any |
- |
value |
any |
- |
ax.mapscene:PackScene(scene)¶
Pack a scene for JSON export (convert vectors/angles to tables).
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
scene |
table |
- |
Returns
table
ax.mapscene:ParseTags(tagString)¶
Parse a tag list from a string.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
tagString |
string |
- |
Returns
table
ax.mapscene:ResolveScene(identifier)¶
Resolve a scene by index or name.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
identifier |
any |
- |
Returns
table|nil,: number|nil
ax.mapscene:SanitizeScene(scene)¶
Validate and sanitize a scene entry.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
scene |
table |
- |
Returns
table|nil,: string|nil
ax.mapscene:UnpackScene(data)¶
Unpack a scene from JSON export format.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
data |
table |
- |
Returns
table|nil,: string|nil