CodenameEngine/pages/funkin/backend/scripting/events/NoteMissEvent.html

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../../../jquery-1.9.1.min.js"></script><script src="../../../../bootstrap/js/bootstrap.min.js"></script><script src="../../../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../../../styles.css" rel="stylesheet"/><link href="../../../../extra-styles.css" rel="stylesheet"/><link href="../../../../haxe-nav.css" rel="stylesheet"/><link href="../../../../dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "../../../../",platforms: ["doc"]};</script><script src="../../../../nav.js"></script><script src="../../../../index.js"></script><link rel="icon" href="../../../../favicon.ico" type="image/x-icon"/><title>funkin.backend.scripting.events.NoteMissEvent</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
	display: inline-block;
	float: none;
	text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>final class</small> NoteMissEvent</h1><h4><small>package <a href="../../../../funkin/backend/scripting/events/index.html">funkin.backend.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.backend.scripting.events.CancellableEvent" href="../../../../funkin/backend/scripting/events/CancellableEvent.html">CancellableEvent</a></small></h4>    <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(funkin.backend.system.macros.EventMacro.build())</span><span class="label label-meta label-meta-autoBuild" title="Extends `@:build` metadata to all extending and implementing classes.">@:autoBuild(funkin.backend.system.macros.EventMacro.build())</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.ClassExtendMacro.build())</span></div><div class="body"><div class="doc doc-main"><p></p></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><a href="#new"><span class="identifier">new</span></a>()</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="accuracy"></a><h3 class="anchor"><code><a href="#accuracy"><span class="identifier">accuracy</span></a>:<span class="type">Null</span>&lt;<span class="type">Float</span>&gt;</code></h3><div class="doc"><p>Accuracy gained from pressing this note. From 0 to 1. null means no accuracy is gained.</p></div></div><div class="field "><a name="animSuffix"></a><h3 class="anchor"><code><a href="#animSuffix"><span class="identifier">animSuffix</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>Suffix of the animation. "miss" for miss notes, "-alt" for alt notes, "" for normal ones.</p></div></div><div class="field "><a name="character"></a><h3 class="anchor"><code><a href="#character"><span class="identifier">character</span></a>:<a class="type" title="funkin.game.Character" href="../../../../funkin/game/Character.html">Character</a></code></h3><div class="doc"><p>Character that pressed the note.</p></div></div><div class="field "><a name="characters"></a><h3 class="anchor"><code><a href="#characters"><span class="identifier">characters</span></a>:<span class="type">Array</span>&lt;<a class="type" title="funkin.game.Character" href="../../../../funkin/game/Character.html">Character</a>&gt;</code></h3><div class="doc"><p>Characters that pressed the note.</p></div></div><div class="field "><a name="direction"></a><h3 class="anchor"><code><a href="#direction"><span class="identifier">direction</span></a>:<span class="type">Int</span></code></h3><div class="doc"><p>Direction of the press (0 = Left, 1 = Down, 2 = Up, 3 = Right)</p></div></div><div class="field "><a name="forceAnim"></a><h3 class="anchor"><code><a href="#forceAnim"><span class="identifier">forceAnim</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p>Whenever the animation should be forced to play.</p></div></div><div class="field "><a name="forceGfAnim"></a><h3 class="anchor"><code><a href="#forceGfAnim"><span class="identifier">forceGfAnim</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="gfSad"></a><h3 class="anchor"><code><a href="#gfSad"><span class="identifier">gfSad</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="gfSadAnim"></a><h3 class="anchor"><code><a href="#gfSadAnim"><span class="identifier">gfSadAnim</span></a>:<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="ghostMiss"></a><h3 class="anchor"><code><a href="#ghostMiss"><span class="identifier">ghostMiss</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="healthGain"></a><h3 class="anchor"><code><a href="#healthGain"><span class="identifier">healthGain</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>The amount of health that'll be gained from missing that note. If called from <code>onPlayerMiss</code>, the value will be negative.</p></div></div><div class="field "><a name="missSound"></a><h3 class="anchor"><code><a href="#missSound"><span class="identifier">missSound</span></a>:<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="missVolume"></a><h3 class="anchor"><code><a href="#missVolume"><span class="identifier">missVolume</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="misses"></a><h3 class="anchor"><code><a href="#misses"><span class="identifier">misses</span></a>:<span class="type">Int</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="muteVocals"></a><h3 class="anchor"><code><a href="#muteVocals"><span class="identifier">muteVocals</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="note"></a><h3 class="anchor"><code><a href="#note"><span class="identifier">note</span></a>:<a class="type" title="funkin.game.Note" href="../../../../funkin/game/Note.html">Note</a></code></h3><div class="doc"><p>Note that has been missed</p></div></div><div class="field "><a name="noteType"></a><h3 class="anchor"><code><a href="#noteType"><span class="identifier">noteType</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>Note Type name (null if default note)</p></div></div><div class="field "><a name="playerID"></a><h3 class="anchor"><code><a href="#playerID"><span class="identifier">playerID</span></a>:<span class="type">Int</span></code></h3><div class="doc"><p>Whenever the Character is a player</p></div></div><div class="field "><a name="score"></a><h3 class="anchor"><code><a href="#score"><span class="identifier">score</span></a>:<span class="type">Int</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="preventAnim"></a><h3 class="anchor"><code><a href="#preventAnim"><span class="identifier">preventAnim</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>Prevents the default sing animation from being played.</p></div></div><div class="field "><a name="preventDeletion"></a><h3 class="anchor"><code><a href="#preventDeletion"><span class="identifier">preventDeletion</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>Prevents the note from being deleted.</p></div></div><div class="field "><a name="preventMissSound"></a><h3 class="anchor"><code><a href="#preventMissSound"><span class="identifier">preventMissSound</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>Prevents the miss sound from played.</p></div></div><div class="field "><a name="preventResetCombo"></a><h3 class="anchor"><code><a href="#preventResetCombo"><span class="identifier">preventResetCombo</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>Prevents the combo from being reset.</p></div></div><div class="field "><a name="preventStunned"></a><h3 class="anchor"><code><a href="#preventStunned"><span class="identifier">preventStunned</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>Prevents the default sing animation from being played.</p></div></div><div class="field "><a name="preventVocalsMute"></a><h3 class="anchor"><code><a href="#preventVocalsMute"><span class="identifier">preventVocalsMute</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>Prevents the vocals volume from being muted in case its a parameter of <code>onPlayerMiss</code></p></div></div><div class="field "><a name="preventVocalsUnmute"></a><h3 class="anchor"><code><a href="#preventVocalsUnmute"><span class="identifier">preventVocalsUnmute</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>Prevents the vocals volume from being set to 1 after pressing the note.</p></div></div><div class="field "><a name="recycle"></a><h3 class="anchor"><code><a href="#recycle"><span class="identifier">recycle</span></a>(<span style="white-space:nowrap">note:<a class="type" title="funkin.game.Note" href="../../../../funkin/game/Note.html">Note</a>,</span> <span style="white-space:nowrap">score:<span class="type">Int</span>,</span> <span style="white-space:nowrap">misses:<span class="type">Int</span>,</span> <span style="white-space:nowrap">muteVocals:<span class="type">Bool</span>,</span> <span style="white-space:nowrap">healthGain:<span class="type">Float</span>,</span> <span style="white-space:nowrap">missSound:<span class="type">String</span>,</span> <span style="white-space:nowrap">missVolume:<span class="type">Float</span>,</span> <span style="white-space:nowrap">ghostMiss:<span class="type">Bool</span>,</span> <span style="white-space:nowrap">gfSad:<span class="type">Bool</span>,</span> <span style="white-space:nowrap">gfSadAnim:<span class="type">String</span>,</span> <span style="white-space:nowrap">forceGfAnim:<span class="type">Bool</span>,</span> <span style="white-space:nowrap">forceAnim:<span class="type">Bool</span>,</span> <span style="white-space:nowrap">animSuffix:<span class="type">String</span>,</span> <span style="white-space:nowrap">characters:<span class="type">Array</span>&lt;<a class="type" title="funkin.game.Character" href="../../../../funkin/game/Character.html">Character</a>&gt;,</span> <span style="white-space:nowrap">playerID:<span class="type">Int</span>,</span> <span style="white-space:nowrap">noteType:<span class="type">String</span>,</span> <span style="white-space:nowrap">direction:<span class="type">Int</span>,</span> <span style="white-space:nowrap">accuracy:<span class="type">Null</span>&lt;<span class="type">Float</span>&gt;</span>):<a class="type" title="funkin.backend.scripting.events.NoteMissEvent" href="../../../../funkin/backend/scripting/events/NoteMissEvent.html">NoteMissEvent</a></code></h3><div class="doc"><p></p></div></div></div>  <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.backend.scripting.events.CancellableEvent" href="../../../../funkin/backend/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ })</span><a href="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</p></div></div></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.backend.scripting.events.CancellableEvent" href="../../../../funkin/backend/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="destroy"></a><h3 class="anchor"><code><a href="#destroy"><span class="identifier">destroy</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="preventDefault"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occurring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="recycleBase"></a><h3 class="anchor"><code><a href="#recycleBase"><span class="identifier">recycleBase</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
<code>[<a href="../../../../funkin/backend/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
<code>[<a href="../../../../funkin/backend/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></div></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2023 &nbsp;</p></div></div></footer><script src="../../../..//highlighter.js"></script><link href="../../../../highlighter.css" rel="stylesheet"/></body></html>