Class default

The Matter.Events module contains methods to fire and listen to events on other objects.

See the included usage examples.

Hierarchy

default

Index

Constructors

constructor

Methods

off on trigger

Constructors

constructor

new default(): default
Returns default

Methods

`Static` off

off(body, eventName, callback?): void
Removes the given event callback. If no callback, clears all callbacks in eventNames. If no eventNames, clears all events.
Parameters
- body: IBody
- eventName: BodyEventName | BodyEventFunction
- Optional callback: BodyEventFunction
Returns void

Method
off
- Defined in src/core/Events.ts:174
off(composite, eventName, callback?): void
Parameters
- composite: IComposite
- eventName: CompositeEventFunction | CompositeEventName
- Optional callback: CompositeEventFunction
Returns void
- Defined in src/core/Events.ts:179
off(engine, eventName, callback?): void
Parameters
- engine: IEngine
- eventName: EngineEventName | EngineEventFunction
- Optional callback: EngineEventFunction
Returns void
- Defined in src/core/Events.ts:184
off(mouse, eventName, callback?): void
Parameters
- mouse: IMouseConstraint
- eventName: MouseEventName | MouseEventFunction
- Optional callback: MouseEventFunction
Returns void
- Defined in src/core/Events.ts:189
off(runner, eventName, callback?): void
Parameters
- runner: IRunner
- eventName: RunnerEventName | RunnerEventFunction
- Optional callback: RunnerEventFunction
Returns void
- Defined in src/core/Events.ts:194
off(runner, eventName, callback?): void
Parameters
- runner: IRender
- eventName: RenderEventName | RenderEventFunction
- Optional callback: RenderEventFunction
Returns void
- Defined in src/core/Events.ts:199
off<T, F>(object, eventNames?, callback?): void
Type Parameters
- T extends {
  events: Record<string, F[]>;
  }
- F extends EventFunction<T>
Parameters
- object: T
- Optional eventNames: string | F
- Optional callback: F
Returns void
- Defined in src/core/Events.ts:204

`Static` on

on(body, eventName, callback): BodyEventFunction
Subscribes a callback function to the given object's eventName.
Parameters
- body: IBody
- eventName: BodyEventName
- callback: BodyEventFunction
Returns BodyEventFunction

Method
on
- Defined in src/core/Events.ts:118
on(composite, eventName, callback): CompositeEventFunction
Parameters
- composite: IComposite
- eventName: CompositeEventName
- callback: CompositeEventFunction
Returns CompositeEventFunction
- Defined in src/core/Events.ts:123
on(engine, eventName, callback): EngineEventFunction
Parameters
- engine: IEngine
- eventName: EngineEventName
- callback: EngineEventFunction
Returns EngineEventFunction
- Defined in src/core/Events.ts:128
on(mouse, eventName, callback): MouseEventFunction
Parameters
- mouse: IMouseConstraint
- eventName: MouseEventName
- callback: MouseEventFunction
Returns MouseEventFunction
- Defined in src/core/Events.ts:133
on(runner, eventName, callback): RunnerEventFunction
Parameters
- runner: IRunner
- eventName: RunnerEventName
- callback: RunnerEventFunction
Returns RunnerEventFunction
- Defined in src/core/Events.ts:138
on(runner, eventName, callback): RenderEventFunction
Parameters
- runner: IRender
- eventName: RenderEventName
- callback: RenderEventFunction
Returns RenderEventFunction
- Defined in src/core/Events.ts:143
on<F, T>(object, eventNames, callback): F
Type Parameters
- F extends Function
- T extends {
  events: Record<string, F[]>;
  }
Parameters
- object: T
- eventNames: string
- callback: F
Returns F
- Defined in src/core/Events.ts:148

`Static` trigger

trigger(body, eventName, event?): void
Fires all the callbacks subscribed to the given object's eventName, in the order they subscribed, if any.
Parameters
- body: IBody
- eventName: BodyEventName
- Optional event: Partial<IBodyEvent>
Returns void

Method
trigger
- Defined in src/core/Events.ts:249
trigger(composite, eventName, event): void
Parameters
- composite: IComposite
- eventName: CompositeEventName
- event: Partial<ICompositeEvent>
Returns void
- Defined in src/core/Events.ts:254
trigger(mouse, eventName, event): void
Parameters
- mouse: IMouseConstraint
- eventName: MouseEventName
- event: Partial<IMouseEvent>
Returns void
- Defined in src/core/Events.ts:259
trigger(engine, eventName, event): void
Parameters
- engine: IEngine
- eventName: EngineEventName
- event: Partial<IEngineEvent>
Returns void
- Defined in src/core/Events.ts:264
trigger(runner, eventName, event): void
Parameters
- runner: IRunner
- eventName: RunnerEventName
- event: Partial<IRunnerEvent>
Returns void
- Defined in src/core/Events.ts:269
trigger(runner, eventName, event): void
Parameters
- runner: IRender
- eventName: RenderEventName
- event: Partial<IRenderEvent>
Returns void
- Defined in src/core/Events.ts:274
trigger<T, E>(object, eventNames, event?): void
Type Parameters
- T extends {
  events: Record<string, Function[]>;
  }
- E extends IEvent<string, T>
Parameters
- object: T
- eventNames: string
- Optional event: Partial<E>
Returns void
- Defined in src/core/Events.ts:279

Class default

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static off

Parameters

body: IBody

eventName: BodyEventName | BodyEventFunction

Optional callback: BodyEventFunction

Returns void

Method

Parameters

composite: IComposite

eventName: CompositeEventFunction | CompositeEventName

Optional callback: CompositeEventFunction

Returns void

Parameters

engine: IEngine

eventName: EngineEventName | EngineEventFunction

Optional callback: EngineEventFunction

Returns void

Parameters

mouse: IMouseConstraint

eventName: MouseEventName | MouseEventFunction

Optional callback: MouseEventFunction

Returns void

Parameters

runner: IRunner

eventName: RunnerEventName | RunnerEventFunction

Optional callback: RunnerEventFunction

Returns void

Parameters

runner: IRender

eventName: RenderEventName | RenderEventFunction

Optional callback: RenderEventFunction

Returns void

Type Parameters

T extends { events: Record<string, F[]>; }

F extends EventFunction<T>

Parameters

object: T

Optional eventNames: string | F

Optional callback: F

Returns void

Static on

Parameters

body: IBody

eventName: BodyEventName

callback: BodyEventFunction

Returns BodyEventFunction

Method

Parameters

composite: IComposite

eventName: CompositeEventName

callback: CompositeEventFunction

Returns CompositeEventFunction

Parameters

engine: IEngine

eventName: EngineEventName

callback: EngineEventFunction

Returns EngineEventFunction

Parameters

mouse: IMouseConstraint

eventName: MouseEventName

callback: MouseEventFunction

Returns MouseEventFunction

Parameters

runner: IRunner

eventName: RunnerEventName

callback: RunnerEventFunction

Returns RunnerEventFunction

Parameters

runner: IRender

eventName: RenderEventName

callback: RenderEventFunction

`Static` off

`Optional` callback: BodyEventFunction

`Optional` callback: CompositeEventFunction

`Optional` callback: EngineEventFunction

`Optional` callback: MouseEventFunction

`Optional` callback: RunnerEventFunction

`Optional` callback: RenderEventFunction

T extends {
events: Record<string, F[]>;
}

`Optional` eventNames: string | F

`Optional` callback: F

`Static` on

T extends {
events: Record<string, F[]>;
}

`Static` trigger

`Optional` event: Partial<IBodyEvent>

T extends {
events: Record<string, Function[]>;
}

`Optional` event: Partial<E>