Skip to content

Main Navigation Guide Recipes API Errors Stability Transparency Design System vttforge.dev

v0.17 (latest)

Appearance

Sidebar Navigation

API reference

Overview

@vttforge/core

Classes

PackageConfig

VttfError

Interfaces

ActiveEffectConfig

ActiveEffectLike

ActorLike

ApplicationConfiguration

ApplicationFormConfiguration

ApplicationHeaderControlsEntry

ApplicationPosition

ApplicationRenderOptions

ApplicationTab

ApplicationTabsConfiguration

ApplicationV2Members

ApplicationWindowConfiguration

ArrayFieldCtor

ArrayFieldInstance

ArrayFieldOptions

AskGmOptions

BaseApplicationMembers

BaseDocumentSheetMembers

BooleanFieldCtor

BooleanFieldInstance

CanvasApi

ChatMessageConfig

ChatMessageConstructor

ChatMessageLike

ChatSpeakerData

CheckboxPromptField

ColorFieldCtor

ColorFieldInstance

CombatantLike

CombatConfig

CombatHistoryData

CombatLike

CompendiumCollection

ContextMenuEntry

ConvertedSubTypes

ConvertSubTypesOptions

CountableRoll

DatabaseOperationOptions

DataFieldOptions

DiceConfig

DicePoolSpec

DiceTermResult

DieTermLike

DocumentConfig

DocumentMembers

DocumentSheetOptions

DocumentSheetV2Members

DocumentTypeMap

DragDropConfig

DropData

EmbeddedCollection

EmbeddedDataFieldCtor

EmbeddedDataFieldInstance

EmbeddedDocumentFieldCtor

EmbeddedDocumentFieldInstance

EmbeddedDocumentOwner

EmitOptions

EnricherRegistration

ErrorManifest

FieldInstance

FieldsApi

FilePathFieldCtor

FilePathFieldInstance

FilePathFieldOptions

FolderLike

FolderLikeDocument

ForeignDocumentFieldCtor

ForeignDocumentFieldInstance

ForeignDocumentFieldOptions

FoundryCollection

FoundryConfig

FoundryConstants

FoundryGlobals

FoundryUtils

Game

GameSettingsApi

GameTimeApi

HandlebarsTemplatePart

HookMap

HooksApi

HotReloadData

HTMLFieldCtor

HTMLFieldInstance

InjectOptions

ItemLike

JournalEntryLike

KeybindingsApi

KeyboardApi

Keyword

LevelLike

LocalizationApi

MacroLike

Migration

MigrationLogger

MigrationRunner

ModuleRegistration

Notification

NotificationOptions

NotificationsApi

NumberFieldCtor

NumberFieldInstance

NumberFieldOptions

NumberPromptField

PackageHandle

PackageSocket

Point

PostableRoll

PostRollOptions

PromptFieldsOptions

ResourceFieldOptions

RollConstructor

RollEvaluateOptions

RollLike

RollOutcome

RollTermLike

SceneControl

SceneLike

SchemaFieldCtor

SchemaFieldInstance

SelectPromptField

SelectPromptOption

SetFieldCtor

SetFieldInstance

SettingConfig

SettingMenuConfig

SheetBaseCtor

SheetBaseMembers

SheetBaseStatics

SheetModesConfig

SheetRegistration

SocketApi

SocketContext

SocketRegistration

StatusEffectConfig

StringFieldCtor

StringFieldInstance

StringFieldOptions

SubTypedDocument

SubTypeQuery

SuccessCount

SystemHandle

SystemRegistration

SystemSettingOptions

TextareaPromptField

TextEditorConfig

TextPromptField

TokenDocumentLike

TokenObjectLike

ToMessageOptions

TypeDataModelHooks

TypeDataModelMembers

TypedSchemaFieldCtor

TypedSchemaFieldInstance

TypedTypeDataModelCtor

UiApi

UserLike

VttfErrorEntry

WorldCollection

WorldHandle

Type Aliases

ActorConfig

AnyClass

ApplicationClickAction

ApplicationRenderContext

BooleanFieldOptions

ColorFieldOptions

ConfigCollection

DataModelClass

DocumentClass

DocumentFlags

DocumentHookName

DocumentSheetKind

EmbeddedDataFieldOptions

EmbeddedDocumentFieldOptions

GameApi

HookCallback

HookName

HTMLFieldOptions

InferField

InferSchema

InjectPosition

ItemConfig

MigrationRunnerOptions

MissingApiReason

NotificationType

PackageApi

PackageKind

Prettify

PromptField

PromptFieldValue

PromptResult

QueryHandlers

ResourceChildField

ResourceFieldInstance

RollThreshold

SchemaFieldOptions

SetFieldOptions

SettingScope

SheetDocumentKind

SheetMode

SocketMessageHandler

SocketMessageRun

SocketRequestHandler

SocketRequestRun

SocketSender

SubTypeDocument

SystemConfig

TypedSchemaFieldOptions

TypedTypeDataModel

VttfErrorCode

