Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "api"

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

globalEvents

globalEvents: GlobalScriptingEvents

refCard

refCard: Card

Only available in card object scripts

refContainer

refContainer: Container

Only available in container object scripts

refDice

refDice: Dice

Only available in dice object scripts

refHolder

refHolder: CardHolder

Only available in card holder object scripts

refMultistate

refMultistate: MultistateObject

Only available in multistate object scripts

refObject

refObject: GameObject

Only available in object scripts (for all object types except tables)

refPackageId

refPackageId: string

Only available in object scripts: Package id of the package that contains the currently executed object script

refTable

refTable: StaticObject

Only available in table object scripts

world

world: GameWorld

Functions

fetch

  • Fetch resources from a url according to the given options, returning a promise that will resolve to the response.

    Example usage: fetch('https://postman-echo.com/get?foo1=bar1&foo2=bar2').then(res => console.log(JSON.stringify(res.json())))

    Parameters

    • url: string

      The URL to fetch

    • Optional options: FetchOptions

      Options for how to call the URL

    Returns Promise<FetchResponse>

    • A promise that resolves to a response object once the request has finished