Options
All
  • Public
  • Public/Protected
  • All
Menu

Constant definitions used throughout the Foundry Virtual Tabletop framework.

Index

Variables

vtt: string = "Foundry VTT"

The shortened software name

VTT: string = "Foundry Virtual Tabletop"

The full software name

WEBSITE_URL: string = "https://foundryvtt.com"

The software website URL

WEBSITE_API_URL: "https://api.foundryvtt.com" = "https://api.foundryvtt.com"

The serverless API URL

ASCII: string = ...

An ASCII greeting displayed to the client

BASE_DOCUMENT_TYPE: string = "base"

Define the string name used for the base document type when specific sub-types are not defined by the system

CORE_SUPPORTED_LANGUAGES: string[] = ...

Define the set of languages which have built-in support in the core software

DEFAULT_TOKEN: string = 'icons/svg/mystery-man.svg'

The default artwork used for Token images if none is provided

DOCUMENT_TYPES: string[] = ...

Define the allowed Document class types.

COMPENDIUM_DOCUMENT_TYPES: string[] = ...

The allowed Document types which may exist within a Compendium pack.

DOCUMENT_LINK_TYPES: string[] = ...

Define the allowed Document types which may be dynamically linked in chat

FOLDER_DOCUMENT_TYPES: string[] = ...

Define the allowed Document types which Folders may contain

FOLDER_MAX_DEPTH: number = 3

The maximum allowed level of depth for Folder nesting

GAME_VIEWS: string[] = ...

A list of allowed game URL names

GRID_MIN_SIZE: number = 50

The minimum allowed grid size which is supported by the software

SETUP_VIEWS: string[] = ...

A list of supported setup URL names

MACRO_SCOPES: string[] = ...

An Array of valid MacroAction scope values

PACKAGE_TYPES: string[] = ...

The allowed package types

PASSWORD_SAFE_STRING: string = ...

A safe password string which can be displayed

SORT_INTEGER_DENSITY: number = 100000

The default sorting density for manually ordering child objects within a parent

USER_PERMISSIONS: any = ...

Define the recognized User capabilities which individual Users or role levels may be permitted to perform

WALL_RESTRICTION_TYPES: string[] = ...

The wall properties which restrict the way interaction occurs with a specific wall

HTML_FILE_EXTENSIONS: string[] = ...

The allowed set of HTML template extensions

IMAGE_FILE_EXTENSIONS: Object = ...

The supported file extensions for image-type files, and their corresponding mime types.

VIDEO_FILE_EXTENSIONS: Object = ...

The supported file extensions for video-type files, and their corresponding mime types.

AUDIO_FILE_EXTENSIONS: Object = ...

The supported file extensions for audio-type files, and their corresponding mime types.

TEXT_FILE_EXTENSIONS: Object = ...

The supported file extensions for text files, and their corresponding mime types.

FONT_FILE_EXTENSIONS: Object = ...

Supported file extensions for font files, and their corresponding mime types.

GRAPHICS_FILE_EXTENSIONS: Object = ...

Supported file extensions for 3D files, and their corresponding mime types.

UPLOADABLE_FILE_EXTENSIONS: Object = ...

A consolidated mapping of all extensions permitted for upload.

MEDIA_MIME_TYPES: string[] = ...

A list of MIME types which are treated as uploaded "media", which are allowed to overwrite existing files. Any non-media MIME type is not allowed to replace an existing file.

FILE_CATEGORIES: { HTML: string[]; IMAGE: Object; VIDEO: Object; AUDIO: Object; TEXT: Object; FONT: Object; GRAPHICS: Object; MEDIA: string[] } = ...

An enumeration of file type categories which can be selected

Type declaration

  • HTML: string[]
  • IMAGE: Object
  • VIDEO: Object
  • AUDIO: Object
  • TEXT: Object
  • FONT: Object
  • GRAPHICS: Object
  • MEDIA: string[]
SYSTEM_SPECIFIC_COMPENDIUM_TYPES: string[] = ...

A subset of Compendium types which require a specific system to be designated

SHOWDOWN_OPTIONS: any = ...

The configured showdown bi-directional HTML <-> Markdown converter options.

Type Aliases

FILE_CATEGORIES: Object<string, string>

Type Parameters