Song
| Kind | class |
| Package | data |
| Full name | data.Song |
| Source | source/data/Song.hx |
Public fields
| Name | Type | Static | Default | Notes |
|---|---|---|---|---|
song | String | no | — | — |
notes | Array<SwagSection> | no | — | — |
events | Array<Dynamic> | no | — | — |
bpm | Float | no | — | — |
needsVoices | Bool | no | true | — |
arrowSkin | String | no | — | — |
splashSkin | String | no | — | — |
gameOverChar | String | no | — | — |
gameOverSound | String | no | — | — |
gameOverLoop | String | no | — | — |
gameOverEnd | String | no | — | — |
disableNoteRGB | Bool | no | false | — |
speed | Float | no | 1 | — |
stage | String | no | — | — |
player1 | String | no | 'bf' | — |
player2 | String | no | 'dad' | — |
gfVersion | String | no | 'gf' | — |
psychV1Chart | Bool | yes | false | — |
loadedSongName | String | yes | — | #if MODS_ALLOWED |
Public methods
hasDifficulty
static function hasDifficulty(songName:String, difficulty:String):Bool
| Parameter | Type | Default |
|---|---|---|
songName | String | — |
difficulty | String | — |
loadFromJson
static function loadFromJson(jsonInput:String, ?folder:String):SwagSong
Only compiled when #if MODS_ALLOWED.
| Parameter | Type | Default |
|---|---|---|
jsonInput | String | — |
folder (optional) | String | — |
dummySong
static function dummySong(songName:String = 'test'):SwagSong
Only compiled when #if MODS_ALLOWED.
Empty but fully valid song used when a chart file cannot be found. Keeps direct PlayState entry, the anti-cheat song swap and chart-less debug paths working in content-stripped (NO_BUILTIN_CONTENT) builds.
| Parameter | Type | Default |
|---|---|---|
songName (optional) | String | 'test' |
parseJSON
static function parseJSON(rawJson:String):Dynamic
Only compiled when #if MODS_ALLOWED.
| Parameter | Type | Default |
|---|---|---|
rawJson | String | — |
Internals
Private / internal members
| Method |
|---|
static function onLoadJson(songJson:Dynamic) |