OverwolfGameEventPackage

Electron APIs / gep / OverwolfGameEventPackage

Game Events Package interface.

Provides methods to query supported games and features, configure the required features for a game, and subscribe to game event and info update streams.

Extends

• EventEmitter

Methods

[captureRejectionSymbol]()?

optional [captureRejectionSymbol]<K>(
   error: Error,
   event: string | symbol, ...
   args: AnyRest): void;

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
error	Error
event	string | symbol
...args	AnyRest

Returns

void

Inherited from

NodeJS.EventEmitter.[captureRejectionSymbol]

---

addListener()

addListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;

Alias for emitter.on(eventName, listener).

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args: any[]) => void

Returns

this

Since

v0.1.26

Inherited from

NodeJS.EventEmitter.addListener;

---

emit()

emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from "node:events";
const myEmitter = new EventEmitter();

// First listener
myEmitter.on("event", function firstListener() {
  console.log("Helloooo! first listener");
});
// Second listener
myEmitter.on("event", function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on("event", function thirdListener(...args) {
  const parameters = args.join(", ");
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners("event"));

myEmitter.emit("event", 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol
...args	AnyRest

Returns

boolean

Since

v0.1.26

Inherited from

NodeJS.EventEmitter.emit;

---

eventNames()

eventNames(): (string | symbol)[];

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from "node:events";

const myEE = new EventEmitter();
myEE.on("foo", () => {});
myEE.on("bar", () => {});

const sym = Symbol("symbol");
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

NodeJS.EventEmitter.eventNames;

---

getFeatures()

getFeatures(gameId: number): Promise<string[]>;

Returns an array of supported Game Event Features for a game.

Parameters

Parameter	Type	Description
gameId	number	Game ID of the targeted game.

Returns

Promise<string[]>

Promise resolving to an array of supported game features.

---

getInfo()

getInfo(gameId: number): Promise<any>;

Returns the target game's current Game Info.

Parameters

Parameter	Type	Description
gameId	number	Game ID of the targeted game.

Returns

Promise<any>

Promise resolving to the targeted game's current Game Info.

---

getMaxListeners()

getMaxListeners(): number;

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

NodeJS.EventEmitter.getMaxListeners;

---

getSupportedGames()

getSupportedGames(): Promise<object[]>;

Returns an array of Game Events supported games.

Returns

Promise<object[]>

Promise resolving to the supported games.

---

listenerCount()

listenerCount<K>(eventName: string | symbol, listener?: Function): number;

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters

Type Parameter
K

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event being listened for
listener?	Function	The event handler function

Returns

number

Since

v3.2.0

Inherited from

NodeJS.EventEmitter.listenerCount;

---

listeners()

listeners<K>(eventName: string | symbol): Function[];

Returns a copy of the array of listeners for the event named eventName.

server.on("connection", (stream) => {
  console.log("someone connected!");
});
console.log(util.inspect(server.listeners("connection")));
// Prints: [ [Function] ]

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol

Returns

Function[]

Since

v0.1.26

Inherited from

NodeJS.EventEmitter.listeners;

---

off()

off<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;

Alias for emitter.removeListener().

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args: any[]) => void

Returns

this

Since

v10.0.0

Inherited from

NodeJS.EventEmitter.off;

---

on("new-info-update")

on(eventName: "new-info-update", listener: (event: Event, gameId: number, data: InfoUpdate) => void): this;

Register listener for Game Info Updates.

Parameters

Parameter	Type	Description
eventName	"new-info-update"	Name of the node event ('new-info-update').
listener	(event: Event, gameId: number, data: InfoUpdate) => void	The listener that will be invoked when this event is fired.

Returns

this

The current instance of the Overwolf Game Events Package.

Overrides

NodeJS.EventEmitter.on;

on("new-game-event")

on(eventName: "new-game-event", listener: (event: Event, gameId: number, data: GameEvent) => void): this;

Register listener for New Game Events.

Parameters

Parameter	Type	Description
eventName	"new-game-event"	Name of the node event ('new-game-event').
listener	(event: Event, gameId: number, data: GameEvent) => void	The listener that will be invoked when this event is fired.

Returns

this

The current instance of the Overwolf Game Events Package.

Overrides

NodeJS.EventEmitter.on;

on("game-detected")

on(eventName: "game-detected", listener: (event: GepGameLaunchEvent, gameId: number, name: string, ...args: any[]) => void): this;

Register listener for a game being detected. Calling event.enable() to start gep for this game.

Parameters

Parameter	Type	Description
eventName	"game-detected"	Name of the node event ('game-detected').
listener	(event: GepGameLaunchEvent, gameId: number, name: string, ...args: any[]) => void	The listener that will be invoked when this event is fired.

Returns

this

The current instance of the Overwolf Game Events Package.

Overrides

NodeJS.EventEmitter.on;

on("game-exit")

on(eventName: "game-exit", listener: (event: Event, gameId: number, gameName: string, pid: number, processName: string, processPath: string, commandLine: string) => void): this;

Register listener for a game exit event.

Parameters

Parameter	Type	Description
eventName	"game-exit"	Name of the node event ('game-exit').
listener	(event: Event, gameId: number, gameName: string, pid: number, processName: string, processPath: string, commandLine: string) => void	The listener that will be invoked when this event is fired.

Returns

this

The current instance of the Overwolf Game Events Package.

Overrides

NodeJS.EventEmitter.on;

on("elevated-privileges-required")

on(eventName: "elevated-privileges-required", listener: (event: Event, gameId: number, name: string, pid: number) => void): this;

Register listener for when a detected game is ran as administrator. If this fires, it means the app must also run as administrator in order for Game Events to be detected.

Parameters

Parameter	Type	Description
eventName	"elevated-privileges-required"	Name of the node event ('elevated-privileges-required').
listener	(event: Event, gameId: number, name: string, pid: number) => void	The listener that will be invoked when this event is fired.

Returns

this

The current instance of the Overwolf Game Events Package.

Overrides

NodeJS.EventEmitter.on;

on("error")

on(eventName: "error", listener: (event: Event, gameId: number, error: string, ...args: any[]) => void): this;

Register listener for errors thrown by the Game Events Provider Package.

Parameters

Parameter	Type	Description
eventName	"error"	Name of the node event ('error' or the errorMonitor symbol).
listener	(event: Event, gameId: number, error: string, ...args: any[]) => void	The listener that will be invoked when this event is fired.

Returns

this

The current instance of the Overwolf Game Events Package.

Overrides

NodeJS.EventEmitter.on;

---

once()

once<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once("connection", (stream) => {
  console.log("Ah, we have our first user!");
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from "node:events";
const myEE = new EventEmitter();
myEE.once("foo", () => console.log("a"));
myEE.prependOnceListener("foo", () => console.log("b"));
myEE.emit("foo");
// Prints:
//   b
//   a

Type Parameters

Type Parameter
K

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args: any[]) => void	The callback function

Returns

this

Since

v0.3.0

Inherited from

NodeJS.EventEmitter.once;

---

prependListener()

prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.prependListener("connection", (stream) => {
  console.log("someone connected!");
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

Type Parameter
K

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args: any[]) => void	The callback function

Returns

this

Since

v6.0.0

Inherited from

NodeJS.EventEmitter.prependListener;

---

prependOnceListener()

prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener("connection", (stream) => {
  console.log("Ah, we have our first user!");
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

Type Parameter
K

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args: any[]) => void	The callback function

Returns

this

Since

v6.0.0

Inherited from

NodeJS.EventEmitter.prependOnceListener;

---

rawListeners()

rawListeners<K>(eventName: string | symbol): Function[];

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from "node:events";
const emitter = new EventEmitter();
emitter.once("log", () => console.log("log once"));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners("log");
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on("log", () => console.log("log persistently"));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners("log");

// Logs "log persistently" twice
newListeners[0]();
emitter.emit("log");

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol

Returns

Function[]

Since

v9.4.0

Inherited from

NodeJS.EventEmitter.rawListeners;

---

removeAllListeners()

removeAllListeners(eventName?: string | symbol): this;

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

Parameter	Type
eventName?	string | symbol

Returns

this

Since

v0.1.26

Inherited from

NodeJS.EventEmitter.removeAllListeners;

---

removeListener()

removeListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;

Removes the specified listener from the listener array for the event named eventName.

const callback = (stream) => {
  console.log("someone connected!");
};
server.on("connection", callback);
// ...
server.removeListener("connection", callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

import { EventEmitter } from "node:events";
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log("A");
  myEmitter.removeListener("event", callbackB);
};

const callbackB = () => {
  console.log("B");
};

myEmitter.on("event", callbackA);

myEmitter.on("event", callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit("event");
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit("event");
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

import { EventEmitter } from "node:events";
const ee = new EventEmitter();

function pong() {
  console.log("pong");
}

ee.on("ping", pong);
ee.once("ping", pong);
ee.removeListener("ping", pong);

ee.emit("ping");
ee.emit("ping");

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args: any[]) => void

Returns

this

Since

v0.1.26

Inherited from

NodeJS.EventEmitter.removeListener;

---

setMaxListeners()

setMaxListeners(n: number): this;

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

Parameter	Type
n	number

Returns

this

Since

v0.3.5

Inherited from

NodeJS.EventEmitter.setMaxListeners;

---

setRequiredFeatures()

setRequiredFeatures(gameId: number, features: string[] | undefined): Promise<void>;

Sets the requires Game Event Features for a given game ID.

Parameters

Parameter	Type	Description
gameId	number	Game ID of the targeted game.
features	string[] | undefined	Array of required Game Event Features.

Returns

Promise<void>

Promise reporting the success of the operation.