-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Lua Script API: Variables
Note: Those are the only variables that can be changed by using = true
or = false
for now, you will have to use setProperty() if you want to change the rest of them
-
luaDebugMode
- Enables debug mode, useluaDebugMode = true
to enable it. Default value:false
-
luaDeprecatedWarnings
- Tells you if a function/variable is deprecated (shouldn't be used anymore), only works when Debug mode is on, useluaDeprecatedWarnings = false
to disable it. Default value:true
-
inChartEditor
- Tells you if your script is running on Chart Editor's chart playtest.
-
curBpm
- Current BPM of the Song, shortcut togetPropertyFromClass('Conductor', 'bpm')
-
bpm
- Starting BPM of the Song, shortcut togetProperty('SONG.bpm')
-
scrollSpeed
- Starting Scroll speed of the Song, shortcut togetProperty('SONG.speed')
-
crochet
- Interval between Beat hits -
stepCrochet
- Interval between Step hits -
songLength
- Song duration in milliseconds -
songName
- Shortcut togetProperty('SONG.song')
-
isStoryMode
- Shortcut togetProperty('isStoryMode')
-
difficulty
- Returns the difficulty ID (Easy = 0, Normal = 1, Hard = 2), Shortcut togetProperty('storyDifficulty')
-
weekRaw
- Returns the raw current week number. I doubt you will ever use this, but hey, just in case you do, it's here. -
week
- Returns the properly formatted current week file name.
-
cameraX
- Shortcut togetProperty('camFollowPos.x')
-
cameraY
- Shortcut togetProperty('camFollowPos.y')
-
screenWidth
- Shortcut togetPropertyFromClass('FlxG', width)
-
screenHeight
- Shortcut togetPropertyFromClass('FlxG', heigth)
-
startedCountdown
- Tells you if the countdown already started -
seenCutscene
- Is set totrue
afteronCreate()
function, Shortcut togetProperty('seenCutscene')
-
curBeat
- Current beat number -
curStep
- Current step number -
score
- Current score, Shortcut togetProperty('songScore')
-
misses
- Current total number of notes missed, Shortcut togetProperty('songMisses')
-
ghostMisses
- Current number of Key press misses, Shortcut togetProperty('ghostMisses')
-
hits
- Current number of notes hit, Shortcut togetProperty('songHits')
-
rating
- Current rating percentage, goes from0
to1
. Shortcut togetProperty('ratingPercent')
-
ratingName
- Current rating's name. Shortcut togetProperty('ratingString')
-
inGameOver
- Player is Dead -
mustHitSection
- Tells if the current section is aMust Hit Section
(from Chart Editor) -
altAnim
- Tells if the current section is aAlt Animation
Section (from Chart Editor) -
gfSection
- Tells if the current section is aGF Section
(from Chart Editor) -
botPlay
- Tells if Botplay is enabled. Shortcut togetProperty('cpuControlled')
-
defaultPlayerStrumX0
- Player's default left arrow X -
defaultPlayerStrumY0
- Player's default left arrow Y -
defaultOpponentStrumX0
- Opponent's default left arrow X -
defaultOpponentStrumY0
- Opponent's default left arrow Y -
defaultPlayerStrumX1
- Player's default down arrow X -
defaultPlayerStrumY1
- Player's default down arrow Y -
defaultOpponentStrumX1
- Opponent's default down arrow X -
defaultOpponentStrumY1
- Opponent's default down arrow Y -
defaultPlayerStrumX2
- Player's default up arrow X -
defaultPlayerStrumY2
- Player's default up arrow Y -
defaultOpponentStrumX2
- Opponent's default up arrow X -
defaultOpponentStrumY2
- Opponent's default up arrow Y -
defaultPlayerStrumX3
- Player's default right arrow X -
defaultPlayerStrumY3
- Player's default right arrow Y -
defaultOpponentStrumX3
- Opponent's default right arrow X -
defaultOpponentStrumY3
- Opponent's default right arrow Y
-
defaultBoyfriendX
- Player's Default X position, defined by the Stage's JSON file. -
defaultBoyfriendY
- Player's Default Y position, defined by the Stage's JSON file. -
defaultOpponentX
- Opponent's Default X position, defined by the Stage's JSON file. -
defaultOpponentY
- Opponent's Default Y position, defined by the Stage's JSON file. -
defaultGirlfriendX
- Girlfriend's Default X position, defined by the Stage's JSON file. -
defaultGirlfriendY
- Girlfriend's Default Y position, defined by the Stage's JSON file.
-
downscroll
- Downscroll is enabled. Shortcut togetPropertyFromClass('ClientPrefs', 'downScroll')
-
middlescroll
- Middlescroll is enabled. Shortcut togetPropertyFromClass('ClientPrefs', 'middleScroll')
-
framerate
- Current framerate limit. Shortcut togetPropertyFromClass('ClientPrefs', 'framerate')
-
ghostTapping
- Ghost tapping is enabled. Shortcut togetPropertyFromClass('ClientPrefs', 'ghostTapping')
-
hideHud
- "Hide HUD" is enabled. Shortcut togetPropertyFromClass('ClientPrefs', 'hideHud')
-
hideTime
- "Hide Song Length" is enabled. Shortcut togetPropertyFromClass('ClientPrefs', 'hideTime')
-
cameraZoomOnBeat
- Shortcut togetPropertyFromClass('ClientPrefs', 'camZooms')
-
flashingLights
- Shortcut togetPropertyFromClass('ClientPrefs', 'flashing')
-
noteOffset
- Represents the note delay in milliseconds (Goes from0
to500
). Shortcut togetPropertyFromClass('ClientPrefs', 'noteOffset')
-
lowQuality
- Shortcut togetPropertyFromClass('ClientPrefs', 'lowQuality')