constants

Members

(static, constant) ACTIVE_EFFECT_MODES :number

Define the allowed ActiveEffect application modes

Type:
  • number

(static, constant) ASCII :string

An ASCII greeting displayed to the client

Type:
  • string

(static, constant) AUDIO_FILE_EXTENSIONS :Object.<string, string>

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

Type:
  • Object.<string, string>

(static, constant) BASE_DOCUMENT_TYPE :string

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

Type:
  • string

(static, constant) CANVAS_PERFORMANCE_MODES :number

An enumeration of canvas performance modes.

Type:
  • number

(static, constant) CARD_DRAW_MODES :number

Define the methods by which a Card can be drawn from a Cards stack TOP and FIRST are synonymous, as are BOTTOM and LAST.

Type:
  • number

(static, constant) CHAT_MESSAGE_TYPES :number

Valid Chat Message types

Type:
  • number

(static, constant) COMPENDIUM_DOCUMENT_TYPES :Array.<string>

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

Type:

(static, constant) COMPENDIUM_ENTITY_TYPES :Array.<string>

The allowed Entity types which may exist within a Compendium pack This is a subset of ENTITY_TYPES

Type:

(static, constant) CORE_SUPPORTED_LANGUAGES :Array.<string>

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

Type:

(static, constant) DEFAULT_TOKEN :string

The default artwork used for Token images if none is provided

Type:
  • string

(static, constant) DICE_ROLL_MODES :string

The supported dice roll visibility modes

Type:
  • string

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

Type:

(static, constant) DOCUMENT_PERMISSION_LEVELS :number

Define the allowed permission levels for a non-user Document. Each level is assigned a value in ascending order. Higher levels grant more permissions.

Type:
  • number

(static, constant) DOCUMENT_TYPES :Array.<string>

Define the allowed Document class types.

Type:

(static, constant) DRAWING_FILL_TYPES :number

The allowed fill types which a Drawing object may display NONE: The drawing is not filled SOLID: The drawing is filled with a solid color PATTERN: The drawing is filled with a tiled image pattern

Type:
  • number

(static, constant) DRAWING_TYPES :string

The allowed Drawing types which may be saved

Type:
  • string
Deprecated:
  • since v9 - use CONST.DOCUMENT_LINK_TYPES instead.

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

Type:

(static, constant) ENTITY_PERMISSIONS :number

Deprecated:
  • since v9 - use CONST.DOCUMENT_PERMISSION_LEVELS instead.

Define the allowed permission levels for a non-user Entity. Each level is assigned a value in ascending order. Higher levels grant more permissions.

Type:
  • number

(static, constant) ENTITY_TYPES :Array.<string>

Deprecated:
  • since v9 - use CONST.DOCUMENT_TYPES instead.

Define the allowed Entity class types

Type:

(static, constant) FOLDER_DOCUMENT_TYPES :Array.<string>

Define the allowed Document types which Folders may contain

Type:

(static, constant) FOLDER_ENTITY_TYPES :Array.<string>

Deprecated:
  • since v9 - use CONST.FOLDER_DOCUMENT_TYPES instead.

Define the allowed Document types which Folders may contain

Type:

(static, constant) FOLDER_MAX_DEPTH :number

The maximum allowed level of depth for Folder nesting

Type:
  • number

(static, constant) GAME_VIEWS :Array.<string>

A list of allowed game URL names

Type:

(static, constant) GRID_MIN_SIZE :number

The minimum allowed grid size which is supported by the software

Type:
  • number

(static, constant) GRID_TYPES :number

The allowed Grid types which are supported by the software

Type:
  • number

(static, constant) HTML_FILE_EXTENSIONS :Array.<string>

The allowed set of HTML template extensions

Type:

(static, constant) IMAGE_FILE_EXTENSIONS :Object.<string, string>

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

Type:
  • Object.<string, string>

(static, constant) KEYBINDING_PRECEDENCE :number

The possible precedence values a Keybinding might run in PRIORITY: Runs in the first group along with other PRIORITY keybindings NORMAL: Runs after the PRIORITY group along with other NORMAL keybindings DEFERRED: Runs in the last group along with other DEFERRED keybindings

Type:
  • number

(static, constant) MACRO_SCOPES :Array.<string>

An Array of valid MacroAction scope values

Type:

(static, constant) MACRO_TYPES :string

An enumeration of valid Macro types

Type:
  • string

(static, constant) MEASURED_TEMPLATE_TYPES :string

An enumeration of the allowed types for a MeasuredTemplate embedded document

Type:
  • string

(static, constant) MEDIA_MIME_TYPES :Array.<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.

Type:

(static, constant) PACKAGE_AVAILABILITY_CODES :number

Encode the reasons why a package may be available or unavailable for use

Type:
  • number

