Update move phase timing modifier docs

This commit is contained in:
Dean 2025-09-16 10:46:37 -07:00
parent a7a97695f1
commit 34c74289bd

View File

@ -3,16 +3,14 @@ import type { ObjectValues } from "#types/type-helpers";
/**
* Enum representing modifiers for the timing of MovePhases.
*
* {@linkcode MovePhaseTimingModifier.FIRST | FIRST} is used to trigger moves immediately (i.e. ones that were called through Instruct).
*
* {@linkcode MovePhaseTimingModifier.LAST | LAST} is used when moves go last regardless of speed and priority (i.e. Quash).
*
* @remarks
* This system is entirely independent of and takes precedence over move priority
*/
export const MovePhaseTimingModifier = Object.freeze({
/** Used when moves go last regardless of speed and priority (i.e. Quash) */
LAST: 0,
NORMAL: 1,
/** Used to trigger moves immediately (i.e. ones that were called through Instruct). */
FIRST: 2,
});
export type MovePhaseTimingModifier = ObjectValues<typeof MovePhaseTimingModifier>;