Wave

This function is called when the wave is initialised. Waves are initialised before they are due to start, so do not use this function to set up wave logic i.e. timers, bullets, objects, only use it for arena setup and setting fields such as time.
See Wave:onStart() for a suitable alternative.

(Override) Called when the wave is about to be ended
If this function returns true, the wave will not end

(Override) Whether the wave is able to be ended

Removes all objects spawned by this wave

Retrieves all the attackers that selected this wave

(Override) Called when the arena is created for the wave, before Wave:onStart() has been called or the transition is completed.
If this function returns true, the wave will start immediately, without waiting for the arena transition

(Override) Called when the arena finishes transitioning out after the wave

(Override) Called at the end of the wave

@param death — Whether the wave is ending because the player is about to gameover

(Override) Called at the start of the wave, when Wave:update() starts being called.

Sets the initial position of the arena, relative to its default starting position

Sets the initial position of the arena, relative to the topleft of the screen

Sets the rotation of the arena

Sets the initial shape of the arena

@param ... — A list of {x, y} vertices that form the shape of the arena.

Sets the initial size of the rectangular arena (Defaults to 142 by 142 pixels)

Sets the offset of the soul from its default starting position.

Sets the soul's starting position, relative to the topleft of the screen.

Spawns a new bullet to this wave and parents it to Game.battle.

@param bullet — As a string, this parameter is either a sprite path, which will create a basic bullet with that sprite, or the id of a custom bullet. As a Bullet, it will directly spawn that instance to the wave.

@param ... — Additional arguments to be passed to the created bullet's init() function. Basic bullets take an x and y coordinate here.

@return bullet — The newly added bullet instance.

Spawns a bullet and parents it to the parent object.

@param parent — The object to parent the bullet to. If left as nil, will parent it to Game.battle.

@param bullet — As a string, this parameter is either a sprite path, which will create a basic bullet with that sprite, or the id of a custom bullet. As a Bullet, it will directly spawn that instance to the wave.

@param ... — Additional arguments to be passed to the created bullet's init() function. Basic bullets take an x and y coordinate here.

@return bullet — The newly added bullet instance.

Spawns an object and parents it to Game.battle

Spawns an object and parents it to the parent object

Spawns the soul to the wave.

Spawns a sprite and parents it to Game.battle

Spawns a sprite and parents it to the parent object

(Override) Called every frame after Wave:onStart() has run

Wave arena rectangular height

Wave arena rotation

Wave arena shape (overrides rectangle options)

Wave arena rectangular width

Wave arena x-coordinate

Wave arena y-coordinate

Whether the wave is finished or not

Whether the wave should spawn the arena

x-offset of the soul position at the start of the wave

y-offset of the soul position at the start of the wave

x-coordinate the soul will transition to at the start of the wave

y-coordinate the soul will transition to at the start of the wave

The number of seconds the wave will last, or -1 for an infinite wave (Defaults to 5 seconds)

Whether the wave should spawn the soul If this is false, the soul can be manually spawned with Wave:spawnSoul()

Prevents weird shit from going down if this is called in the init function hopefully