API - MrVauxs/foundry-summons-2 GitHub Wiki

API

interface SummonParams {
	crosshairParameters?: Parameters<typeof Sequencer.Crosshair.show>[0];
	crosshairCallbacks?: Parameters<typeof Sequencer.Crosshair.show>[1];
	updateData?: object;
}

type PredicateParams = { uuid: string } | { actor: ActorPF2e };

interface Window {
	foundrySummons: {
		SummonMenu: typeof SummonMenu; // ApplicationV2 & start(options: summonOptions)
		pick: (params: SummonParams & PredicateParams) => Promise<TokenDocumentPF2e>;
		systemConstants: Record<
			string, 
			{
				indexedFields?: string[];
				filter?: (a: CompendiumIndexData) => boolean;
				sort?: (a: CompendiumIndexData, b: CompendiumIndexData, input: any) => number;
			}
		>;
                // The following values are live, meaning they instantly update with the settings without the need for a getter.
		settings: {
			permission: number;
			seeActors: boolean;
		};
	};
}

• SummonMenu is an AppV2 class which you can render whether through usual new SummonMenu({ summonOptions: {...options} }).render() method or by its static initializer, SummonMenu.start(options).
• pick is a function which takes in an uuid or actor document, and optionally actor update data, Sequencer crosshair parameters, and callbacks.

SummonMenu Options

Up to date type definitions (such as filters, packs, and other options) can be found here.