ax.mapscene¶
Source: gamemode/modules/mapscene/libraries/cl_mapscene.lua
Client-side map scene behavior.
Documented functions: 18
Functions¶
ax.mapscene:ApplyView(client, patch)ax.mapscene:BeginScene(scene, index)ax.mapscene:ClearPreview()ax.mapscene:GetMusicDuration(path)ax.mapscene:NormalizeMusicPath(path)ax.mapscene:PickNextScene()ax.mapscene:ResetMusic()ax.mapscene:ResetState()ax.mapscene:ResolveMusicPath(defaultPath)ax.mapscene:SendPVS(origin, bForce)ax.mapscene:SetMusicVolume(volume)ax.mapscene:SetPreview(identifier)ax.mapscene:ShouldPlayMusic(pathOverride)ax.mapscene:ShouldRenderMapScene(client)ax.mapscene:StartMusic(path)ax.mapscene:StopMusic(fadeOut, bForce)ax.mapscene:UpdateMusic()ax.mapscene:UpdateMusicFades()
ax.mapscene:ApplyView(client, patch)¶
Update and return the map scene view override.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
client |
Player |
- |
patch |
table |
- |
Returns
table|nil
ax.mapscene:BeginScene(scene, index)¶
Start transitioning to a scene.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
scene |
table |
- |
index |
number |
- |
ax.mapscene:ClearPreview()¶
Clear preview override.
Realm: client
ax.mapscene:GetMusicDuration(path)¶
Get music duration in seconds.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
path |
any |
- |
Returns
number
ax.mapscene:NormalizeMusicPath(path)¶
Normalize a music path string.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
path |
any |
- |
Returns
string|nil
ax.mapscene:PickNextScene()¶
Choose the next scene based on config.
Realm: client
Returns
table|nil,: number|nil
ax.mapscene:ResetMusic()¶
Reset music state and stop playback.
Realm: client
ax.mapscene:ResetState()¶
Reset scene transition state.
Realm: client
ax.mapscene:ResolveMusicPath(defaultPath)¶
Resolve the active music path (supports overrides).
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
defaultPath |
string |
- |
Returns
string,: boolean, boolean
ax.mapscene:SendPVS(origin, bForce)¶
Send PVS origin to the server (or clear it).
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
origin |
Vector\|nil |
- |
ax.mapscene:SetMusicVolume(volume)¶
Set music volume and cache it.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
volume |
number |
- |
ax.mapscene:SetPreview(identifier)¶
Apply a preview override.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
identifier |
number\|string\|nil |
- |
ax.mapscene:ShouldPlayMusic(pathOverride)¶
Determine if music should currently play.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
pathOverride |
string\|nil |
- |
Returns
boolean
ax.mapscene:ShouldRenderMapScene(client)¶
Determine if map scenes should render.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
client |
Player |
- |
Returns
boolean
ax.mapscene:StartMusic(path)¶
Start map scene music.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
path |
string |
- |
ax.mapscene:StopMusic(fadeOut, bForce)¶
Stop map scene music.
Realm: client
Parameters
| Name | Type | Description |
|---|---|---|
fadeOut |
number |
- |
bForce |
boolean |
- |
ax.mapscene:UpdateMusic()¶
Update music playback state.
Realm: client
ax.mapscene:UpdateMusicFades()¶
Update fade-in/out transitions.
Realm: client