@vttforge/types / FoundryConstants

Interface: FoundryConstants

The CONST global.

The enumerations a package reads. Each is an object frozen by Foundry, so the values are read-only. The index signature carries the rest.

Indexable

[key: string]: unknown

Properties

ACTIVE_EFFECT_CHANGE_PHASES

readonly ACTIVE_EFFECT_CHANGE_PHASES: readonly ["initial", "final"]

An array, not a record. Core runs initial then final.

---

ACTIVE_EFFECT_CHANGE_TYPES

readonly ACTIVE_EFFECT_CHANGE_TYPES: Readonly<{ add: number; custom: number; downgrade: number; multiply: number; override: number; subtract: number; upgrade: number; }>

Change type to its default priority: custom 0, add 20, override 50.

---

ACTIVE_EFFECT_DURATION_UNITS

readonly ACTIVE_EFFECT_DURATION_UNITS: readonly string[]

---

ACTIVE_EFFECT_EXPIRY_EVENTS

readonly ACTIVE_EFFECT_EXPIRY_EVENTS: readonly ["combatStart", "roundStart", "turnStart", "combatEnd", "roundEnd", "turnEnd"]

---

ACTIVE_EFFECT_SHOW_ICON

readonly ACTIVE_EFFECT_SHOW_ICON: Readonly<{ ALWAYS: number; CONDITIONAL: number; NEVER: number; }>

---

ALL_DOCUMENT_TYPES

readonly ALL_DOCUMENT_TYPES: readonly string[]

---

AUDIO_FILE_EXTENSIONS

readonly AUDIO_FILE_EXTENSIONS: Readonly<Record<string, string>>

---

CHAT_MESSAGE_STYLES

readonly CHAT_MESSAGE_STYLES: Readonly<{ EMOTE: number; IC: number; OOC: number; OTHER: number; }>

---

COMPENDIUM_DOCUMENT_TYPES

readonly COMPENDIUM_DOCUMENT_TYPES: readonly string[]

---

CSS_THEMES

readonly CSS_THEMES: Readonly<Record<string, string>>

---

DOCUMENT_META_OWNERSHIP_LEVELS

readonly DOCUMENT_META_OWNERSHIP_LEVELS: Readonly<Record<string, number>>

---

DOCUMENT_OWNERSHIP_LEVELS

readonly DOCUMENT_OWNERSHIP_LEVELS: Readonly<{ INHERIT: number; LIMITED: number; NONE: number; OBSERVER: number; OWNER: number; }>

---

EDGE_DIRECTIONS

readonly EDGE_DIRECTIONS: Readonly<Record<string, number>>

---

EDGE_SENSE_TYPES

readonly EDGE_SENSE_TYPES: Readonly<Record<string, number>>

Replaces WALL_SENSE_TYPES, which warns since v14 and goes in v16.

---

EMBEDDED_DOCUMENT_TYPES

readonly EMBEDDED_DOCUMENT_TYPES: readonly string[]

---

FOLDER_DOCUMENT_TYPES

readonly FOLDER_DOCUMENT_TYPES: readonly string[]

---

GAME_VIEWS

readonly GAME_VIEWS: readonly string[]

---

GRID_DIAGONALS

readonly GRID_DIAGONALS: Readonly<Record<string, number>>

---

GRID_SNAPPING_MODES

readonly GRID_SNAPPING_MODES: Readonly<Record<string, number>>

---

GRID_TYPES

readonly GRID_TYPES: Readonly<{ GRIDLESS: number; HEXEVENQ: number; HEXEVENR: number; HEXODDQ: number; HEXODDR: number; SQUARE: number; }>

---

IMAGE_FILE_EXTENSIONS

readonly IMAGE_FILE_EXTENSIONS: Readonly<Record<string, string>>

---

JOURNAL_ENTRY_PAGE_FORMATS

readonly JOURNAL_ENTRY_PAGE_FORMATS: Readonly<{ HTML: number; MARKDOWN: number; }>

---

MACRO_SCOPES

readonly MACRO_SCOPES: readonly string[]

---

MACRO_TYPES

readonly MACRO_TYPES: Readonly<{ CHAT: string; SCRIPT: string; }>

---

PACKAGE_TYPES

readonly PACKAGE_TYPES: readonly string[]

---

PRIMARY_DOCUMENT_TYPES

readonly PRIMARY_DOCUMENT_TYPES: readonly string[]

---

REGION_EVENTS

readonly REGION_EVENTS: Readonly<Record<string, string>>

---

REGION_VISIBILITY

readonly REGION_VISIBILITY: Readonly<{ ALWAYS: number; GAMEMASTER: number; LAYER: number; LAYER_UNLOCKED: number; OBSERVER: number; }>

---

SETTING_SCOPES

readonly SETTING_SCOPES: Readonly<{ CLIENT: string; USER: string; WORLD: string; }>

---

TABLE_RESULT_TYPES

readonly TABLE_RESULT_TYPES: Readonly<Record<string, string>>

---

TEXT_ANCHOR_POINTS

readonly TEXT_ANCHOR_POINTS: Readonly<Record<string, number>>

---

TOKEN_DISPLAY_MODES

readonly TOKEN_DISPLAY_MODES: Readonly<{ ALWAYS: number; CONTROL: number; HOVER: number; NONE: number; OWNER: number; OWNER_HOVER: number; }>

---

TOKEN_DISPOSITIONS

readonly TOKEN_DISPOSITIONS: Readonly<{ FRIENDLY: number; HOSTILE: number; NEUTRAL: number; SECRET: number; }>

---

TOKEN_SHAPES

readonly TOKEN_SHAPES: Readonly<Record<string, number>>

---

USER_PERMISSIONS

readonly USER_PERMISSIONS: Readonly<Record<string, Record<string, unknown>>>

---

USER_ROLE_NAMES

readonly USER_ROLE_NAMES: Readonly<Record<number, string>>

---

USER_ROLES

readonly USER_ROLES: Readonly<{ ASSISTANT: number; GAMEMASTER: number; NONE: number; PLAYER: number; TRUSTED: number; }>

---

VIDEO_FILE_EXTENSIONS

readonly VIDEO_FILE_EXTENSIONS: Readonly<Record<string, string>>

---

vtt

readonly vtt: string

---

VTT

readonly VTT: string

---

WALL_RESTRICTION_TYPES

readonly WALL_RESTRICTION_TYPES: readonly string[]

---

WEBSITE_URL

readonly WEBSITE_URL: string

---

WORLD_DOCUMENT_TYPES

readonly WORLD_DOCUMENT_TYPES: readonly string[]