PlayState Functions

General functions related to the Game State, Song and Cutscenes.

---

startCountdown

Usage: startCountdown()

Starts the countdown, should be used after finishing your Pre-Song Cutscene.

---

endSong

Usage: endSong()

Ends the song, can be cancelled through the Lua/HScript callback "onEndSong" to make cutscenes.

---

getSongPosition

Usage: getSongPosition()

Returns the current song position, in milliseconds.

---

restartSong

restartSong(?skipTransition:Bool = false):Void

Restarts the Song, pretty self explanatory.

• skipTransition (Optional) - Skips fade in/out transition, defaults to false.

---

exitSong

exitSong(?skipTransition:Bool = false):Void

Quits the Song and goes back to Freeplay/Story Mode based on where you started.

• skipTransition (Optional) - Skips fade in/out transition, defaults to false.

---

loadSong

loadSong(?name:String = null, ?difficultyNum:Int = -1):Void

Loads the chart for a song.

• name (Optional) - Song Name (ex. "Bopeebo", "Lit Up").
• difficultyNum (Optional) - Week's Difficulty Number (0 = Easy, 1 = Normal, 2 = Hard), use -1 to keep it the same as current.

---

triggerEvent

triggerEvent(name:String, ?value1:String = '', ?value2:String = ''):Bool

Calls an event and uses two arguments for it, exactly like the Chart Editor does.
Should always return "true".

• name - Event Name.
• value1 (Optional) - Does the same as what the Event says in the Chart Editor.
• value2 (Optional) - Does the same as what the Event says in the Chart Editor.

Examples:

• triggerEvent('Hey!', 'BF', 0.6) - Calls "Hey!" event.

---

setHealthBarColors

setHealthBarColors(left:String, right:String):Void

Changes Health Bar colors.

• left - Color hexadecimal string or color name for the left side of the bar.
• right - Color hexadecimal string or color name for the right side of the bar.

Examples:

• setHealthBarColors('FF0000', '00FF00') - Makes left side red and right side lime.
• setHealthBarColors('red', 'lime') - Same as above, but using color names.

---

setTimeBarColors

setTimeBarColors(left:String, right:String):Void

Changes Time Bar colors.

• left - Color hexadecimal string or color name for the left side of the bar.
• right - Color hexadecimal string or color name for the right side of the bar.

Examples:

• setTimeBarColors('FF0000', '00FF00') - Makes left side red and right side lime.
• setTimeBarColors('red', 'lime') - Same as above, but using color names.

---

startDialogue

startDialogue(dialogueFile:String, ?music:String):Void

Loads a Dialogue .JSON inside the Chart folder, handles translation loading automatically.

• dialogueFile - Dialogue file .JSON name.
• music (Optional) - Plays a background music inside "music/" folder.

Examples:

• startDialogue('dialogue') - Loads "dialogue.json" inside the chart folder, will prefer "dialogue_pt-BR.json" if you're playing on Portuguese (Brazil).
• startDialogue('dialogue', 'breakfast') - Same as above, but plays "Breakfast" as background music.

---

startVideo

startVideo(videoFile:String, ?canSkip:Bool = true, ?forMidSong:Bool = false, ?shouldLoop:Bool = false, ?playOnLoad:Bool = true):Void

Plays a Video Cutscene.

• videoFile - Video .MP4 file located inside "videos/" folder, don't include the extension!
• canSkip (Optional) - Allows the video to be skipped by holding down Enter for a second. Defaults to true.
• forMidSong (Optional) - Doesn't start/finish song after the video ends, needed for mid-song cutscenes. Defaults to false.
• shouldLoop (Optional) - Video will repeat once finished. Defaults to false.
• playOnLoad (Optional) - Videos plays instantly after loading. Defaults to true.

Examples:

• startVideo('test_video') - Plays the video mods/My-Mod/videos/test_video.mp4.

setCameraScroll

setCameraScroll(x:Float, y:Float):Void

Set the Game Camera's current scroll position.

Examples:

• setCameraScroll(0.0, 0.0) - Camera Scroll position is set to X: 0 and Y: 0.

---

setCameraFollowPoint

setCameraFollowPoint(x:Float, y:Float):Void

Set the Game Camera's follow point position.

Examples:

• setCameraFollowPoint(-150.0, 150.0) - Camera Follow point is set to 150 units to the left and 150 units down.

---

addCameraScroll

addCameraScroll(?x:Float = 0, ?y:Float = 0):Void

Adds X/Y to the Game Camera's current scroll position.
All values are optional and defaults to zero.

Examples:

• addCameraScroll(200.0, -100.0) - Camera Scroll moves 200 units to the right and 100 units up.

---

addCameraFollowPoint

addCameraFollowPoint(?x:Float = 0, ?y:Float = 0):Void

Adds X/Y to the Game Camera's follow point position.
All values are optional and defaults to zero.

Examples:

• addCameraFollowPoint(-600.0, -200.0) - Camera Follow point moves 600 units to the left and 200 units up.

---

getCameraScrollX

Usage: getCameraScrollX()

Returns Game Camera's current scroll X, float value.

---

getCameraScrollY

Usage: getCameraScrollY()

Returns Game Camera's current scroll Y, float value.

---

getCameraFollowX

Usage: getCameraFollowX()

Returns Game Camera's follow point X, float value.

---

getCameraFollowY

Usage: getCameraFollowY()

Returns Game Camera's follow point Y, float value.

---

cameraSetTarget

cameraSetTarget(character:String):Void

Changes the Follow Point to target a character.

• character - Can be "bf", "gf", or "dad" ("opponent" alternatively).

Examples:

• cameraSetTarget('opponent') - Sets camera follow point to Opponent.