懶得查api自己復制來的 Character Functions characterDance(character:String) Makes character do the idle dance. character - The character type to be used; Can be either: boyfriend, dad or gf. setCharacterX(type:String, value:Float) Sets the current x position value of a character to a new value. This will also move all precached characters from the same type into the position you want. type - The character type to be used; Can be either: boyfriend, dad or gf. value - The new x value of the character position. setCharacterY(type:String, value:Float) Sets the current y position value of a character to a new value. This will also move all precached characters from the same type into the position you want. type - The character type to be used; Can be either: boyfriend, dad or gf. value - The new y value of the character position. getCharacterX(type:String) Gets the current x position value of a character; Returns an int number. type - The character type to be used; Can be either: boyfriend, dad or gf. getCharacterY(type:String) Gets the current y position value of a character; Returns an int number. type - The character type to be used; Can be either: boyfriend, dad or gf. Accuracy Bar Functions addScore(value:Int = 0) Adds the value parameter to the current song score total and recalculates the rating. addMisses(value:Int = 0) Adds the value parameter to the current song miss total and recalculates the rating. addHits(value:Int = 0) Adds the value parameter to the current song hit total and recalculates the rating. addHealth(value:Float = 0) Adds the value parameter to the current song health total and recalculates the rating. setScore(value:Int = 0) Sets the value parameter of the current song score total with a new value and recalculates the rating. setMisses(value:Int = 0) Sets the value parameter of the current song miss total with a new value and recalculates the rating. setHits(value:Int = 0) Sets the value parameter of the current song hit total with a new value and recalculates the rating. setHealth(value:Int = 0) Sets the value parameter of the current song health total with a new value and recalculates the rating. setRatingPercent(value:Float) Sets the current rating percent to a new value, in case you want to do your own rating calculation. value - The new accuracy rating percent, Goes from 0 to 1. setRatingName(value:String) Sets the current rating name to a new value, in case you want to do your own rating calculation. value - The new rating string name. setRatingFC(value:String) Sets the current rating combo name to a new value. value - The new rating combo name. getScore() Gets the current songs score total current value; Returns an int number. getMisses() Gets the current songs miss total current value; Returns an int number. getHits() Gets the current songs hit total current value; Returns an int number. getHealth() Gets the current songs health total current value; Returns an float number. Camera Functions cameraSetTarget(target:String) Makes the camera focus on the target. target - The character type to target; Can be either: boyfriend or dad. cameraShake(camera:String, intensity:Float, duration:Float) Makes the camera shake. camera - The camera state to be set in; Can be either: camGame, camHUD or camOther. intensity - How much intensity will the camera shake, recommended value is 0.05. duration - The duration length of the camera shake to end. cameraFlash(camera:String, color:String, duration:Float, forced:Bool) Makes the camera flash. camera - The camera state to be set in; Can be either: camGame, camHUD or camOther. color - The hex color of the flash. duration - The duration length of the camera flash to end. forced - If set to true, then the flash will be reset. cameraFade(camera:String, color:String, duration:Float, forced:Bool) Makes the camera fade. camera - The camera state to be set in; Can be either: camGame, camHUD or camOther. color - The hex color of the fade. duration - The duration length of the camera fade to end. forced - If set to true, then the fade will be reset. Dialogues/Cutscene Functions startDialogue(dialogueFile:String, song:String = null) Starts the dialogue stuff, it will load the json file relative to data/your-song-name/ folder. When the dialogue is finished, startCountdown() function will be called. If the dialogue line has finished, onNextDialogue() callback will be called. If it skips then onSkipDialogue() callback will be called. dialogueFile - The name of the dialogue json file. song - An optional parameter, The ogg music file to be played; Must be relative to mods/music or assets/music folders. startVideo(videoFile:String) Starts the video during a cutscene. videoFile - The name of the video mp4 file; Must be relative to mods/videos folder. startCountdown() Starts the countdown, used it if you want to skip the annoying dialogue or video manually. Song Functions loadSong(name:String, difficultyNum:Int) Loads a new song. Warning: You can't load a song if the week json has different difficulties. name - The name of the song to be loaded. difficultyNum - The difficulty ID number of the song. restartSong(skipTransition:Bool) Restarts the song. skipTransition - Whether there will be a transition when the song is reseting. exitSong(skipTransition:Bool) Exits the song with an optional transition; Not to be confised with endSong() function. skipTransition - Whether there will be a transition when the song has exiting. endSong() Ends the song manually. Debuging Functions debugPrint(text1, ?text2, ?text3, ?text4, ?text5) This will display a debug message in the top-left corner of the screen. texts - Every parameter of debugPrint(), all of them are optional except the text1 parameter. Example: debugPrint("Current boyfriend character: ", getProperty('boyfriend.curCharacter') This will get the current bf character with the getProperty() function and will print Current boyfriend character: 'bf'. close() Stops your script in the next 100 milliseconds. Recommended to place it at the stage script since it's not being used anymore. Color Functions getColorFromHex(color:String) Gets the specific hex color to use. Very useful expecially when setting/getting a specific hex color, really useful to be honest. color - The specified hex color duh. setHealthBarColors(leftHex:String, ?rightHex:String) Changes the health bar background-colors. leftHex - The opponent hex color of the health bar. rightHex - An optional parameter, The player hex color of the health bar. setTimeBarColors(leftHex:String, ?rightHex:String) Changes the time bar background-colors. leftHex - The percentage bar hex color of the time bar. rightHex - An optional parameter, The background-color hex color of the time bar. getPixelColor(obj:String, x:Int, y:Int) Gets the hex color of an object by pixels; Returns a jamble of random numbers, I dunno whats the value its returning. Maybe RGBA value? I dunno, you should probably not use this. obj - The object tag name to be used. x - The x-coordinate value in pixels. y - The y-coordinate value in pixels. Custom Substate Functions openCustomSubstate(name:String, pauseGame:Bool = false) Opens your custom substate. name - The name of your custom substate to be referenced. pauseGame - An optional parameter, will pause your game after the custom substate has been opened; Defualt value: false. insertToCustomSubstate(tag:String, ?pos:Int = -1) Inserts a Lua object to your custom substate, i think. tag - The object tag name to be referenced. pos - An optional parameter, The index array position; Defualt value: -1. closeCustomSubstate() Closes your custom substate. Miscellaneous Functions triggerEvent(name:String, arg1:String, arg2:String) Triggers an event without having to insert the event into the chart editor. name - The name of the event in the Chart editor. arg1 - The value on Value 1. arg2 - The value on Value 2. changePresence(details:String, state:Null, ?smallImageKey:String, ?hasStartTimestamp:Bool, ?endTimestamp:Float) Changes your Discord RPC status. Warning: This function is currently being research on the parameters. details - Your details on what your doing inside the game. state - The description of the details. smallImageKey - An optional parameter, The image key to be shown at the bottom-left corner. hasStartTimestamp - An optional parameter, Whether your Discord RPC should have a time stamp or not. endTimestamp - An optional parameter, How many decimal numbers to be shown. getSongPosition() Returns the current song position in milliseconds; Shortcut to getPropertyClass('Conductor', 'songPosition').