Function shouldRollback

src/engine/lifecycle.ts:692–744

(engine: VisualNovelEngine)

 * can't be reverted right now.
 */
export function shouldRollback (engine: VisualNovelEngine): Promise<unknown[]> {
	// Check if the game is visible, if it's not, then it probably is not
	// playing or is looking at some menu and thus the game should not
	// revert. The game will not revert if it's blocked or if the distraction
	// free mode is enabled.
	if (!engine.global ('distraction_free')
		&& !engine.global ('block')
		&& (!engine.global ('_engine_block') || engine.global ('_executing_sub_action'))) {
		const promises = [];

		engine.debug.groupCollapsed ('shouldRollback Check');

		try {
			// Check action by action if they will allow the game to revert
			for (const action of engine.actions ()) {
				promises.push (action.shouldRollback ().then (() => {
					engine.debug.debug (`OK ${action.id}`);
				}).catch ((e) => {
					engine.debug.debug (`FAIL ${action.id}\nReason: ${e}`);
					return Promise.reject (e);
				}));
			}

			// Check component by component if they will allow the game to revert
			for (const component of engine.components ()) {
				promises.push (component.shouldRollback ().then (() => {
					engine.debug.debug (`OK ${component.tag}`);
				}).catch ((e) => {
					engine.debug.debug (`FAIL ${component.tag}\nReason: ${e}`);
					return Promise.reject (e);
				}));
			}
		}  catch (e) {
			console.error (e);

			const errorMessage = e instanceof Error ? e.message : String(e);

			FancyError.show ('engine:lifecycle:should_rollback_error', {
				errorMessage: errorMessage
			});
		}

		return Promise.all (promises).then ((...args) => {
			engine.debug.groupEnd ();
			return Promise.resolve (...args);
		}).catch ((e) => {
			engine.debug.groupEnd ();
			return Promise.reject (e);
		});
	} else {
		return Promise.reject ('Extra condition check failed.');
	}
}

export function willRollback (engine: VisualNovelEngine): Promise<unknown[]> {
	const promises = [];