List of Custom Methods: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
! Custom Method !! Description | ! Custom Method !! Description | ||
|- | |- | ||
| <code>MistakeOrHeal(float'''DamageOrHeal''')</code> || Positive values will do the 'note missed' vignette flash and sound effect, and add specified number of misses to the hit stats, decreasing the rank accordingly.<br>Negative values will do the 'note hit' vignette flash and remove number of misses from the hit stats, improving the rank accordingly. Early & late stats will be unaffected.<br>Has no effect on heart visuals. | | <code>MistakeOrHeal(float'''DamageOrHeal''')</code> || Positive values will do the "''note missed''" vignette flash and sound effect, and add specified number of misses to the hit stats, '''decreasing the rank accordingly'''.<br>Negative values will do the "''note hit''" vignette flash and remove number of misses from the hit stats, '''improving the rank accordingly'''. Early & late stats will be unaffected.<br>Has no effect on heart visuals. | ||
|- <!-- from [[Play Song]] vvv --> | |- <!-- from [[Play Song]] vvv --> | ||
| <code>CurrentSongVol(float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of the most recently played song to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''. | | <code>CurrentSongVol(float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of the most recently played song to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''. | ||
| Line 19: | Line 19: | ||
|- | |- | ||
| <code>OneSongAtATime(bool'''Enabled''')</code> || Stops the previous song as soon as a new [[Play Song]] event is triggered. | | <code>OneSongAtATime(bool'''Enabled''')</code> || Stops the previous song as soon as a new [[Play Song]] event is triggered. | ||
|- <!-- from [[Shake Screen]] vvv --> | |||
| <code>smoothShake = bool'''Enabled'''</code> || Replaces screen shakes with a smooth version. '''Note''': this seems to only work with ''OnPreBar''. This method may make the room display incorrectly when completed. | |||
|- | |||
| <code>rotateShake = bool'''Enabled'''</code> || Replaces screen shakes with a rotation shake. '''Note''': this method may make the room display incorrectly when completed. | |||
|} | |} | ||
<!-- please add more | <!-- please add more | ||
Latest revision as of 09:50, 10 February 2025
This is a list of custom methods and variables that can be used for Call Custom Method and Conditionals.
This list is unfinished, please refer to the Rhythm Doctor Custom Method Sheet for information.
| Custom Method | Description |
|---|---|
MistakeOrHeal(floatDamageOrHeal) |
Positive values will do the "note missed" vignette flash and sound effect, and add specified number of misses to the hit stats, decreasing the rank accordingly. Negative values will do the "note hit" vignette flash and remove number of misses from the hit stats, improving the rank accordingly. Early & late stats will be unaffected. Has no effect on heart visuals. |
CurrentSongVol(floatTargetVolume, floatFadeTimeSeconds) |
Sets the volume of the most recently played song to TargetVolume over the time given in FadeTimeSeconds. |
PreviousSongVol(floatTargetVolume, floatFadeTimeSeconds) |
Sets the volume of the second most recently played song to TargetVolume over the time given in FadeTimeSeconds. |
SongVol(stringfilename.ogg*external, floatTargetVolume, floatFadeTimeSeconds) |
Sets the volume of a specific filename to TargetVolume over the time given in FadeTimeSeconds. Can target sound effects from Play Sound. |
StopSong(intFadeTimeInSeconds) |
Like CurrentSongVol, with no volume control. |
OneSongAtATime(boolEnabled) |
Stops the previous song as soon as a new Play Song event is triggered. |
smoothShake = boolEnabled |
Replaces screen shakes with a smooth version. Note: this seems to only work with OnPreBar. This method may make the room display incorrectly when completed. |
rotateShake = boolEnabled |
Replaces screen shakes with a rotation shake. Note: this method may make the room display incorrectly when completed. |
Variables
This is a list of variables and miscellaneous methods that can be used in Conditionals.
| Variable | Description |
|---|---|
autoplay |
Boolean. Whether Autoplay is on or not. |
atLeastRank(stringRank) |
Method to check for a rank. Can't distinguise plus and minus variants, except for S+. |
atLeastNPerfects(intHitsToCheck, intNumberOfPerfects) |
Checks if NumberOfPerfects of the last HitsToCheck beats have been hit. |
arePlayerInputsSwapped |
Boolean. Whether the player has used "Swap Hands." |
levelSpeed |
Float. Speed of the level. Chilly speed is 0.75, chili speed is 1.5, and default is 1. |
numMistakesnumMistakesP1numMistakesP2 |
Number of mistakes, collectively and per-player. |
platform |
String. Platform used by the computer: Mac or Windows (Linux can be checked if both are false). |
voiceLanguage |
String. Language used by the user: only English and Chinese are supported by this variable, so use the Language Conditional otherwise. |
upPress |
Up Arrow Key Press |
downPress |
Down Arrow Key Press |
leftPress |
Left Arrow Key Press |
rightPress |
Right Arrow Key Press |
upIsPressed |
Up Arrow Key Is Pressed |
downIsPressed |
Down Arrow Key Is Pressed |
leftIsPressed |
Left Arrow Key Is Pressed |
rightIsPressed |
Right Arrow Key Is Pressed |
upReleased |
Up Arrow Key Is Released |
downReleased |
Down Arrow Key Is Released |
leftReleased |
Left Arrow Key Is Released |
rightReleased |
Right Arrow Key Is Released |
anyPlayerPress |
Any Key Press |
anyPlayerRelease |
Any Key Is Released |
p1Press |
P1 Any Key Press |
p2Press |
P2 Any Key Press |
p1IsPressed |
P1 Any Key Is Pressed |
p2IsPressed |
P2 Any Key Is Pressed |
p1Release |
P1 Any Key Is Released |
p2Release |
P2 Any Key Is Released |
buttonPressCount |
Amount of times a button has been pressed(Not 2P Compatible?) |