(static, constant) PACKAGE_TYPES :Array.<string>

The allowed package types

Type:

(static, constant) PASSWORD_SAFE_STRING :string

A safe password string which can be displayed

Type:
  • string

(static, constant) PLAYLIST_MODES :number

The allowed playback modes for an audio Playlist DISABLED: The playlist does not play on its own, only individual Sound tracks played as a soundboard SEQUENTIAL: The playlist plays sounds one at a time in sequence SHUFFLE: The playlist plays sounds one at a time in randomized order SIMULTANEOUS: The playlist plays all contained sounds at the same time

Type:
  • number

(static, constant) PLAYLIST_SORT_MODES :string

The available sort modes for an audio Playlist. ALPHABETICAL (default): Sort sounds alphabetically. MANUAL: Sort sounds by manual drag-and-drop.

Type:
  • string

(static, constant) SETUP_VIEWS :Array.<string>

A list of supported setup URL names

Type:

(static, constant) SOFTWARE_UPDATE_CHANNELS :string

The allowed software update channels

Type:
  • string

(static, constant) SORT_INTEGER_DENSITY :number

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

Type:
  • number

(static, constant) SOURCE_TYPES :string

Deprecated:
  • since v9

Enumerate the source types which can be used for an AmbientLight placeable object

Type:
  • string

(static, constant) TEXT_ANCHOR_POINTS :number

Define the valid anchor locations for a Tooltip displayed on a Placeable Object

Type:
  • number

(static, constant) TEXT_FILE_EXTENSIONS :Object.<string, string>

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

Type:
  • Object.<string, string>

(static, constant) TILE_OCCLUSION_MODES :number

Define the valid occlusion modes which an overhead tile can use

Type:
  • number

(static, constant) TIMEOUTS :number

Stores shared commonly used timeouts, measured in MS

Type:
  • number

(static, constant) TOKEN_DISPLAY_MODES :number

Describe the various thresholds of token control upon which to show certain pieces of information NONE - no information is displayed CONTROL - displayed when the token is controlled OWNER HOVER - displayed when hovered by a GM or a user who owns the actor HOVER - displayed when hovered by any user OWNER - always displayed for a GM or for a user who owns the actor ALWAYS - always displayed for everyone

Type:
  • number

(static, constant) TOKEN_DISPOSITIONS :number

The allowed Token disposition types HOSTILE - Displayed as an enemy with a red border NEUTRAL - Displayed as neutral with a yellow border FRIENDLY - Displayed as an ally with a cyan border

Type:
  • number

(static, constant) USER_PERMISSIONS :Object.<UserCapability>

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

Type:
  • Object.<UserCapability>

(static, constant) USER_ROLE_NAMES :string

Invert the User Role mapping to recover role names from a role integer

Type:
  • string

(static, constant) USER_ROLES :number

Define the allowed User permission levels. Each level is assigned a value in ascending order. Higher levels grant more permissions.

Type:
  • number

(static, constant) VIDEO_FILE_EXTENSIONS :Object.<string, string>

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

Type:
  • Object.<string, string>

(static, constant) vtt :string

The shortened software name

Type:
  • string

(static, constant) VTT :string

The full software name

Type:
  • string

(static, constant) WALL_DIRECTIONS :number

The allowed directions of effect that a Wall can have BOTH: The wall collides from both directions LEFT: The wall collides only when a ray strikes its left side RIGHT: The wall collides only when a ray strikes its right side

Type:
  • number

(static, constant) WALL_DOOR_STATES :number

The allowed door states which may describe a Wall that contains a door CLOSED: The door is closed OPEN: The door is open LOCKED: The door is closed and locked

Type:
  • number

(static, constant) WALL_DOOR_TYPES :number

The allowed door types which a Wall may contain NONE: The wall does not contain a door DOOR: The wall contains a regular door SECRET: The wall contains a secret door

Type:
  • number

(static, constant) WALL_MOVEMENT_TYPES :number

The types of movement collision which a Wall may impose NONE: Movement does not collide with this wall NORMAL: Movement collides with this wall

Type:
  • number

(static, constant) WALL_RESTRICTION_TYPES :Array.<string>

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

Type:

(static, constant) WALL_SENSE_TYPES :number

The types of sensory collision which a Wall may impose NONE: Senses do not collide with this wall NORMAL: Senses collide with this wall LIMITED: Senses collide with the second intersection, bypassing the first

Type:
  • number

(static, constant) WEBSITE_URL :string

The software website URL

Type:
  • string

(inner, constant) tableResultTypes :number

Properties:
Name Type Description
TEXT number
DOCUMENT number
COMPENDIUM number

The allowed types of a TableResult document

Type:
  • number

Type Definitions

UserCapability

Properties:
Name Type Description
label string
hint string
disableGM boolean
defaultRole number
Type:
  • Object