starblast-modding/src/resources/Events.js

A powerful library for interacting with the Starblast Modding API

'use strict';

let EVENTS = {
	/**
	 * Fires when the game is about to start
	 * @event ModdingClient#start
	 * @param {string} link - The link to the created game
	 * @param {object} options - The current game options from server
	 */
	MOD_STARTED: "start",
	/**
	 * Fires when there is error message from server (and sometimes client, use {@link ModdingClient#error} to do so). <br>It is recommended to add a listener for this event ({@link https://nodejs.org/api/events.html#error-events|reference}), since unexpected error message from the server can also crash your mod.
	 * @event ModdingClient#error
	 * @param {Error} error - The `Error` object
	 */
	ERROR: "error",
	/**
	 * Fires after each evocation of {@link ModdingClient#log}
	 * @event ModdingClient#log
	 * @param {...string} messages - The messages
	 */
	LOG: "log",
	/**
	 * Fires each tick, similar to `this.tick` in browser modding
	 * @event ModdingClient#tick
	 * @param {number} step - Game step
	 */
	TICK: "tick",
	/**
	 * Fires when the mod stops.
	 * @event ModdingClient#stop
	 * @param {ModdingClient} client - The client object bound to this event, with properties and data right before mod is stopped and being renewed
	 */
	MOD_STOPPED: "stop",
	// Ship events
	/**
	 * Fires when a ship respawns
	 * @event ModdingClient#shipRespawn
	 * @param {Ship} ship - The ship object
	 */
	SHIP_RESPAWNED: "shipRespawn",
	/**
	 * Fires when a ship first spawns
	 * @event ModdingClient#shipSpawn
	 * @param {Ship} ship - The ship object
	 */
	SHIP_SPAWNED: "shipSpawn",
	/**
	 * Fires when a ship is destroyed
	 * @event ModdingClient#shipDestroy
	 * @param {Ship} ship - The ship object
	 * @param {Ship} killer - The killer ship object or `null`
	 */
	SHIP_DESTROYED: "shipDestroy",
	/**
	 * Fires when a ship is disconnected
	 * @event ModdingClient#shipDisconnect
	 * @param {Ship} ship - The ship object
	 */
	SHIP_DISCONNECTED: "shipDisconnect",
	/**
	 * Fires when a ship clicks an UIComponent
	 * @event ModdingClient#UIComponentClick
	 * @param {UIComponent} component - The UIComponent being clicked, note that individual components are prioritized first
	 * @param {Ship} ship - The ship object
	 */
	UI_COMPONENT_CLICKED: "UIComponentClick",
	// Alien events
	/**
	 * Fires when an alien is created
	 * @event ModdingClient#alienCreate
	 * @param {Alien} alien - The alien object
	 */
	ALIEN_CREATED: "alienCreate",
	/**
	 * Fires when an alien is destroyed
	 * @event ModdingClient#alienDestroy
	 * @param {Alien} alien - The alien object
	 * @param {Ship} killer - The killer ship object or `null`
	 */
	ALIEN_DESTROYED: "alienDestroy",
	// Asteroid events
	/**
	 * Fires when an asteroid is created
	 * @event ModdingClient#asteroidCreate
	 * @param {Asteroid} asteroid - The asteroid object
	 */
	ASTEROID_CREATED: "asteroidCreate",
	/**
	 * Fires when an asteroid is destroyed
	 * @event ModdingClient#asteroidDestroy
	 * @param {Asteroid} asteroid - The asteroid object
	 * @param {Ship} killer - The killer ship object or `null`
	 */
	ASTEROID_DESTROYED: "asteroidDestroy",
	// Collectible events
	/**
	 * Fires when a collectible is created
	 * @event ModdingClient#collectibleCreate
	 * @param {Collectible} collectible - The collectible object
	 */
	COLLECTIBLE_CREATED: "collectibleCreate",
	/**
	 * Fires when a collectible is picked
	 * @event ModdingClient#collectiblePick
	 * @param {Collectible} collectible - The collectible object
	 * @param {Ship} ship - The ship that picked the collectible
	 */
	COLLECTIBLE_PICKED: "collectiblePick",
	// Station events
	/**
	 * Fires when a station is destroyed
	 * @event ModdingClient#stationDestroy
	 * @param {Station} station - The station object
	 * @since 1.0.3-alpha6
	 */
	STATION_DESTROYED: "stationDestroy",
	// Station module events
	/**
	 * Fires when a station module is destroyed
	 * @event ModdingClient#stationModuleDestroy
	 * @param {StationModule} station_module - The station module object
	 * @since 1.0.3-alpha6
	 */
	STATION_MODULE_DESTROYED: "stationModuleDestroy",
	/**
	 * Fires when a station module is repaired
	 * @event ModdingClient#stationModuleRepair
	 * @param {StationModule} station_module - The station module object
	 * @since 1.0.3-alpha6
	 */
	STATION_MODULE_REPAIRED: "stationModuleRepair"
}

module.exports = Object.freeze(EVENTS)