Tighten up type for traits in action object (foundryvtt#13043)

roxim5 · Jan 15, 2024 · da98028 · da98028
1 parent 677e187
commit da98028
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/src/module/actor/actions/base.ts b/src/module/actor/actions/base.ts
@@ -9,6 +9,7 @@ import {
  ActionVariant,
  ActionVariantUseOptions,
 } from "./types.ts";
+import type { ActionTrait } from "@item/ability/index.ts";
 import type { ProficiencyRank } from "@item/base/data/index.ts";
 import { PROFICIENCY_RANKS } from "@module/data.ts";
 
@@ -17,7 +18,7 @@ interface BaseActionVariantData {
  description?: string;
  name?: string;
  slug?: string;
- traits?: string[];
+ traits?: ActionTrait[];
 }
 
 interface BaseActionData<ActionVariantDataType extends BaseActionVariantData = BaseActionVariantData> {
@@ -28,7 +29,7 @@ interface BaseActionData<ActionVariantDataType extends BaseActionVariantData = B
  sampleTasks?: Partial<Record<ProficiencyRank, string>>;
  section?: ActionSection;
  slug?: string | null;
- traits?: string[];
+ traits?: ActionTrait[];
  variants?: ActionVariantDataType | ActionVariantDataType[];
 }
 
@@ -48,7 +49,7 @@ abstract class BaseActionVariant implements ActionVariant {
  readonly #description?: string;
  readonly name?: string;
  readonly #slug?: string;
- readonly #traits?: string[];
+ readonly #traits?: ActionTrait[];
 
  protected constructor(action: BaseAction<BaseActionVariantData, BaseActionVariant>, data?: BaseActionVariantData) {
  this.#action = action;
@@ -77,7 +78,7 @@ abstract class BaseActionVariant implements ActionVariant {
  return this.#slug || sluggify(this.name ?? "") || this.#action.slug;
  }
 
- get traits(): string[] {
+ get traits(): ActionTrait[] {
  return this.#traits ?? this.#action.traits;
  }
 
@@ -119,7 +120,7 @@ abstract class BaseAction<TData extends BaseActionVariantData, TAction extends B
  readonly sampleTasks?: Partial<Record<ProficiencyRank, string>>;
  readonly section?: ActionSection;
  readonly slug: string;
- readonly traits: string[];
+ readonly traits: ActionTrait[];
  readonly #variants: TAction[];
 
  protected constructor(data: BaseActionData<TData>) {

diff --git a/src/module/actor/actions/types.ts b/src/module/actor/actions/types.ts
@@ -1,5 +1,6 @@
 import type { ActorPF2e } from "@actor";
 import type { ChatMessagePF2e } from "@module/chat-message/document.ts";
+import type { ActionTrait } from "@item/ability/index.ts";
 import { ProficiencyRank } from "@item/base/data/index.ts";
 
 const ACTION_COSTS = ["free", "reaction", 1, 2, 3] as const;
@@ -17,7 +18,7 @@ interface ActionMessageOptions {
 interface ActionVariantUseOptions extends Record<string, unknown> {
  actors: ActorPF2e | ActorPF2e[];
  event: Event;
- traits: string[];
+ traits: ActionTrait[];
 }
 
 interface ActionVariant {
@@ -26,7 +27,7 @@ interface ActionVariant {
  glyph?: string;
  name?: string;
  slug: string;
- traits: string[];
+ traits: ActionTrait[];
  toMessage(options?: Partial<ActionMessageOptions>): Promise<ChatMessagePF2e | undefined>;
  use(options?: Partial<ActionVariantUseOptions>): Promise<unknown>;
 }
@@ -44,7 +45,7 @@ interface Action {
  sampleTasks?: Partial<Record<ProficiencyRank, string>>;
  section?: ActionSection;
  slug: string;
- traits: string[];
+ traits: ActionTrait[];
  variants: Collection<ActionVariant>;
  toMessage(options?: Partial<ActionMessageOptions>): Promise<ChatMessagePF2e | undefined>;
  /** Uses the default variant for this action, which will usually be the first one in the collection. */