Codename LogoCodename Logo

funkin.backend.scripting.events.GameOverEvent

APIWiki
View source

final class GameOverEvent

package funkin.backend.scripting.events

extends CancellableEvent

@:directlyUsed@:build(funkin.backend.system.macros.EventMacro.build())@:autoBuild(funkin.backend.system.macros.EventMacro.build())

Constructor

View in GitHub

new()

Variables

character:Character

Character which died. Default to boyfriend.

deathCharID:String

Character ID (name) for game over. Default to whatever is specified in the character's XML.

gameOverSong:String

Song for the game over screen. Default to this.gameOverSong (gameOver)

isPlayer:Bool

If the character has isPlayer

lossSFX:String

SFX at the beginning of the game over (Mic drop). Default to this.lossSFX (gameOverSFX)

retrySFX:String

SFX played whenever the player retries. Defaults to retrySFX (gameOverEnd)

x:Float

The X pos of where the gameover character will be.

y:Float

The Y pos of where the gameover character will be.

Methods

View in GitHub

recycle(x:Float, y:Float, character:Character, deathCharID:String, isPlayer:Bool, gameOverSong:String, lossSFX:String, retrySFX:String):GameOverEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

View in GitHub

destroy():Void

View in GitHub

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

View in GitHub

recycleBase():Void

View in GitHub

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] [CancellableEvent (Cancelled)]

Returns:

String