Interface InterceptorContext<Args, Params>

What an interceptor sees and can change while the hooked call is running.

interface InterceptorContext<
    Args extends Record<string, unknown> = Record<string, unknown>,
    Params extends
        Record<string, number | string | boolean> = Record<string, number>,
> {
    args: Args;
    params: Readonly<Params>;
    cancel(returnValue?: unknown): void;
}

Type Parameters

Args extends Record<string, unknown> = Record<string, unknown>
Arguments of the hooked call.
Params extends Record<string, number | string | boolean> = Record<string, number>
Values pushed ahead of time by a Tier 2 mod.

Index

Properties

Methods

Properties

args

args: Args

Arguments of the hooked call. Writes are validated against the game's types.

`Readonly`params

params: Readonly<Params>

Parameters pushed ahead of time from a Tier 2 mod with interceptor.

Methods

cancel

cancel(returnValue?: unknown): void
Skips the original call.
Parameters
- OptionalreturnValue: unknown
  What the game receives instead of the original result.
Returns void
- Defined in interceptor.ts:30