List of Custom Methods: Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 8:

! 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. 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.

| <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'''. 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.

|-

| <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>PreviousSongVol(float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of the second most recently played song to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''.

|-

| <code>SongVol(string'''filename.ogg*external''', float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of a specific filename to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''. Can target sound effects from [[Play Sound]].

|-

| <code>StopSong(int'''FadeTimeInSeconds''')</code> || Like '''CurrentSongVol''', with no volume control.

|-

| <code>OneSongAtATime(bool'''Enabled''')</code> || Stops the previous song as soon as a new [[Play Song]] event is triggered.

|-

| <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.

|-

| <code>statusSignWidth = float'''Width'''</code> || Sets the status sign's width.

|-

| <code>forceNoFrameOffsets = bool'''Enabled'''</code> || If Showing Frame Offset on Status Sign is enabled, overrides (disables) it to properly display other text. Useful, but be courteous, '''''only''''' use it if '''absolutely necessary'''.

|}

<!-- please add more

Line 83:

Line 101:

| <code>p2Release</code> || P2 Any Key Is Released

|-

| <code>buttonPressCount</code> || Amount of times a button has been pressed<~~super~~>''(Not 2P Compatible?)''</~~super~~>

| <code>buttonPressCount</code> || Amount of times a button has been pressed''(Not 2P Compatible?)''

|}

=== Tags ===

This is a list of special tags that are handled by game input automatically that can be applied to any event. They can't be modified or run with [[Tag Action]].

{| class="wikitable"

|+ Special Tags

|-

! Tag !! Description

|-

| <code>[onHit]</code> || Run when any row is hit, whether correctly, barely, or slightly missed.

|-

| <code>[onMiss]</code> || Run when any row is completely missed (not hit at all).

|-

| <code>[onHeldPressHit]</code> || Run when any hold is hit, whether correctly, barely, or slightly missed.

|-

| <code>[onHeldPressMiss]</code> || Run when any hold is completely missed (not hit at all).

|-

| <code>[onHeldReleaseHit]</code> || Run when any hold is released, whether correctly, barely, or slightly missed.

|-

| <code>[onHeldReleaseMiss]</code> || Run when any hold's release is completely missed (not hit at all).

|-

| <code>[rowX]</code> || Restrict the previous special tags' scope to a specific row. Zero-indexed, where <code>X</code> is the row's ID. Multiple of these can be put to check for more than 1 row.

|}

@@ Line 8: / Line 8: @@
 ! 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 -->
+| <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>PreviousSongVol(float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of the second most recently played song to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''.
+|-
+| <code>SongVol(string'''filename.ogg*external''', float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of a specific filename to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''. Can target sound effects from [[Play Sound]].
+|-
+| <code>StopSong(int'''FadeTimeInSeconds''')</code> || Like '''CurrentSongVol''', with no volume control.
+|-
+| <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.
+|-
+| <code>statusSignWidth = float'''Width'''</code> || Sets the status sign's width.
+|-
+| <code>forceNoFrameOffsets = bool'''Enabled'''</code> || If Showing Frame Offset on Status Sign is enabled, overrides (disables) it to properly display other text. Useful, but be courteous, '''''only''''' use it if '''absolutely necessary'''.
 |}
 <!-- please add more
@@ Line 83: / Line 101: @@
 | <code>p2Release</code> || P2 Any Key Is Released
 |-
-| <code>buttonPressCount</code> || Amount of times a button has been pressed<super>''(Not 2P Compatible?)''</super>
+| <code>buttonPressCount</code> || Amount of times a button has been pressed<sup>''(Not 2P Compatible?)''</sup>
+|}
+=== Tags ===
+This is a list of special tags that are handled by game input automatically that can be applied to any event. They can't be modified or run with [[Tag Action]].
+{| class="wikitable"
+|+ Special Tags
+|-
+! Tag !! Description
+|-
+| <code>[onHit]</code> || Run when any row is hit, whether correctly, barely, or slightly missed.
+|-
+| <code>[onMiss]</code> || Run when any row is completely missed (not hit at all).
+|-
+| <code>[onHeldPressHit]</code> || Run when any hold is hit, whether correctly, barely, or slightly missed.
+|-
+| <code>[onHeldPressMiss]</code> || Run when any hold is completely missed (not hit at all).
+|-
+| <code>[onHeldReleaseHit]</code> || Run when any hold is released, whether correctly, barely, or slightly missed.
+|-
+| <code>[onHeldReleaseMiss]</code> || Run when any hold's release is completely missed (not hit at all).
+|-
+| <code>[rowX]</code> || Restrict the previous special tags' scope to a specific row. Zero-indexed, where <code>X</code> is the row's ID. Multiple of these can be put to check for more than 1 row.
 |}