VttforgeClass

Variables

DEFAULT_DIE_LADDER

EDIT_IN_PLAY_ATTRIBUTE

ERROR_MANIFEST_VERSION

INJECTION_ATTRIBUTE

KEYWORD_ATTRIBUTE

KEYWORD_CLASS

KEYWORD_ENRICHER_ID

MODE_CLASS

ROLL_CARD_CLASS

SystemConfig

TOGGLE_MODE_ACTION

VTTFORGE_CORE_VERSION

VTTFORGE_SHEET_CLASS

Functions

ActorDataModel

BaseActorSheet

BaseApplication

BaseDocumentSheet

BaseItemSheet

BaseTypeDataModel

convertSubTypes

countSuccesses

createMigrationRunner

dicePool

docsUrlFor

DocumentSheet

fields

getErrorEntry

getErrorManifest

inject

isModuleActive

ItemDataModel

keywordEnricher

keywordJournalContent

listErrorEntries

moduleApi

moduleSubType

naturalResult

OnHook

postRoll

promptFieldGroup

promptFields

registerEnrichers

registerModule

registerSheets

registerSocket

registerSystem

requireModuleApi

resourceField

rollOutcome

schemaHasResource

stepDie

subTypeDocuments

syncKeywordJournal

SystemSetting

@vttforge/types

Interfaces

ActiveEffectConfig

ActiveEffectLike

ActorLike

ApplicationConfiguration

ApplicationFormConfiguration

ApplicationHeaderControlsEntry

ApplicationPosition

ApplicationRenderOptions

ApplicationTab

ApplicationTabsConfiguration

ApplicationV2Members

ApplicationWindowConfiguration

CanvasApi

ChatMessageConfig

ChatMessageConstructor

ChatMessageLike

ChatSpeakerData

CombatantLike

CombatConfig

CombatHistoryData

CombatLike

CompendiumCollection

ContextMenuEntry

DatabaseOperationOptions

DiceConfig

DiceTermResult

DieTermLike

DiffObjectOptions

DocumentConfig

DocumentMembers

DocumentSheetV2Members

DocumentTypeMap

EmbeddedCollection

EmbeddedDocumentOwner

FolderLike

FolderLikeDocument

FoundryCollection

FoundryConfig

FoundryConstants

FoundryGlobals

FoundryUtils

Game

GameSettingsApi

GameTimeApi

HandlebarsTemplatePart

HookMap

HooksApi

HotReloadData

ItemLike

JournalEntryLike

KeybindingsApi

KeyboardApi

LevelLike

LineCircleIntersection

LineIntersection

LocalizationApi

MacroLike

MergeObjectOptions

Notification

NotificationOptions

NotificationsApi

PackageHandle

ParsedS3URL

Point

ResolvedUUID

RollConstructor

RollEvaluateOptions

RollLike

RollTermLike

SceneControl

SceneLike

SettingConfig

SettingMenuConfig

SocketApi

SortOptions

SortUpdate

StaticHooks

StatusEffectConfig

SystemHandle

TextEditorConfig

TokenDocumentLike

TokenObjectLike

ToMessageOptions

TypeDataModelMembers

UiApi

UserLike

WorldCollection

WorldHandle

Type Aliases

AnyClass

ApplicationClickAction

ApplicationRenderContext

ContextMenuHooks

DocumentFlags

DocumentHookName

DocumentLifecycleHooks

HookCallback

HookName

NotificationType

QueryHandlers

SettingScope

VttforgeClass

Variables

VTTFORGE_TYPES_VERSION

@vttforge/cli

Classes

ScaffoldError

Interfaces

AuditOptions

AuditReport

AuditResult

BuildOptions

DevOptions

EmitZipOptions

EmitZipResult

FoundryManifest

InitOptions

LintOptions

LintResult

ResolvedInitOptions

RuleResult

RunAuditOptions

Type Aliases

PackageType

ReportFormat

RuleFn

Severity

TemplateVariant

Variables

SEVERITY_RANK

VTTFORGE_CLI_VERSION

Functions

emitReleaseZip

emitZip

formatReport

readManifest

runAudit

runAuditCommand

runBuild

runDev

runInit

runLintCommand

runManifestRules

runSourceRules

@vttforge/vite-plugin

Interfaces

VttforgeOptions

Variables

VTTFORGE_VITE_PLUGIN_VERSION

Functions

default

@vttforge/testing

Interfaces

BatchOptions

MockDocument

MockDocumentOptions

MockFoundry

MockFoundryOptions

QuenchContext

RecordedEnricher

RecordedHook

RecordedSetting

RecordedSheet

Functions

createMockActor

createMockConfig

createMockItem

registerBatch

withMockFoundry

On this page

@vttforge/types / HookName

Type Alias: HookName

HookName = keyof HookMap

Pager

Previous pageHookCallback

Next pageNotificationType

MIT licensed.

Not affiliated with Foundry Gaming LLC or with The Forge hosting service.

Type Alias: HookName ​

Type Alias: HookName