Function prepareAction

src/engine/lifecycle.ts:138–179

(engine: VisualNovelEngine, statement: unknown, { cycle, extras }: { cycle: 'Application' | 'Revert'; extras?: Record<string, unknown> })

export function prepareAction(engine: VisualNovelEngine, statement: Record<string, unknown>, { cycle, extras }: { cycle: 'Application' | 'Revert'; extras?: Record<string, unknown> }): ActionInstance | null;
export function prepareAction(engine: VisualNovelEngine, statement: string | Record<string, unknown>, { cycle, extras }: { cycle: 'Application' | 'Revert'; extras?: Record<string, unknown> }): ActionInstance | null;
export function prepareAction (engine: VisualNovelEngine, statement: unknown, { cycle, extras }: { cycle: 'Application' | 'Revert'; extras?: Record<string, unknown> }): ActionInstance | null {
	let action;
	let interpolatedStatement: string[] | undefined;

	// Use the correct matching function (matchString or matchObject)
	// depending on the type of the current statement. If the statement
	// is a pure js function, it won't be reverted since we don't
	// know what to do to revert it.
	if (typeof statement === 'string') {
		interpolatedStatement = engine.replaceVariables (statement).split (' ');

		// Check if it matches using the matchString method
		action = engine.actions ().find (a => a.matchString (interpolatedStatement!));
	} else if (typeof statement === 'object' && statement !== null) {

		// Check if it matches using the matchObject method
		action = engine.actions ().find (a => a.matchObject (statement as Record<string, unknown>));
	}

	if (typeof action !== 'undefined') {
		const act = new action (typeof statement === 'string' ? interpolatedStatement : statement);

		// The original statement is set just in case the action needs
		// access to it. By this point, statement is known to be string | Record<string, unknown>
		// (functions are handled earlier and returned directly).
		act._setStatement (statement as string | Record<string, unknown>);

		// The current cycle is also set just in case the action needs to
		// know what cycle it's currently being performed.
		act._setCycle (cycle);

		// Monogatari is set as the context of the action so that it can
		// access all its functionalities
		act.setContext (engine);

		act.setExtras(extras || {});

		return act;
	}

	return null;
}

// ============================================================================
// Statement Execution