Custom NoteKind

[Amazonsphinx]

I'm trying to make a basic custom notekind with a unique note texture that drains your health when you hit it, just as a little test, but I am unsure how the Notekind works. I can't seem to figure out how to find it on the Notekind drop down in the chart editor, and when I try to use the custom part of the dropdown, I still get nothing.

[AbnormalPoof]

Example pulled from #2635:

import funkin.play.notes.notekind.NoteKind;

class Mine extends NoteKind {
  function new() {
    var name:String = 'mine';
    var title:String = 'Mine';
    var noteStyleId:String = 'pixel';
    var params = [
      {
        name: 'mineDamage',
        title: 'Dealt Damage',
        type: 'float',
        min: 0.0,
        max: 2.0,
        step: 0.1,
        precision: 1,
        defaultValue: 2.0
      }
    ];

    super(name, title, noteStyleId, params);
  }

  override function onNoteMiss(event:NoteScriptEvent) {
    event.healthChange = -event.note.getParam('mineDamage');
  }

  override function onUpdate(event:UpdateScriptEvent) {
    for (note in this.getNotes()) {
      note.hsvShader.hue += event.elapsed;
    }
  }
}

[Amazonsphinx]

Is there a certain spot I should place this code? the only one that kinda works is in the stage script but the game crashes when I click on the notekind

[Starexify]

Please use the ScriptedNoteKind class

Also the data params should look like:

var params = {
    name: 'mineDamage',
    title: 'Dealt Damage',
    type: 'float',
    data: {
        min: 0.0,
        max: 2.0,
        step: 0.1,
        precision: 1,
        defaultValue: 2.0
    }
};

[Lasercar]

Is there a certain spot I should place this code? the only one that kinda works is in the stage script but the game crashes when I click on the notekind

It's way better and easier to use scripts to achieve this.

use my no animation note kind here as an example how to setup the script class:

https://github.com/FunkinCrew/funkin.assets/pull/140/files

You can use 2hot's song script as an example of how to do it all by script rather than code as well, it's just a matter of accessing PlayState.instance.health and subtracting the amount you wish to deal to the player when this note is hit. It starts as a float of 1 and can go to 2, so a subtraction of 0.5 will deal about one quarter of the player's health, if they're at full health.

Here, I'll even give you the code for it if you're having trouble:

import funkin.play.PlayState;

class mineDamageNote extends ScriptedNoteKind {
    function new() {
        super("mineDamage" , "Hurt Note idk", "CustomNoteKindId");
    }

    override function onNoteHit(event:HitNoteScriptEvent):Void {
		PlayState.instance.health -= 0.5; // This will remove 1/4 of the player's health if they're at the max of 2.
        super.onNoteHit(event);
    }

Place this in a file named mineDamageNote.hxc into scripts/notekinds/

set CustomNoteKindId to your custom note kind that styles this hurt note how you want.

Hopefully that helps!