diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js new file mode 100644 index 0000000..5fb4878 --- /dev/null +++ b/docs/assets/hierarchy.js @@ -0,0 +1 @@ +window.hierarchyData = "H4sIAAAAAAAACrWcbVPbuBbHv0teC69lWX7gHQW2S2+5ZZv0doadTkbEIuji2L6yQ5vd6Xe/I9kESTFEst1X0Ifz1y9H0jlHR4J/Zrwsm3p2+hf0Yz8EoQ8B9JMkBhD6OATYRwDCNPVBAnEIoB8iBNI0hgBGKAgBjMIwADCCiQ+gH2AI0jiAAKEIgyAIA4BRAHCcAAhD5IMoiL6BGaf3OV01rCzq2ek/MxiH4ktBNnR2Ojurd8Xqgt7npKGfqvY/gdkjK7LZaYAjMNvyfHY6Y0VD+T1Z0fq3Jd8WDdvQZUYaslyVm4rTuvZ6hLyHZpPPwGyVk7qenc6aOjsRyid7NfGPDyzPOC1mp38FafztJ5gFPjYB32+Lv1k1nk/TscCTNOkBzTQsziQImiRXxUQTpws5T1zUThyKTcAvwt+d+B4PBskznhzhCJuq8SpZ+xcCAvu9EON99MV97UR9DsnZ3SQwLzqWNPHB+rllVbdlh07Oi4LF1KQH7ridYmJuHacFBckBxySTcus6JaGvTskUYXhcBIZxCMI4AlHsgzjAYlOHsbqfJgjEA2JwGKMDhnnDKdlMQKIJ2fJEKs9ojzj5Q4+8fiomCfvqJE2RFcYlhMiPWix0iDXBxPUpuXsOgwBBEMY+CGMEsO+DqPMmChRsGfYv6KrMKB+Gqyo4Y6IY4CgBOPElWpSYaMOzq1tixfHB0KMm0TGd6l7BrTcS30S6IXW9eODldv0w1COKxHGvRH6kI4xNJAMSe6SVqK3ABLusR8iSJ1B9csuqs6bh7G7b0IEkmsSAUwWIcCxymlgzkba5RxVALrVPhGN92Kui2ja/s5wOdslewdkjMQQRCkAUy3AXaRl+bEXmWoxFcaqPPm4H3zru3zhQD5ujy0C3ClCbFRQkYjZgkGKtJtQTz1FP3Jd8Q5rlpl5XZPXoHUs7e0dABNX4flmMG7eztxg31I77N2T1OHxUaX1kTL3gRVB6XTRPtBhajeLo7J1IghQD4QyBIxo6Cs6CMzqnhK8ePtNsu3KsQ+qGb1fNspYCy4Yz6h0IOi/W0JfRVHzV/MbKwmQ86rweQFXo+BpCobZ2Xz7dn1vKd2NAlv8TCp6haBFW0kjtst3k2zUrroqn8pHOt1VV8saKqpJ2yw0pyJpyr0fmOIroJB6gdNZXmyq3XUu9LIqO6xISLhJLKAm0huQFJ+s1ucvp+5o8Z5J5U3LrPFk/0byhS1KwDWnocl2TyjuT7U/vVW27VJXgUM1VcznQWVXlbEWEltWUPuO9mHkHQi5xI4khkm6MoXrYWnyYXzCSl+uhUHsBxyAmOtjI9xMAkegmQBREMYAIRT6AKMTi7zGGAKJINLhRHMrWYZJqpbzii/kDzXOXDyFycVnQotE+jql4fN+kMFCbM5ebqtlNz9UrawGn91oXH+bTo/WIWoAh7Zi4+DB/L/7phhR2FfYxor2aBUqsTaAwJhs6p03DinXtQlOLGLG8f2pEbmjNPUPOaZfgBMk0n8apGvq+ljzPOsEzzslOj3vDQJffharXr23hxESrRPYRdERkbiGrsmbtzjRis3tcTtNAdeN7Xm6rP7ds9bgoz0me35HV40hEmUtYWZzdXHl98racWgf+1yG602nrU/hTHkV8GOl9RdYwks93dUM343BbDa9T9DRlO2dCX78n/A/JWUaakk+It9f0DHVrRKxOeGv7jtQjd0zH8CLn3OYXEwukB9t5DpJUj5Q33VjuwWdPqahYnALFTbdapXaWIiCMc5aCsdhVtPZUaVfHiQrwW4eL+z32lbPmF1D3jOA+60HS0eNEy4ycFLU4wX7ibM2m+gTPoiIgvTKC7TaKfe3Jgkhfn+7+S1fNwATJ24Plkgilk1JKeaasU0b346gLmbF28Dvn2+wX8fZJuzCL4qNFThK1lrzYFVLW5RjfR+sZQi5s4kDfsqXaPjMkLyhnTzSbDLHTswhX4rWOztXZOjZoXqPS1dx3eoowgBDGrRfFNzrtNakm9OGBmo0HA6x23K6ZKGDyUbFn27DcM4QsQwxE5lnhY7kiudhUZD1gx36ndyd1a+wZYja+Qdg43c1pXYtD2EQ8upwVUWp0F77Su6loXqScYq6YMyB9JZ67JeJ7DON2wYdILVx7WF3WlYprwfraphQ+7OiSNxbbu/Prm1Eu3Xehe4RtphrDNxffpHyH0jaEaarO7r/o7h0rMlas/yBFllPueIMjwsYyKzdLJi7Ulg0rdo90V3uv6bpPfJp2cThNk17wyYmdruBk187oHZar7YYWzTmnx+5G64YUGeGZ2qlZZrJ1uMw6Ge9A0uZCyveTfqoLmtOJqVpJq2syrV2tSFxtjvb1XalaSRsq/amhIvHpe0F5/cCqScH2qjZsSOsiLD7Mfy/zjPJ2IXypsqlW2KGsDV2Ikz66CdeYKmhDhDHsI7r8Mdn6UgVtiCIc9hF9ppvyaUoftYI2RHEY9xKVea4XkBNAPWvacCWJ4amrVVm82zbNkV7KHuml830nrTxNwwYhRUYwn+dlMxbhRcMKIQl0hEW5Xud0Cl+YSlYvDMzLkvMyL3k2DGUlbJcVWz1SfiL/kHmGpBVTkvQx3UjdSZlaSRsmGJuV34qXeX5eFg1hxRCsztA71LLhCdBB4lht66+cWCazFxJRLN0LY09VsWFAfs+GbgODK8S9tPI0DSuExNzQT+uxBHsJG4DQTODDdo5oAHp7a5uBMTTiiHzzNnRcaWw1LEY9w54/0NXjXflj1PDPIlYYadyD8e/t5m7IzCsQrYQNQmSmWWn/mRRHjv3HCKSCFUCKXwOYwBGKjg1MHMIemAX9MW5JCgGr4c1bmjkVP9g3dOzW2mbgBKVmrioaWjSXGXMfXVxO04yJWzVdyYYkNaPxDS9res04L91Xgk6iKFmRxEZMXLBid31+OZKiU7EgwL7ZkhNvgQdGZgFxz3LalhBKufWiaYMEzVsxYT686nsby6kGxAe1jZAYXhm/jeZULeMgCMx93b7dGLy/1FcqqpgVjbmwnwXm393rrldphJgNzUFffvFAN/RS7pfRMIqWFYvZKRDT/JHc0bcfW/WQ5MLIUxVsxg/NLl17FhpHoGhYMUSREYC7C18RyHmZfyQ795ycC6Pey29V1QYP+2aKZBmd5yyjI8BqltGTWoh4B4pWUGZv7ppmjHSZzxVpI2w9Q8SGIjL7lte02LqPXmy9ztZm0MRMCOqbua+sefhyZYdg8QSvlbOgEr8+4eAd7/n+M8K3iNpLDe/AxunmKgr89updfPM6iTuH08PhNPGBeOQKxGNSIB5uAtm/ArKFBGQXB8jmCZDtCiAbBEAey4E8GAN5NgXygAjkaQ3IwxOQZxcgjw9A1vBAFs9A1rBAFpRAFnNAFlJAFjNA1g9ApmogsyKQ2QjILABk/AUyCgIZh4Dc7kDuLyDXN4BRgKLOsyh63bPiTc2bV9797pVmNgss0C745hVnxctD7P7Lne62bFO2T7ykycnry0q/wImQ9oPki++UFsoHtBmxs3EYUnt0+ZmSzOLiXh/z2cj5Rk04GMhP3U52qP30jhuLjCx7FKvPr++jIA6BeCYL5JsG+Tta0mcsNRtZvm3QsJ5t3LHkEzUgn3p9+/nz5/8BBwHqGHpGAAA=" \ No newline at end of file diff --git a/docs/classes/_runtime_data_struct_cache_quick-lru.QuickLRU.html b/docs/classes/_runtime_data_struct_cache_quick-lru.QuickLRU.html new file mode 100644 index 0000000..6d52d17 --- /dev/null +++ b/docs/classes/_runtime_data_struct_cache_quick-lru.QuickLRU.html @@ -0,0 +1,67 @@ +QuickLRU | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class QuickLRU<KeyType, ValueType>

Type Parameters

  • KeyType
  • ValueType
+
+ +
+ Implements +
+ +
+
+
+
+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Accessors

maxSize +size +

Methods

[iterator] +clear +delete +entries +entriesAscending +entriesDescending +forEach +get +has +keys +peek +resize +set +values +

Properties

[toStringTag] +[species] +

Constructors

constructor

Accessors

maxSize

  • get maxSize(): number

  • The set max size.

    +

    Returns number

size

  • get size(): number

  • The stored item count.

    +

    Returns number

Methods

[iterator]

clear

  • clear(): void

  • Delete all items.

    +

    Returns void

delete

  • delete(key: KeyType): boolean

  • Delete an item.

    +

    Parameters

    Returns boolean

    true if the item is removed or false if the item doesn't exist.

    +

entries

entriesAscending

entriesDescending

forEach

  • forEach(
        callbackfn: (
            value: ValueType,
            key: KeyType,
            map: Map<KeyType, ValueType>,
        ) => void,
        thisArg?: any,
    ): void

  • Executes a provided function once per each key/value pair in the Map, in insertion order.

    +

    Parameters

    Returns void

get

has

  • has(key: KeyType): boolean

  • Check if an item exists.

    +

    Parameters

    Returns boolean

keys

peek

resize

  • resize(maxSize: number): void

  • Update the maxSize in-place, discarding items as necessary. Insertion order is mostly preserved, though this is not a strong guarantee.

    +

    Useful for on-the-fly tuning of cache sizes in live systems.

    +

    Parameters

    • maxSize: number

    Returns void

set

  • set(key: KeyType, value: ValueType, options?: { maxAge?: number }): this

  • Set an item. Returns the instance.

    +

    Individual expiration of an item can be specified with the maxAge option. If not specified, the global maxAge value will be used in case it is specified in the constructor, otherwise the item will never expire.

    +

    Parameters

    Returns this

    The list instance.

    +

values

Properties

Readonly[toStringTag]

"[toStringTag]": string

Static Readonly[species]

"[species]": MapConstructor

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
Properties
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Mat2.html b/docs/classes/_runtime_math_gl-matrix.Mat2.html new file mode 100644 index 0000000..1fe4dab --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Mat2.html @@ -0,0 +1,364 @@ +Mat2 | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Mat2

A 2x2 Matrix

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

str +

Constructor

constructor +

Methods

copy +identity +invert +mul +multiply +rotate +scale +transpose +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Static

BYTE_LENGTH +add +adjoint +clone +copy +create +determinant +equals +exactEquals +frob +fromRotation +fromScaling +fromValues +identity +invert +LDU +mul +multiply +multiplyScalar +multiplyScalarAndAdd +rotate +scale +set +str +sub +subtract +transpose +

Accessors

str

  • get str(): string

  • A string representation of this +Equivalent to Mat2.str(this);

    +

    Returns string

Constructor

constructor

Methods

copy

identity

  • identity(): this

  • Set this to the identity matrix +Equivalent to Mat2.identity(this)

    +

    Returns this

    this

    +

invert

  • invert(): this

  • Inverts this Mat2 +Equivalent to Mat4.invert(this, this);

    +

    Returns this

    this

    +

mul

multiply

  • multiply(b: Readonly<Mat2Like>): this

  • Multiplies this Mat2 against another one +Equivalent to Mat2.multiply(this, this, b);

    +

    Parameters

    Returns this

    this

    +

rotate

  • rotate(rad: number): this

  • Rotates this Mat2 by the given angle around the given axis +Equivalent to Mat2.rotate(this, this, rad);

    +

    Parameters

    • rad: number

      the angle to rotate the matrix by

      +

    Returns this

    this

    +

scale

  • scale(v: Readonly<Vec2Like>): this

  • Scales this Mat2 by the dimensions in the given vec3 not using vectorization +Equivalent to Mat2.scale(this, this, v);

    +

    Parameters

    Returns this

    this

    +

transpose

  • transpose(): this

  • Transpose this Mat2 +Equivalent to Mat2.transpose(this, this);

    +

    Returns this

    this

    +

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Mat2.

    +

Staticadd

Staticadjoint

Staticclone

Staticcopy

Staticcreate

Staticdeterminant

Staticequals

StaticexactEquals

Staticfrob

StaticfromRotation

  • fromRotation(out: Mat2Like, rad: number): Mat2Like

  • Creates a Mat2 from a given angle around a given axis +This is equivalent to (but much faster than):

    +
      mat2.identity(dest);
      mat2.rotate(dest, dest, rad);
+
    + +

    Parameters

    • out: Mat2Like

      Mat2 receiving operation result

      +
    • rad: number

      the angle to rotate the matrix by

      +

    Returns Mat2Like

    out

    +

StaticfromScaling

StaticfromValues

  • fromValues(...values: number[]): Mat2

  • Create a new Mat2 with the given values

    +

    Parameters

    • ...values: number[]

      Matrix components

      +

    Returns Mat2

    A new Mat2

    +

Staticidentity

Staticinvert

StaticLDU

Staticmul

Staticmultiply

StaticmultiplyScalar

StaticmultiplyScalarAndAdd

Staticrotate

Staticscale

Staticset

  • set(out: Mat2Like, ...values: number[]): Mat2Like

  • Set the components of a Mat2 to the given values

    +

    Parameters

    • out: Mat2Like

      The receiving matrix

      +
    • ...values: number[]

      Matrix components

      +

    Returns Mat2Like

    out

    +

Staticstr

  • str(a: Readonly<Mat2Like>): string

  • Returns a string representation of a Mat2

    +

    Parameters

    Returns string

    string representation of the matrix

    +

Staticsub

Staticsubtract

Statictranspose

Settings

Member Visibility

On This Page

Accessors
Constructor
Methods
Other
Static
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Mat2d.html b/docs/classes/_runtime_math_gl-matrix.Mat2d.html new file mode 100644 index 0000000..566d236 --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Mat2d.html @@ -0,0 +1,360 @@ +Mat2d | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Mat2d

A 2x3 Matrix

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

str +

Constructor

constructor +

Methods

copy +identity +mul +multiply +rotate +scale +translate +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Static

BYTE_LENGTH +add +clone +copy +create +determinant +equals +exactEquals +frob +fromRotation +fromScaling +fromTranslation +fromValues +identity +invert +mul +multiply +multiplyScalar +multiplyScalarAndAdd +rotate +scale +set +str +sub +subtract +translate +

Accessors

str

  • get str(): string

  • A string representation of this +Equivalent to Mat2d.str(this);

    +

    Returns string

Constructor

constructor

Methods

copy

identity

  • identity(): this

  • Set this to the identity matrix +Equivalent to Mat2d.identity(this)

    +

    Returns this

    this

    +

mul

multiply

  • multiply(b: Readonly<Mat2dLike>): this

  • Multiplies this Mat2d against another one +Equivalent to Mat2d.multiply(this, this, b);

    +

    Parameters

    Returns this

    this

    +

rotate

  • rotate(rad: number): this

  • Rotates this Mat2d by the given angle around the given axis +Equivalent to Mat2d.rotate(this, this, rad);

    +

    Parameters

    • rad: number

      the angle to rotate the matrix by

      +

    Returns this

    this

    +

scale

  • scale(v: Readonly<Vec2Like>): this

  • Scales this Mat2d by the dimensions in the given vec3 not using vectorization +Equivalent to Mat2d.scale(this, this, v);

    +

    Parameters

    Returns this

    this

    +

translate

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Mat2d.

    +

Staticadd

Staticclone

Staticcopy

Staticcreate

Staticdeterminant

Staticequals

StaticexactEquals

Staticfrob

StaticfromRotation

  • fromRotation(out: Mat2dLike, rad: number): Mat2dLike

  • Creates a Mat2d from a given angle around a given axis +This is equivalent to (but much faster than):

    +
      Mat2d.identity(dest);
      Mat2d.rotate(dest, dest, rad);
+
    + +

    Parameters

    • out: Mat2dLike

      Mat2d receiving operation result

      +
    • rad: number

      the angle to rotate the matrix by

      +

    Returns Mat2dLike

    out

    +

StaticfromScaling

StaticfromTranslation

StaticfromValues

  • fromValues(...values: number[]): Mat2d

  • Create a new Mat2d with the given values

    +

    Parameters

    • ...values: number[]

      Matrix components

      +

    Returns Mat2d

    A new Mat2d

    +

Staticidentity

Staticinvert

Staticmul

Staticmultiply

StaticmultiplyScalar

StaticmultiplyScalarAndAdd

Staticrotate

Staticscale

Staticset

  • set(out: Mat2dLike, ...values: number[]): Mat2dLike

  • Set the components of a Mat2d to the given values

    +

    Parameters

    • out: Mat2dLike

      The receiving matrix

      +
    • ...values: number[]

      Matrix components

      +

    Returns Mat2dLike

    out

    +

Staticstr

  • str(a: Readonly<Mat2dLike>): string

  • Returns a string representation of a Mat2d

    +

    Parameters

    Returns string

    string representation of the matrix

    +

Staticsub

Staticsubtract

Statictranslate

Settings

Member Visibility

On This Page

Accessors
Constructor
Methods
Other
Static
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Mat3.html b/docs/classes/_runtime_math_gl-matrix.Mat3.html new file mode 100644 index 0000000..c0ca45d --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Mat3.html @@ -0,0 +1,414 @@ +Mat3 | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Mat3

A 3x3 Matrix

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

str +

Constructor

constructor +

Methods

copy +identity +invert +mul +multiply +rotate +scale +translate +transpose +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Static

BYTE_LENGTH +add +adjoint +clone +copy +create +determinant +equals +exactEquals +frob +fromMat2d +fromMat4 +fromQuat +fromRotation +fromScaling +fromTranslation +fromValues +identity +invert +mul +multiply +multiplyScalar +multiplyScalarAndAdd +normalFromMat4 +normalFromMat4Fast +projection +rotate +scale +set +str +sub +subtract +translate +transpose +

Accessors

str

  • get str(): string

  • A string representation of this +Equivalent to Mat3.str(this);

    +

    Returns string

Constructor

constructor

Methods

copy

identity

  • identity(): this

  • Set this to the identity matrix +Equivalent to Mat3.identity(this)

    +

    Returns this

    this

    +

invert

  • invert(): this

  • Inverts this Mat3 +Equivalent to Mat4.invert(this, this);

    +

    Returns this

    this

    +

mul

multiply

  • multiply(b: Readonly<Mat3Like>): this

  • Multiplies this Mat3 against another one +Equivalent to Mat3.multiply(this, this, b);

    +

    Parameters

    Returns this

    this

    +

rotate

  • rotate(rad: number): this

  • Rotates this Mat3 by the given angle around the given axis +Equivalent to Mat3.rotate(this, this, rad);

    +

    Parameters

    • rad: number

      the angle to rotate the matrix by

      +

    Returns this

    this

    +

scale

  • scale(v: Readonly<Vec2Like>): this

  • Scales this Mat3 by the dimensions in the given vec3 not using vectorization +Equivalent to Mat3.scale(this, this, v);

    +

    Parameters

    Returns this

    this

    +

translate

  • translate(v: Readonly<Vec2Like>): this

  • Translate this Mat3 by the given vector +Equivalent to Mat3.translate(this, this, v);

    +

    Parameters

    Returns this

    this

    +

transpose

  • transpose(): this

  • Transpose this Mat3 +Equivalent to Mat3.transpose(this, this);

    +

    Returns this

    this

    +

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Mat3.

    +

Staticadd

Staticadjoint

Staticclone

Staticcopy

Staticcreate

Staticdeterminant

Staticequals

StaticexactEquals

Staticfrob

StaticfromMat2d

StaticfromMat4

StaticfromQuat

StaticfromRotation

  • fromRotation(out: Mat3Like, rad: number): Mat3Like

  • Creates a Mat3 from a given angle around a given axis +This is equivalent to (but much faster than):

    +
    mat3.identity(dest);
+mat3.rotate(dest, dest, rad);
+
    +

    Parameters

    • out: Mat3Like

      Mat3 receiving operation result

      +
    • rad: number

      the angle to rotate the matrix by

      +

    Returns Mat3Like

    out

    +

StaticfromScaling

StaticfromTranslation

StaticfromValues

  • fromValues(...values: number[]): Mat3

  • Create a new Mat3 with the given values

    +

    Parameters

    • ...values: number[]

      Matrix components

      +

    Returns Mat3

    A new Mat3

    +

Staticidentity

Staticinvert

Staticmul

Staticmultiply

StaticmultiplyScalar

StaticmultiplyScalarAndAdd

StaticnormalFromMat4

StaticnormalFromMat4Fast

Staticprojection

  • projection(out: Mat3Like, width: number, height: number): Mat3Like

  • Generates a 2D projection matrix with the given bounds

    +

    Parameters

    • out: Mat3Like

      mat3 frustum matrix will be written into

      +
    • width: number

      Width of your gl context

      +
    • height: number

      Height of gl context

      +

    Returns Mat3Like

    out

    +

Staticrotate

Staticscale

Staticset

  • set(out: Mat3Like, ...values: number[]): Mat3Like

  • Set the components of a Mat3 to the given values

    +

    Parameters

    • out: Mat3Like

      The receiving matrix

      +
    • ...values: number[]

      Matrix components

      +

    Returns Mat3Like

    out

    +

Staticstr

  • str(a: Readonly<Mat3Like>): string

  • Returns a string representation of a Mat3

    +

    Parameters

    Returns string

    string representation of the matrix

    +

Staticsub

Staticsubtract

Statictranslate

Statictranspose

Settings

Member Visibility

On This Page

Accessors
Constructor
Methods
Other
Static
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Mat4.html b/docs/classes/_runtime_math_gl-matrix.Mat4.html new file mode 100644 index 0000000..7f2b2e3 --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Mat4.html @@ -0,0 +1,678 @@ +Mat4 | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Mat4

A 4x4 Matrix

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

str +

Constructor

constructor +

Methods

copy +identity +invert +mul +multiply +orthoNO +orthoZO +perspectiveNO +perspectiveZO +rotate +rotateX +rotateY +rotateZ +scale +translate +transpose +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Static

BYTE_LENGTH +add +adjoint +clone +copy +create +decompose +determinant +equals +exactEquals +frob +fromQuat +fromQuat2 +fromRotation +fromRotationTranslation +fromRotationTranslationScale +fromRotationTranslationScaleOrigin +fromScaling +fromTranslation +fromValues +fromXRotation +fromYRotation +fromZRotation +frustum +frustumNO +frustumZO +getRotation +getScaling +getTranslation +identity +invert +lookAt +mul +multiply +multiplyScalar +multiplyScalarAndAdd +normalFromMat4 +normalFromMat4Fast +ortho +orthoNO +orthoZO +perspective +perspectiveFromFieldOfView +perspectiveNO +perspectiveZO +rotate +rotateX +rotateY +rotateZ +scale +set +str +sub +subtract +targetTo +translate +transpose +

Accessors

str

  • get str(): string

  • A string representation of this +Equivalent to Mat4.str(this);

    +

    Returns string

Constructor

constructor

Methods

copy

identity

  • identity(): this

  • Set this to the identity matrix +Equivalent to Mat4.identity(this)

    +

    Returns this

    this

    +

invert

  • invert(): this

  • Inverts this Mat4 +Equivalent to Mat4.invert(this, this);

    +

    Returns this

    this

    +

mul

multiply

  • multiply(b: Readonly<Mat4Like>): this

  • Multiplies this Mat4 against another one +Equivalent to Mat4.multiply(this, this, b);

    +

    Parameters

    Returns this

    this

    +

orthoNO

  • orthoNO(
        left: number,
        right: number,
        bottom: number,
        top: number,
        near: number,
        far: number,
    ): this

  • Generates a orthogonal projection matrix with the given bounds. +The near/far clip planes correspond to a normalized device coordinate Z range of [-1, 1], +which matches WebGL/OpenGL's clip volume. +Equivalent to Mat4.orthoNO(this, left, right, bottom, top, near, far);

    +

    Parameters

    • left: number

      Left bound of the frustum

      +
    • right: number

      Right bound of the frustum

      +
    • bottom: number

      Bottom bound of the frustum

      +
    • top: number

      Top bound of the frustum

      +
    • near: number

      Near bound of the frustum

      +
    • far: number

      Far bound of the frustum

      +

    Returns this

    this

    +

orthoZO

  • orthoZO(
        left: number,
        right: number,
        bottom: number,
        top: number,
        near: number,
        far: number,
    ): this

  • Generates a orthogonal projection matrix with the given bounds. +The near/far clip planes correspond to a normalized device coordinate Z range of [0, 1], +which matches WebGPU/Vulkan/DirectX/Metal's clip volume. +Equivalent to Mat4.orthoZO(this, left, right, bottom, top, near, far);

    +

    Parameters

    • left: number

      Left bound of the frustum

      +
    • right: number

      Right bound of the frustum

      +
    • bottom: number

      Bottom bound of the frustum

      +
    • top: number

      Top bound of the frustum

      +
    • near: number

      Near bound of the frustum

      +
    • far: number

      Far bound of the frustum

      +

    Returns this

    this

    +

perspectiveNO

  • perspectiveNO(fovy: number, aspect: number, near: number, far: number): this

  • Generates a perspective projection matrix with the given bounds. +The near/far clip planes correspond to a normalized device coordinate Z range of [-1, 1], +which matches WebGL/OpenGL's clip volume. +Passing null/undefined/no value for far will generate infinite projection matrix. +Equivalent to Mat4.perspectiveNO(this, fovy, aspect, near, far);

    +

    Parameters

    • fovy: number

      Vertical field of view in radians

      +
    • aspect: number

      Aspect ratio. typically viewport width/height

      +
    • near: number

      Near bound of the frustum

      +
    • far: number

      Far bound of the frustum, can be null or Infinity

      +

    Returns this

    this

    +

perspectiveZO

  • perspectiveZO(fovy: number, aspect: number, near: number, far: number): this

  • Generates a perspective projection matrix suitable for WebGPU with the given bounds. +The near/far clip planes correspond to a normalized device coordinate Z range of [0, 1], +which matches WebGPU/Vulkan/DirectX/Metal's clip volume. +Passing null/undefined/no value for far will generate infinite projection matrix. +Equivalent to Mat4.perspectiveZO(this, fovy, aspect, near, far);

    +

    Parameters

    • fovy: number

      Vertical field of view in radians

      +
    • aspect: number

      Aspect ratio. typically viewport width/height

      +
    • near: number

      Near bound of the frustum

      +
    • far: number

      Far bound of the frustum, can be null or Infinity

      +

    Returns this

    this

    +

rotate

  • rotate(rad: number, axis: Readonly<Vec3Like>): this

  • Rotates this Mat4 by the given angle around the given axis +Equivalent to Mat4.rotate(this, this, rad, axis);

    +

    Parameters

    • rad: number

      the angle to rotate the matrix by

      +
    • axis: Readonly<Vec3Like>

      the axis to rotate around

      +

    Returns this

    this

    +

rotateX

  • rotateX(rad: number): this

  • Rotates this Mat4 by the given angle around the X axis +Equivalent to Mat4.rotateX(this, this, rad);

    +

    Parameters

    • rad: number

      the angle to rotate the matrix by

      +

    Returns this

    this

    +

rotateY

  • rotateY(rad: number): this

  • Rotates this Mat4 by the given angle around the Y axis +Equivalent to Mat4.rotateY(this, this, rad);

    +

    Parameters

    • rad: number

      the angle to rotate the matrix by

      +

    Returns this

    this

    +

rotateZ

  • rotateZ(rad: number): this

  • Rotates this Mat4 by the given angle around the Z axis +Equivalent to Mat4.rotateZ(this, this, rad);

    +

    Parameters

    • rad: number

      the angle to rotate the matrix by

      +

    Returns this

    this

    +

scale

  • scale(v: Readonly<Vec3Like>): this

  • Scales this Mat4 by the dimensions in the given vec3 not using vectorization +Equivalent to Mat4.scale(this, this, v);

    +

    Parameters

    Returns this

    this

    +

translate

  • translate(v: Readonly<Vec3Like>): this

  • Translate this Mat4 by the given vector +Equivalent to Mat4.translate(this, this, v);

    +

    Parameters

    Returns this

    this

    +

transpose

  • transpose(): this

  • Transpose this Mat4 +Equivalent to Mat4.transpose(this, this);

    +

    Returns this

    this

    +

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Mat4.

    +

Staticadd

Staticadjoint

Staticclone

Staticcopy

Staticcreate

Staticdecompose

  • decompose(
        out_r: Vec4Like,
        out_t: Vec3Like,
        out_s: Vec3Like,
        mat: Readonly<Mat4Like>,
    ): Vec4Like

  • Decomposes a transformation matrix into its rotation, translation +and scale components. Returns only the rotation component

    +

    Parameters

    • out_r: Vec4Like

      Quaternion to receive the rotation component

      +
    • out_t: Vec3Like

      Vector to receive the translation vector

      +
    • out_s: Vec3Like

      Vector to receive the scaling factor

      +
    • mat: Readonly<Mat4Like>

      Matrix to be decomposed (input)

      +

    Returns Vec4Like

    out_r

    +

Staticdeterminant

Staticequals

StaticexactEquals

Staticfrob

StaticfromQuat

StaticfromQuat2

StaticfromRotation

  • fromRotation(out: Mat4Like, rad: number, axis: Readonly<Vec3Like>): Mat4Like

  • Creates a Mat4 from a given angle around a given axis +This is equivalent to (but much faster than):

    +
      mat4.identity(dest);
      mat4.rotate(dest, dest, rad, axis);
+
    + +

    Parameters

    • out: Mat4Like

      Mat4 receiving operation result

      +
    • rad: number

      the angle to rotate the matrix by

      +
    • axis: Readonly<Vec3Like>

      the axis to rotate around

      +

    Returns Mat4Like

    out or null if axis has a length of 0

    +

StaticfromRotationTranslation

  • fromRotationTranslation(
        out: Mat4Like,
        q: Readonly<Vec4Like>,
        v: Readonly<Vec3Like>,
    ): Mat4Like

  • Creates a matrix from a quaternion rotation and vector translation +This is equivalent to (but much faster than):

    +
      mat4.identity(dest);
      mat4.translate(dest, vec);
      let quatMat = mat4.create();
      quat4.toMat4(quat, quatMat);
      mat4.multiply(dest, quatMat);
+
    + +

    Parameters

    Returns Mat4Like

    out

    +

StaticfromRotationTranslationScale

  • fromRotationTranslationScale(
        out: Mat4Like,
        q: Readonly<Vec4Like>,
        v: Readonly<Vec3Like>,
        s: Readonly<Vec3Like>,
    ): Mat4Like

  • Creates a matrix from a quaternion rotation, vector translation and vector scale +This is equivalent to (but much faster than):

    +
      mat4.identity(dest);
      mat4.translate(dest, vec);
      let quatMat = mat4.create();
      quat4.toMat4(quat, quatMat);
      mat4.multiply(dest, quatMat);
      mat4.scale(dest, scale);
+
    + +

    Parameters

    Returns Mat4Like

    out

    +

StaticfromRotationTranslationScaleOrigin

  • fromRotationTranslationScaleOrigin(
        out: Mat4Like,
        q: Readonly<Vec4Like>,
        v: Readonly<Vec3Like>,
        s: Readonly<Vec3Like>,
        o: Readonly<Vec3Like>,
    ): Mat4Like

  • Creates a matrix from a quaternion rotation, vector translation and vector scale, rotating and scaling around the +given origin. This is equivalent to (but much faster than):

    +
      mat4.identity(dest);
      mat4.translate(dest, vec);
      mat4.translate(dest, origin);
      let quatMat = mat4.create();
      quat4.toMat4(quat, quatMat);
      mat4.multiply(dest, quatMat);
      mat4.scale(dest, scale)
      mat4.translate(dest, negativeOrigin);
+
    + +

    Parameters

    Returns Mat4Like

    out

    +

StaticfromScaling

StaticfromTranslation

StaticfromValues

  • fromValues(...values: number[]): Mat4

  • Create a new mat4 with the given values

    +

    Parameters

    • ...values: number[]

      Matrix components

      +

    Returns Mat4

    A new Mat4

    +

StaticfromXRotation

  • fromXRotation(out: Mat4Like, rad: number): Mat4Like

  • Creates a matrix from the given angle around the X axis +This is equivalent to (but much faster than):

    +
      mat4.identity(dest);
      mat4.rotateX(dest, dest, rad);
+
    + +

    Parameters

    • out: Mat4Like

      mat4 receiving operation result

      +
    • rad: number

      the angle to rotate the matrix by

      +

    Returns Mat4Like

    out

    +

StaticfromYRotation

  • fromYRotation(out: Mat4Like, rad: number): Mat4Like

  • Creates a matrix from the given angle around the Y axis +This is equivalent to (but much faster than):

    +
      mat4.identity(dest);
      mat4.rotateY(dest, dest, rad);
+
    + +

    Parameters

    • out: Mat4Like

      mat4 receiving operation result

      +
    • rad: number

      the angle to rotate the matrix by

      +

    Returns Mat4Like

    out

    +

StaticfromZRotation

  • fromZRotation(out: Mat4Like, rad: number): Mat4Like

  • Creates a matrix from the given angle around the Z axis +This is equivalent to (but much faster than):

    +
      mat4.identity(dest);
      mat4.rotateZ(dest, dest, rad);
+
    + +

    Parameters

    • out: Mat4Like

      mat4 receiving operation result

      +
    • rad: number

      the angle to rotate the matrix by

      +

    Returns Mat4Like

    out

    +

Staticfrustum

  • frustum(
        out: Mat4Like,
        left: number,
        right: number,
        bottom: number,
        top: number,
        near: number,
        far?: number,
    ): Mat4Like

  • Alias for Mat4.frustumNO

    +

    Parameters

    • out: Mat4Like
    • left: number
    • right: number
    • bottom: number
    • top: number
    • near: number
    • Optionalfar: number

    Returns Mat4Like

    Deprecated

    Use Mat4.frustumNO or Mat4.frustumZO explicitly

    +

StaticfrustumNO

  • frustumNO(
        out: Mat4Like,
        left: number,
        right: number,
        bottom: number,
        top: number,
        near: number,
        far?: number,
    ): Mat4Like

  • Generates a frustum matrix with the given bounds +The near/far clip planes correspond to a normalized device coordinate Z range of [-1, 1], +which matches WebGL/OpenGL's clip volume. +Passing null/undefined/no value for far will generate infinite projection matrix.

    +

    Parameters

    • out: Mat4Like

      mat4 frustum matrix will be written into

      +
    • left: number

      Left bound of the frustum

      +
    • right: number

      Right bound of the frustum

      +
    • bottom: number

      Bottom bound of the frustum

      +
    • top: number

      Top bound of the frustum

      +
    • near: number

      Near bound of the frustum

      +
    • Optionalfar: number

      Far bound of the frustum, can be null or Infinity

      +

    Returns Mat4Like

    out

    +

StaticfrustumZO

  • frustumZO(
        out: Mat4Like,
        left: number,
        right: number,
        bottom: number,
        top: number,
        near: number,
        far?: number,
    ): Mat4Like

  • Generates a frustum matrix with the given bounds +The near/far clip planes correspond to a normalized device coordinate Z range of [0, 1], +which matches WebGPU/Vulkan/DirectX/Metal's clip volume. +Passing null/undefined/no value for far will generate infinite projection matrix.

    +

    Parameters

    • out: Mat4Like

      mat4 frustum matrix will be written into

      +
    • left: number

      Left bound of the frustum

      +
    • right: number

      Right bound of the frustum

      +
    • bottom: number

      Bottom bound of the frustum

      +
    • top: number

      Top bound of the frustum

      +
    • near: number

      Near bound of the frustum

      +
    • Optionalfar: number

      Far bound of the frustum, can be null or Infinity

      +

    Returns Mat4Like

    out

    +

StaticgetRotation

  • getRotation(out: Vec4Like, mat: Readonly<Mat4Like>): Vec4Like

  • Returns a quaternion representing the rotational component +of a transformation matrix. If a matrix is built with +fromRotationTranslation, the returned quaternion will be the +same as the quaternion originally supplied.

    +

    Parameters

    Returns Vec4Like

    out

    +

StaticgetScaling

  • getScaling(out: Vec3Like, mat: Readonly<Mat4Like>): Vec3Like

  • Returns the scaling factor component of a transformation +matrix. If a matrix is built with fromRotationTranslationScale +with a normalized Quaternion parameter, the returned vector will be +the same as the scaling vector +originally supplied.

    +

    Parameters

    Returns Vec3Like

    out

    +

StaticgetTranslation

  • getTranslation(out: Vec3Like, mat: Readonly<Mat4Like>): Vec3Like

  • Returns the translation vector component of a transformation +matrix. If a matrix is built with fromRotationTranslation, +the returned vector will be the same as the translation vector +originally supplied.

    +

    Parameters

    Returns Vec3Like

    out

    +

Staticidentity

Staticinvert

StaticlookAt

Staticmul

Staticmultiply

StaticmultiplyScalar

StaticmultiplyScalarAndAdd

StaticnormalFromMat4

StaticnormalFromMat4Fast

Staticortho

  • ortho(
        out: Mat4Like,
        left: number,
        right: number,
        bottom: number,
        top: number,
        near: number,
        far: number,
    ): Mat4Like

  • Alias for Mat4.orthoNO

    +

    Parameters

    • out: Mat4Like
    • left: number
    • right: number
    • bottom: number
    • top: number
    • near: number
    • far: number

    Returns Mat4Like

    Deprecated

    Use Mat4.orthoNO or Mat4.orthoZO explicitly

    +

StaticorthoNO

  • orthoNO(
        out: Mat4Like,
        left: number,
        right: number,
        bottom: number,
        top: number,
        near: number,
        far: number,
    ): Mat4Like

  • Generates an orthogonal projection matrix with the given bounds. The near / far clip planes correspond to a +normalized device coordinate Z range of [-1, 1], which matches WebGL / OpenGLs clip volume.

    +

    Parameters

    • out: Mat4Like

      mat4 frustum matrix will be written into

      +
    • left: number

      Left bound of the frustum

      +
    • right: number

      Right bound of the frustum

      +
    • bottom: number

      Bottom bound of the frustum

      +
    • top: number

      Top bound of the frustum

      +
    • near: number

      Near bound of the frustum

      +
    • far: number

      Far bound of the frustum

      +

    Returns Mat4Like

    out

    +

StaticorthoZO

  • orthoZO(
        out: Mat4Like,
        left: number,
        right: number,
        bottom: number,
        top: number,
        near: number,
        far: number,
    ): Mat4Like

  • Generates a orthogonal projection matrix with the given bounds. The near / far clip planes correspond to a +normalized device coordinate Z range of [0, 1], which matches WebGPU / Vulkan / DirectX / Metal's clip volume.

    +

    Parameters

    • out: Mat4Like

      mat4 frustum matrix will be written into

      +
    • left: number

      Left bound of the frustum

      +
    • right: number

      Right bound of the frustum

      +
    • bottom: number

      Bottom bound of the frustum

      +
    • top: number

      Top bound of the frustum

      +
    • near: number

      Near bound of the frustum

      +
    • far: number

      Far bound of the frustum

      +

    Returns Mat4Like

    out

    +

Staticperspective

StaticperspectiveFromFieldOfView

  • perspectiveFromFieldOfView(
        out: Mat4Like,
        fov: {
            downDegrees: number;
            leftDegrees: number;
            rightDegrees: number;
            upDegrees: number;
        },
        near: number,
        far: number,
    ): Mat4Like

  • Generates a perspective projection matrix with the given field of view. This is primarily useful for generating +projection matrices to be used with the still experimental WebVR API.

    +

    Parameters

    • out: Mat4Like

      mat4 frustum matrix will be written into

      +
    • fov: {
          downDegrees: number;
          leftDegrees: number;
          rightDegrees: number;
          upDegrees: number;
      }

      Object containing the following values: upDegrees, downDegrees, leftDegrees, rightDegrees

      +
    • near: number

      Near bound of the frustum

      +
    • far: number

      Far bound of the frustum

      +

    Returns Mat4Like

    out

    +

    Deprecated

StaticperspectiveNO

  • perspectiveNO(
        out: Mat4Like,
        fovy: number,
        aspect: number,
        near: number,
        far?: number,
    ): Mat4Like

  • Generates a perspective projection matrix with the given bounds. +The near/far clip planes correspond to a normalized device coordinate Z range of [-1, 1], +which matches WebGL/OpenGL's clip volume. +Passing null/undefined/no value for far will generate infinite projection matrix.

    +

    Parameters

    • out: Mat4Like

      mat4 frustum matrix will be written into

      +
    • fovy: number

      Vertical field of view in radians

      +
    • aspect: number

      Aspect ratio. typically viewport width/height

      +
    • near: number

      Near bound of the frustum

      +
    • Optionalfar: number

      Far bound of the frustum, can be null or Infinity

      +

    Returns Mat4Like

    out

    +

StaticperspectiveZO

  • perspectiveZO(
        out: Mat4Like,
        fovy: number,
        aspect: number,
        near: number,
        far?: number,
    ): Mat4Like

  • Generates a perspective projection matrix suitable for WebGPU with the given bounds. +The near/far clip planes correspond to a normalized device coordinate Z range of [0, 1], +which matches WebGPU/Vulkan/DirectX/Metal's clip volume. +Passing null/undefined/no value for far will generate infinite projection matrix.

    +

    Parameters

    • out: Mat4Like

      mat4 frustum matrix will be written into

      +
    • fovy: number

      Vertical field of view in radians

      +
    • aspect: number

      Aspect ratio. typically viewport width/height

      +
    • near: number

      Near bound of the frustum

      +
    • Optionalfar: number

      Far bound of the frustum, can be null or Infinity

      +

    Returns Mat4Like

    out

    +

Staticrotate

StaticrotateX

StaticrotateY

StaticrotateZ

Staticscale

Staticset

  • set(out: Mat4Like, ...values: number[]): Mat4Like

  • Set the components of a mat4 to the given values

    +

    Parameters

    • out: Mat4Like

      The receiving matrix

      +
    • ...values: number[]

      Matrix components

      +

    Returns Mat4Like

    out

    +

Staticstr

  • str(a: Readonly<Mat4Like>): string

  • Returns a string representation of a Mat4

    +

    Parameters

    Returns string

    string representation of the matrix

    +

Staticsub

Staticsubtract

StatictargetTo

Statictranslate

Statictranspose

Settings

Member Visibility

On This Page

Accessors
Constructor
Methods
Other
Static
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Quat.html b/docs/classes/_runtime_math_gl-matrix.Quat.html new file mode 100644 index 0000000..1c308fa --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Quat.html @@ -0,0 +1,480 @@ +Quat | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Quat

Quaternion

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

mag +magnitude +str +

Constructor

constructor +

Methods

copy +dot +identity +invert +mul +multiply +rotateX +rotateY +rotateZ +scale +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Quaternion Components

w +x +y +z +

Static

BYTE_LENGTH +add +calculateW +clone +conjugate +copy +create +dot +equals +exactEquals +exp +fromEuler +fromMat3 +fromValues +getAngle +getAxisAngle +identity +invert +len +length +lerp +ln +mag +magnitude +mul +multiply +normalize +pow +rotateX +rotateY +rotateZ +rotationTo +scale +set +setAxes +setAxisAngle +slerp +sqlerp +sqrLen +squaredLength +str +

Accessors

mag

magnitude

  • get magnitude(): number

  • The magnitude (length) of this. +Equivalent to Quat.magnitude(this);

    +

    Magnitude is used because the length attribute is already defined by +TypedArrays to mean the number of elements in the array.

    +

    Returns number

str

  • get str(): string

  • A string representation of this +Equivalent to Quat.str(this);

    +

    Returns string

Constructor

constructor

Methods

copy

dot

  • dot(b: Readonly<Vec4Like>): number

  • Calculates the dot product of this and another Quat +Equivalent to Quat.dot(this, b);

    +

    Parameters

    Returns number

    dot product of this and b

    +

identity

  • identity(): this

  • Set this to the identity quaternion +Equivalent to Quat.identity(this)

    +

    Returns this

    this

    +

invert

  • invert(): this

  • Inverts this +Equivalent to Quat.invert(this, this);

    +

    Returns this

    this

    +

mul

multiply

  • multiply(b: Readonly<Vec4Like>): this

  • Multiplies this by a Quat. +Equivalent to Quat.multiply(this, this, b);

    +

    Parameters

    Returns this

    this

    +

rotateX

  • rotateX(rad: number): this

  • Rotates this by the given angle about the X axis +Equivalent to Quat.rotateX(this, this, rad);

    +

    Parameters

    • rad: number

      angle (in radians) to rotate

      +

    Returns this

    this

    +

rotateY

  • rotateY(rad: number): this

  • Rotates this by the given angle about the Y axis +Equivalent to Quat.rotateY(this, this, rad);

    +

    Parameters

    • rad: number

      angle (in radians) to rotate

      +

    Returns this

    this

    +

rotateZ

  • rotateZ(rad: number): this

  • Rotates this by the given angle about the Z axis +Equivalent to Quat.rotateZ(this, this, rad);

    +

    Parameters

    • rad: number

      angle (in radians) to rotate

      +

    Returns this

    this

    +

scale

  • scale(scale: number): Vec4Like

  • Scales this by a scalar number +Equivalent to Quat.scale(this, this, scale);

    +

    Parameters

    • scale: number

      amount to scale the vector by

      +

    Returns Vec4Like

    this

    +

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Quaternion Components

w

  • get w(): number

  • The w component of the quaternion. Equivalent to this[3];

    +

    Returns number

  • set w(value: number): void

  • Parameters

    • value: number

    Returns void

x

  • get x(): number

  • The x component of the quaternion. Equivalent to this[0];

    +

    Returns number

  • set x(value: number): void

  • Parameters

    • value: number

    Returns void

y

  • get y(): number

  • The y component of the quaternion. Equivalent to this[1];

    +

    Returns number

  • set y(value: number): void

  • Parameters

    • value: number

    Returns void

z

  • get z(): number

  • The z component of the quaternion. Equivalent to this[2];

    +

    Returns number

  • set z(value: number): void

  • Parameters

    • value: number

    Returns void

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Quat.

    +

Staticadd

StaticcalculateW

  • calculateW(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like

  • Calculates the W component of a quat from the X, Y, and Z components. +Assumes that quaternion is 1 unit in length. +Any existing W component will be ignored.

    +

    Parameters

    Returns Vec4Like

    out

    +

Staticclone

Staticconjugate

  • conjugate(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like

  • Calculates the conjugate of a quat +If the quaternion is normalized, this function is faster than quat.inverse and produces the same result.

    +

    Parameters

    Returns Vec4Like

    out

    +

Staticcopy

Staticcreate

  • create(): Quat

  • Creates a new identity quat

    +

    Returns Quat

    a new quaternion

    +

Staticdot

Staticequals

StaticexactEquals

  • exactEquals(a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): boolean

  • Returns whether the quaternions have exactly the same elements in the same position (when compared with ===)

    +

    Parameters

    Returns boolean

    True if the vectors are equal, false otherwise.

    +

Staticexp

StaticfromEuler

  • fromEuler(
        out: Vec4Like,
        x: number,
        y: number,
        z: number,
        order?: string,
    ): Vec4Like

  • Creates a quaternion from the given euler angle x, y, z.

    +

    Parameters

    • out: Vec4Like

      the receiving quaternion

      +
    • x: number

      Angle to rotate around X axis in degrees.

      +
    • y: number

      Angle to rotate around Y axis in degrees.

      +
    • z: number

      Angle to rotate around Z axis in degrees.

      +
    • Optionalorder: string

      Intrinsic order for conversion, default is zyx.

      +

    Returns Vec4Like

    out

    +

StaticfromMat3

  • fromMat3(out: Vec4Like, m: Readonly<Mat3Like>): Vec4Like

  • Creates a quaternion from the given 3x3 rotation matrix.

    +

    NOTE: The resultant quaternion is not normalized, so you should be sure +to re-normalize the quaternion yourself where necessary.

    +

    Parameters

    Returns Vec4Like

    out

    +

StaticfromValues

  • fromValues(x: number, y: number, z: number, w: number): Quat

  • Creates a new quat initialized with the given values

    +

    Parameters

    • x: number

      X component

      +
    • y: number

      Y component

      +
    • z: number

      Z component

      +
    • w: number

      W component

      +

    Returns Quat

    a new quaternion

    +

StaticgetAngle

StaticgetAxisAngle

  • getAxisAngle(out_axis: Vec3Like, q: Readonly<Vec4Like>): number

  • Gets the rotation axis and angle for a given +quaternion. If a quaternion is created with +setAxisAngle, this method will return the same +values as provided in the original parameter list +OR functionally equivalent values. +Example: The quaternion formed by axis [0, 0, 1] and +angle -90 is the same as the quaternion formed by +[0, 0, 1] and 270. This method favors the latter.

    +

    Parameters

    Returns number

    Angle, in radians, of the rotation

    +

Staticidentity

Staticinvert

Staticlen

Staticlength

Staticlerp

Staticln

Staticmag

Staticmagnitude

Staticmul

Staticmultiply

Staticnormalize

Staticpow

StaticrotateX

StaticrotateY

StaticrotateZ

StaticrotationTo

Staticscale

Staticset

  • set(out: Vec4Like, x: number, y: number, z: number, w: number): Vec4Like

  • Set the components of a Quat to the given values

    +

    Parameters

    • out: Vec4Like

      the receiving quaternion

      +
    • x: number

      X component

      +
    • y: number

      Y component

      +
    • z: number

      Z component

      +
    • w: number

      W component

      +

    Returns Vec4Like

    out

    +

StaticsetAxes

StaticsetAxisAngle

Staticslerp

Staticsqlerp

StaticsqrLen

StaticsquaredLength

  • squaredLength(a: Readonly<Vec4Like>): number

  • Calculates the squared length of a Quat

    +

    Parameters

    Returns number

    squared length of a

    +

Staticstr

  • str(a: Readonly<Vec4Like>): string

  • Returns a string representation of a quatenion

    +

    Parameters

    Returns string

    string representation of the vector

    +

Settings

Member Visibility

On This Page

Accessors
Constructor
Methods
Other
Quaternion Components
Static
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Quat2.html b/docs/classes/_runtime_math_gl-matrix.Quat2.html new file mode 100644 index 0000000..8c89e19 --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Quat2.html @@ -0,0 +1,421 @@ +Quat2 | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Quat2

Dual Quaternion

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

str +

Constructor

constructor +

Methods

copy +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Static

BYTE_LENGTH +add +clone +conjugate +copy +create +dot +equals +exactEquals +fromMat4 +fromRotation +fromRotationTranslation +fromRotationTranslationValues +fromTranslation +fromValues +getDual +getReal +getTranslation +identity +invert +len +length +lerp +mag +magnitude +mul +multiply +normalize +rotateAroundAxis +rotateByQuatAppend +rotateByQuatPrepend +rotateX +rotateY +rotateZ +scale +set +setDual +setReal +sqrLen +squaredLength +str +translate +

Accessors

str

  • get str(): string

  • A string representation of this +Equivalent to Quat2.str(this);

    +

    Returns string

Constructor

constructor

Methods

copy

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Quat2.

    +

Staticadd

Staticclone

  • clone(a: Quat2Like): Quat2

  • Creates a Quat2 quat initialized with values from an existing quaternion

    +

    Parameters

    Returns Quat2

    a new dual quaternion

    +

Staticconjugate

Staticcopy

Staticcreate

  • create(): Quat2

  • Creates a new identity Quat2

    +

    Returns Quat2

    a new dual quaternion [real -> rotation, dual -> translation]

    +

Staticdot

Staticequals

StaticexactEquals

StaticfromMat4

StaticfromRotation

StaticfromRotationTranslation

StaticfromRotationTranslationValues

  • fromRotationTranslationValues(
        x1: number,
        y1: number,
        z1: number,
        w1: number,
        x2: number,
        y2: number,
        z2: number,
    ): Quat2

  • Creates a new Quat2 from the given values (quat and translation)

    +

    Parameters

    • x1: number

      X component (rotation)

      +
    • y1: number

      Y component (rotation)

      +
    • z1: number

      Z component (rotation)

      +
    • w1: number

      W component (rotation)

      +
    • x2: number

      X component (translation)

      +
    • y2: number

      Y component (translation)

      +
    • z2: number

      Z component (translation)

      +

    Returns Quat2

    a new dual quaternion

    +

StaticfromTranslation

StaticfromValues

  • fromValues(
        x1: number,
        y1: number,
        z1: number,
        w1: number,
        x2: number,
        y2: number,
        z2: number,
        w2: number,
    ): Quat2

  • Creates a new Quat2 initialized with the given values

    +

    Parameters

    • x1: number

      1st X component

      +
    • y1: number

      1st Y component

      +
    • z1: number

      1st Z component

      +
    • w1: number

      1st W component

      +
    • x2: number

      2nd X component

      +
    • y2: number

      2nd Y component

      +
    • z2: number

      2nd Z component

      +
    • w2: number

      2nd W component

      +

    Returns Quat2

    a new dual quaternion

    +

StaticgetDual

StaticgetReal

StaticgetTranslation

Staticidentity

Staticinvert

Staticlen

Staticlength

Staticlerp

Staticmag

Staticmagnitude

Staticmul

Staticmultiply

Staticnormalize

StaticrotateAroundAxis

StaticrotateByQuatAppend

StaticrotateByQuatPrepend

StaticrotateX

StaticrotateY

StaticrotateZ

Staticscale

Staticset

  • set(
        out: Quat2Like,
        x1: number,
        y1: number,
        z1: number,
        w1: number,
        x2: number,
        y2: number,
        z2: number,
        w2: number,
    ): Quat2Like

  • Set the components of a Quat2 to the given values

    +

    Parameters

    • out: Quat2Like

      the receiving vector

      +
    • x1: number

      1st X component

      +
    • y1: number

      1st Y component

      +
    • z1: number

      1st Z component

      +
    • w1: number

      1st W component

      +
    • x2: number

      2nd X component

      +
    • y2: number

      2nd Y component

      +
    • z2: number

      2nd Z component

      +
    • w2: number

      2nd W component

      +

    Returns Quat2Like

    out

    +

StaticsetDual

StaticsetReal

StaticsqrLen

StaticsquaredLength

  • squaredLength(a: Readonly<Quat2Like>): number

  • Calculates the squared length of a Quat2

    +

    Parameters

    Returns number

    squared length of a

    +

Staticstr

  • str(a: Readonly<Quat2Like>): string

  • Returns a string representation of a Quat2

    +

    Parameters

    Returns string

    string representation of the vector

    +

Statictranslate

Settings

Member Visibility

On This Page

Accessors
Constructor
Methods
Other
Static
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Vec2.html b/docs/classes/_runtime_math_gl-matrix.Vec2.html new file mode 100644 index 0000000..08eeee4 --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Vec2.html @@ -0,0 +1,518 @@ +Vec2 | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Vec2

2 Dimensional Vector

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

mag +magnitude +sqrMag +squaredMagnitude +str +

Color Components

g +r +

Constructor

constructor +

Methods

abs +add +copy +dist +distance +div +divide +dot +invert +mul +multiply +negate +normalize +scale +scaleAndAdd +sqrDist +squaredDistance +sub +subtract +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Static

BYTE_LENGTH +abs +add +angle +ceil +clone +copy +create +cross +dist +distance +div +divide +dot +equals +exactEquals +floor +fromValues +inverse +len +length +lerp +mag +magnitude +max +min +mul +multiply +negate +normalize +rotate +round +scale +scaleAndAdd +set +sqrDist +sqrLen +squaredDistance +squaredLength +str +sub +subtract +transformMat2 +transformMat2d +transformMat3 +transformMat4 +zero +

Vector Components

x +y +

Accessors

mag

magnitude

  • get magnitude(): number

  • The magnitude (length) of this. +Equivalent to Vec2.magnitude(this);

    +

    Magnitude is used because the length attribute is already defined by +TypedArrays to mean the number of elements in the array.

    +

    Returns number

sqrMag

squaredMagnitude

  • get squaredMagnitude(): number

  • The squared magnitude (length) of this. +Equivalent to Vec2.squaredMagnitude(this);

    +

    Returns number

str

  • get str(): string

  • A string representation of this +Equivalent to Vec2.str(this);

    +

    Returns string

Color Components

g

  • get g(): number

  • The g component of the vector. Equivalent to this[1];

    +

    Returns number

  • set g(value: number): void

  • Parameters

    • value: number

    Returns void

r

  • get r(): number

  • The r component of the vector. Equivalent to this[0];

    +

    Returns number

  • set r(value: number): void

  • Parameters

    • value: number

    Returns void

Constructor

constructor

Methods

abs

  • abs(): this

  • Sets each component of this to it's absolute value. +Equivalent to Vec2.abs(this, this);

    +

    Returns this

    this

    +

add

copy

dist

distance

  • distance(b: Readonly<Vec2Like>): number

  • Calculates the Euclidean distance between another Vec2 and this. +Equivalent to Vec2.distance(this, b);

    +

    Parameters

    Returns number

    Distance between this and b

    +

div

divide

  • divide(b: Readonly<Vec2Like>): this

  • Divides this by a Vec2. +Equivalent to Vec2.divide(this, this, b);

    +

    Parameters

    Returns this

    this

    +

dot

  • dot(b: Readonly<Vec2Like>): number

  • Calculates the dot product of this and another Vec2. +Equivalent to Vec2.dot(this, b);

    +

    Parameters

    Returns number

    Dot product of this and b

    +

invert

  • invert(): this

  • Inverts the components of this. +Equivalent to Vec2.inverse(this, this);

    +

    Returns this

    this

    +

mul

multiply

  • multiply(b: Readonly<Vec2Like>): this

  • Multiplies this by a Vec2. +Equivalent to Vec2.multiply(this, this, b);

    +

    Parameters

    Returns this

    this

    +

negate

  • negate(): this

  • Negates the components of this. +Equivalent to Vec2.negate(this, this);

    +

    Returns this

    this

    +

normalize

  • normalize(): this

  • Normalize this. +Equivalent to Vec2.normalize(this, this);

    +

    Returns this

    this

    +

scale

  • scale(b: number): this

  • Scales this by a scalar number. +Equivalent to Vec2.scale(this, this, b);

    +

    Parameters

    • b: number

      Amount to scale this by

      +

    Returns this

    this

    +

scaleAndAdd

  • scaleAndAdd(b: Readonly<Vec2Like>, scale: number): this

  • Calculates this scaled by a scalar value then adds the result to this. +Equivalent to Vec2.scaleAndAdd(this, this, b, scale);

    +

    Parameters

    • b: Readonly<Vec2Like>

      The vector to add to this

      +
    • scale: number

      The amount to scale b by before adding

      +

    Returns this

    this

    +

sqrDist

squaredDistance

  • squaredDistance(b: Readonly<Vec2Like>): number

  • Calculates the squared Euclidean distance between another Vec2 and this. +Equivalent to Vec2.squaredDistance(this, b);

    +

    Parameters

    Returns number

    Squared distance between this and b

    +

sub

subtract

  • subtract(b: Readonly<Vec2Like>): this

  • Subtracts a Vec2 from this. +Equivalent to Vec2.subtract(this, this, b);

    +

    Parameters

    Returns this

    this

    +

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Vec2.

    +

Staticabs

Staticadd

Staticangle

Staticceil

Staticclone

Staticcopy

Staticcreate

  • create(): Vec2

  • Creates a new, empty Vec2

    +

    Returns Vec2

    A new 2D vector

    +

Staticcross

Staticdist

Staticdistance

Staticdiv

Staticdivide

Staticdot

Staticequals

StaticexactEquals

  • exactEquals(a: Readonly<Vec2Like>, b: Readonly<Vec2Like>): boolean

  • Returns whether the vectors have exactly the same elements in the same position (when compared with ===)

    +

    Parameters

    Returns boolean

    true if the vectors components are ===, false otherwise.

    +

Staticfloor

StaticfromValues

  • fromValues(x: number, y: number): Vec2

  • Creates a new Vec2 initialized with the given values

    +

    Parameters

    • x: number

      X component

      +
    • y: number

      Y component

      +

    Returns Vec2

    A new 2D vector

    +

Staticinverse

Staticlen

Staticlength

Staticlerp

Staticmag

Staticmagnitude

  • magnitude(a: Readonly<Vec2Like>): number

  • Calculates the magnitude (length) of a Vec2

    +

    Parameters

    Returns number

    Magnitude of a

    +

Staticmax

Staticmin

Staticmul

Staticmultiply

Staticnegate

Staticnormalize

Staticrotate

Staticround

Staticscale

StaticscaleAndAdd

Staticset

  • set(out: Vec2Like, x: number, y: number): Vec2Like

  • Set the components of a Vec2 to the given values

    +

    Parameters

    • out: Vec2Like

      The receiving vector

      +
    • x: number

      X component

      +
    • y: number

      Y component

      +

    Returns Vec2Like

    out

    +

StaticsqrDist

StaticsqrLen

StaticsquaredDistance

StaticsquaredLength

  • squaredLength(a: Readonly<Vec2Like>): number

  • Calculates the squared length of a Vec2

    +

    Parameters

    Returns number

    Squared length of a

    +

Staticstr

  • str(a: Readonly<Vec2Like>): string

  • Returns a string representation of a vector

    +

    Parameters

    Returns string

    String representation of the vector

    +

Staticsub

Staticsubtract

StatictransformMat2

StatictransformMat2d

StatictransformMat3

StatictransformMat4

Staticzero

Vector Components

x

  • get x(): number

  • The x component of the vector. Equivalent to this[0];

    +

    Returns number

  • set x(value: number): void

  • Parameters

    • value: number

    Returns void

y

  • get y(): number

  • The y component of the vector. Equivalent to this[1];

    +

    Returns number

  • set y(value: number): void

  • Parameters

    • value: number

    Returns void

Settings

Member Visibility

On This Page

Accessors
Color Components
Constructor
Methods
Other
Static
Vector Components
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Vec3.html b/docs/classes/_runtime_math_gl-matrix.Vec3.html new file mode 100644 index 0000000..b35c52d --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Vec3.html @@ -0,0 +1,549 @@ +Vec3 | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Vec3

3 Dimensional Vector

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

mag +magnitude +sqrMag +squaredMagnitude +str +

Color Components

b +g +r +

Constructor

constructor +

Methods

abs +add +copy +dist +distance +div +divide +dot +invert +mul +multiply +negate +normalize +scale +scaleAndAdd +sqrDist +squaredDistance +sub +subtract +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Static

BYTE_LENGTH +abs +add +angle +bezier +ceil +clone +copy +create +cross +dist +distance +div +divide +dot +equals +exactEquals +floor +fromValues +hermite +inverse +len +length +lerp +mag +magnitude +max +min +mul +multiply +negate +normalize +rotateX +rotateY +rotateZ +scale +scaleAndAdd +set +slerp +sqrDist +sqrLen +squaredDistance +squaredLength +str +sub +subtract +transformMat3 +transformMat4 +transformQuat +zero +

Vector Components

x +y +z +

Accessors

mag

magnitude

  • get magnitude(): number

  • The magnitude (length) of this. +Equivalent to Vec3.magnitude(this);

    +

    Magnitude is used because the length attribute is already defined by +TypedArrays to mean the number of elements in the array.

    +

    Returns number

sqrMag

squaredMagnitude

  • get squaredMagnitude(): number

  • The squared magnitude (length) of this. +Equivalent to Vec3.squaredMagnitude(this);

    +

    Returns number

str

  • get str(): string

  • A string representation of this +Equivalent to Vec3.str(this);

    +

    Returns string

Color Components

b

  • get b(): number

  • The b component of the vector. Equivalent to this[2];

    +

    Returns number

  • set b(value: number): void

  • Parameters

    • value: number

    Returns void

g

  • get g(): number

  • The g component of the vector. Equivalent to this[1];

    +

    Returns number

  • set g(value: number): void

  • Parameters

    • value: number

    Returns void

r

  • get r(): number

  • The r component of the vector. Equivalent to this[0];

    +

    Returns number

  • set r(value: number): void

  • Parameters

    • value: number

    Returns void

Constructor

constructor

Methods

abs

  • abs(): this

  • Sets each component of this to its absolute value. +Equivalent to Vec3.abs(this, this);

    +

    Returns this

    this

    +

add

copy

dist

distance

  • distance(b: Readonly<Vec3Like>): number

  • Calculates the Euclidean distance between another Vec3 and this. +Equivalent to Vec3.distance(this, b);

    +

    Parameters

    Returns number

    Distance between this and b

    +

div

divide

  • divide(b: Readonly<Vec3Like>): this

  • Divides this by a Vec3. +Equivalent to Vec3.divide(this, this, b);

    +

    Parameters

    Returns this

    this

    +

dot

  • dot(b: Readonly<Vec3Like>): number

  • Calculates the dot product of this and another Vec3. +Equivalent to Vec3.dot(this, b);

    +

    Parameters

    Returns number

    Dot product of this and b

    +

invert

  • invert(): this

  • Inverts the components of this. +Equivalent to Vec3.inverse(this, this);

    +

    Returns this

    this

    +

mul

multiply

  • multiply(b: Readonly<Vec3Like>): this

  • Multiplies this by a Vec3. +Equivalent to Vec3.multiply(this, this, b);

    +

    Parameters

    Returns this

    this

    +

negate

  • negate(): this

  • Negates the components of this. +Equivalent to Vec3.negate(this, this);

    +

    Returns this

    this

    +

normalize

  • normalize(): this

  • Normalize this. +Equivalent to Vec3.normalize(this, this);

    +

    Returns this

    this

    +

scale

  • scale(b: number): this

  • Scales this by a scalar number. +Equivalent to Vec3.scale(this, this, b);

    +

    Parameters

    • b: number

      Amount to scale this by

      +

    Returns this

    this

    +

scaleAndAdd

  • scaleAndAdd(b: Readonly<Vec3Like>, scale: number): this

  • Calculates this scaled by a scalar value then adds the result to this. +Equivalent to Vec3.scaleAndAdd(this, this, b, scale);

    +

    Parameters

    • b: Readonly<Vec3Like>

      The vector to add to this

      +
    • scale: number

      The amount to scale b by before adding

      +

    Returns this

    this

    +

sqrDist

squaredDistance

  • squaredDistance(b: Readonly<Vec3Like>): number

  • Calculates the squared Euclidean distance between another Vec3 and this. +Equivalent to Vec3.squaredDistance(this, b);

    +

    Parameters

    Returns number

    Squared distance between this and b

    +

sub

subtract

  • subtract(b: Readonly<Vec3Like>): this

  • Subtracts a Vec3 from this. +Equivalent to Vec3.subtract(this, this, b);

    +

    Parameters

    Returns this

    this

    +

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Vec3.

    +

Staticabs

Staticadd

Staticangle

Staticbezier

Staticceil

Staticclone

Staticcopy

Staticcreate

  • create(): Vec3

  • Creates a new, empty vec3

    +

    Returns Vec3

    a new 3D vector

    +

Staticcross

Staticdist

Staticdistance

Staticdiv

Staticdivide

Staticdot

Staticequals

StaticexactEquals

  • exactEquals(a: Readonly<Vec3Like>, b: Readonly<Vec3Like>): boolean

  • Returns whether the vectors have exactly the same elements in the same position (when compared with ===)

    +

    Parameters

    Returns boolean

    True if the vectors are equal, false otherwise.

    +

Staticfloor

StaticfromValues

  • fromValues(x: number, y: number, z: number): Vec3

  • Creates a new vec3 initialized with the given values

    +

    Parameters

    • x: number

      X component

      +
    • y: number

      Y component

      +
    • z: number

      Z component

      +

    Returns Vec3

    a new 3D vector

    +

Statichermite

Staticinverse

Staticlen

Staticlength

Staticlerp

Staticmag

Staticmagnitude

  • magnitude(a: Readonly<Vec3Like>): number

  • Calculates the magnitude (length) of a Vec3

    +

    Parameters

    Returns number

    Magnitude of a

    +

Staticmax

Staticmin

Staticmul

Staticmultiply

Staticnegate

Staticnormalize

StaticrotateX

StaticrotateY

StaticrotateZ

Staticscale

StaticscaleAndAdd

Staticset

  • set(out: Vec3Like, x: number, y: number, z: number): Vec3Like

  • Set the components of a vec3 to the given values

    +

    Parameters

    • out: Vec3Like

      the receiving vector

      +
    • x: number

      X component

      +
    • y: number

      Y component

      +
    • z: number

      Z component

      +

    Returns Vec3Like

    out

    +

Staticslerp

StaticsqrDist

StaticsqrLen

StaticsquaredDistance

StaticsquaredLength

  • squaredLength(a: Readonly<Vec3Like>): number

  • Calculates the squared length of a vec3

    +

    Parameters

    Returns number

    squared length of a

    +

Staticstr

  • str(a: Readonly<Vec3Like>): string

  • Returns a string representation of a vector

    +

    Parameters

    Returns string

    string representation of the vector

    +

Staticsub

Staticsubtract

StatictransformMat3

StatictransformMat4

StatictransformQuat

Staticzero

Vector Components

x

  • get x(): number

  • The x component of the vector. Equivalent to this[0];

    +

    Returns number

  • set x(value: number): void

  • Parameters

    • value: number

    Returns void

y

  • get y(): number

  • The y component of the vector. Equivalent to this[1];

    +

    Returns number

  • set y(value: number): void

  • Parameters

    • value: number

    Returns void

z

  • get z(): number

  • The z component of the vector. Equivalent to this[2];

    +

    Returns number

  • set z(value: number): void

  • Parameters

    • value: number

    Returns void

Settings

Member Visibility

On This Page

Accessors
Color Components
Constructor
Methods
Other
Static
Vector Components
\ No newline at end of file diff --git a/docs/classes/_runtime_math_gl-matrix.Vec4.html b/docs/classes/_runtime_math_gl-matrix.Vec4.html new file mode 100644 index 0000000..f698ac3 --- /dev/null +++ b/docs/classes/_runtime_math_gl-matrix.Vec4.html @@ -0,0 +1,495 @@ +Vec4 | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Vec4

4 Dimensional Vector

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [index: number]: number

Accessors

mag +magnitude +str +

Color Components

a +b +g +r +

Constructor

constructor +

Methods

abs +add +copy +dist +distance +div +divide +dot +invert +mul +multiply +negate +normalize +scale +scaleAndAdd +sqrDist +squaredDistance +sub +subtract +

Other

[toStringTag] +buffer +byteLength +byteOffset +BYTES_PER_ELEMENT +length +BYTES_PER_ELEMENT +[iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +from +of +

Static

BYTE_LENGTH +abs +add +ceil +clone +copy +create +cross +dist +distance +div +divide +dot +equals +exactEquals +floor +fromValues +inverse +len +length +lerp +mag +magnitude +max +min +mul +multiply +negate +normalize +round +scale +scaleAndAdd +set +sqrDist +sqrLen +squaredDistance +squaredLength +str +sub +subtract +transformMat4 +transformQuat +zero +

Vector Components

w +x +y +z +

Accessors

mag

magnitude

  • get magnitude(): number

  • The magnitude (length) of this. +Equivalent to Vec4.magnitude(this);

    +

    Magnitude is used because the length attribute is already defined by +TypedArrays to mean the number of elements in the array.

    +

    Returns number

str

  • get str(): string

  • A string representation of this +Equivalent to Vec4.str(this);

    +

    Returns string

Color Components

a

  • get a(): number

  • The a component of the vector. Equivalent to this[3];

    +

    Returns number

  • set a(value: number): void

  • Parameters

    • value: number

    Returns void

b

  • get b(): number

  • The b component of the vector. Equivalent to this[2];

    +

    Returns number

  • set b(value: number): void

  • Parameters

    • value: number

    Returns void

g

  • get g(): number

  • The g component of the vector. Equivalent to this[1];

    +

    Returns number

  • set g(value: number): void

  • Parameters

    • value: number

    Returns void

r

  • get r(): number

  • The r component of the vector. Equivalent to this[0];

    +

    Returns number

  • set r(value: number): void

  • Parameters

    • value: number

    Returns void

Constructor

constructor

Methods

abs

  • abs(): this

  • Sets each component of this to it's absolute value. +Equivalent to Vec4.abs(this, this);

    +

    Returns this

    this

    +

add

copy

dist

distance

  • distance(b: Readonly<Vec4Like>): number

  • Calculates the Euclidean distance between another Vec4 and this. +Equivalent to Vec4.distance(this, b);

    +

    Parameters

    Returns number

    Distance between this and b

    +

div

divide

  • divide(b: Readonly<Vec4Like>): this

  • Divides this by a Vec4. +Equivalent to Vec4.divide(this, this, b);

    +

    Parameters

    Returns this

    this

    +

dot

  • dot(b: Readonly<Vec4Like>): number

  • Calculates the dot product of this and another Vec4. +Equivalent to Vec4.dot(this, b);

    +

    Parameters

    Returns number

    Dot product of this and b

    +

invert

  • invert(): this

  • Inverts the components of this. +Equivalent to Vec4.inverse(this, this);

    +

    Returns this

    this

    +

mul

multiply

  • multiply(b: Readonly<Vec4Like>): this

  • Multiplies this by a Vec4. +Equivalent to Vec4.multiply(this, this, b);

    +

    Parameters

    Returns this

    this

    +

negate

  • negate(): this

  • Negates the components of this. +Equivalent to Vec4.negate(this, this);

    +

    Returns this

    this

    +

normalize

  • normalize(): this

  • Normalize this. +Equivalent to Vec4.normalize(this, this);

    +

    Returns this

    this

    +

scale

  • scale(b: number): this

  • Scales this by a scalar number. +Equivalent to Vec4.scale(this, this, b);

    +

    Parameters

    • b: number

      Amount to scale this by

      +

    Returns this

    this

    +

scaleAndAdd

  • scaleAndAdd(b: Readonly<Vec4Like>, scale: number): this

  • Calculates this scaled by a scalar value then adds the result to this. +Equivalent to Vec4.scaleAndAdd(this, this, b, scale);

    +

    Parameters

    • b: Readonly<Vec4Like>

      The vector to add to this

      +
    • scale: number

      The amount to scale b by before adding

      +

    Returns this

    this

    +

sqrDist

squaredDistance

  • squaredDistance(b: Readonly<Vec4Like>): number

  • Calculates the squared Euclidean distance between another Vec4 and this. +Equivalent to Vec4.squaredDistance(this, b);

    +

    Parameters

    Returns number

    Squared distance between this and b

    +

sub

subtract

  • subtract(b: Readonly<Vec4Like>): this

  • Subtracts a Vec4 from this. +Equivalent to Vec4.subtract(this, this, b);

    +

    Parameters

    Returns this

    this

    +

Other

Readonly[toStringTag]

"[toStringTag]": "Float32Array"

Readonlybuffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

+

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

+

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

+

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

Readonlylength

length: number

The length of the array.

+

Static ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

+

[iterator]

at

  • at(index: number): number

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

      +

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

    +

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the +length of the array.

      +
    • start: number

      If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

      +
    • Optionalend: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

entries

  • entries(): ArrayIterator<[number, number]>

  • Returns an array of key, value pairs for every entry in the array

    +

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether all the members of an array satisfy the specified test.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

fill

  • fill(value: number, start?: number, end?: number): this

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: number

      value to fill array section with

      +
    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

      +
    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as +length+end.

      +

    Returns this

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Returns the elements of an array that meet the condition specified in a callback function.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number

  • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

    +

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      +
    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

      +

    Returns number

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

  • Performs the specified action for each element in an array.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    +

    Parameters

    • searchElement: number

      The element to search for.

      +
    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

      +

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    +

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

      +

    Returns string

keys

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • Returns the index of the last occurrence of a value in an array.

    +

    Parameters

    • searchElement: number

      The value to locate in the array.

      +
    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      +

    Returns number

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

    +

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns Float32Array<ArrayBuffer>

reduce

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reduceRight

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U

  • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

    +

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

      +
    • initialValue: U

      If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

      +

    Returns U

reverse

  • reverse(): this

  • Reverses the elements in an Array.

    +

    Returns this

set

  • set(array: ArrayLike<number>, offset?: number): void

  • Sets a value or an array of values.

    +

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

      +
    • Optionaloffset: number

      The index in the current array at which the values are to be written.

      +

    Returns void

slice

  • slice(start?: number, end?: number): Float32Array<ArrayBuffer>

  • Returns a section of an array.

    +

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

      +
    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      +

    Returns Float32Array<ArrayBuffer>

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    +

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

      +
    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

      +

    Returns boolean

sort

  • sort(compareFn?: (a: number, b: number) => number): this

  • Sorts an array.

    +

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

      +
      [11,2,22,1].sort((a, b) => a - b)
+
      + +

    Returns this

subarray

  • subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

    +

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

      +
    • Optionalend: number

      The index of the end of the array.

      +

    Returns Float32Array<ArrayBuffer>

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    +

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    +

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    +

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    +

    Returns ArrayIterator<number>

Staticfrom

  • from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

      +
    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

  • from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Parameters

    • arrayLike: Iterable<number, any, any>

      An array-like or iterable object to convert to an array.

      +

    Returns Float32Array<ArrayBuffer>

  • from<T>(
        arrayLike: Iterable<T, any, any>,
        mapfn?: (v: T, k: number) => number,
        thisArg?: any,
    ): Float32Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    +

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T, any, any>

      An array-like or iterable object to convert to an array.

      +
    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

      +
    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array<ArrayBuffer>

Staticof

  • of(...items: number[]): Float32Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    +

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

      +

    Returns Float32Array<ArrayBuffer>

Static

StaticBYTE_LENGTH

  • get BYTE_LENGTH(): number

  • Returns number

    The number of bytes in a Vec4.

    +

Staticabs

Staticadd

Staticceil

Staticclone

  • clone(a: Vec4Like): Vec4

  • Creates a new Vec4 initialized with values from an existing vector

    +

    Parameters

    Returns Vec4

    a new 4D vector

    +

Staticcopy

Staticcreate

  • create(): Vec4

  • Creates a new, empty Vec4

    +

    Returns Vec4

    a new 4D vector

    +

Staticcross

Staticdist

Staticdistance

Staticdiv

Staticdivide

Staticdot

Staticequals

StaticexactEquals

  • exactEquals(a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): boolean

  • Returns whether the vectors have exactly the same elements in the same position (when compared with ===)

    +

    Parameters

    Returns boolean

    True if the vectors are equal, false otherwise.

    +

Staticfloor

StaticfromValues

  • fromValues(x: number, y: number, z: number, w: number): Vec4

  • Creates a new Vec4 initialized with the given values

    +

    Parameters

    • x: number

      X component

      +
    • y: number

      Y component

      +
    • z: number

      Z component

      +
    • w: number

      W component

      +

    Returns Vec4

    a new 4D vector

    +

Staticinverse

Staticlen

Staticlength

Staticlerp

Staticmag

Staticmagnitude

Staticmax

Staticmin

Staticmul

Staticmultiply

Staticnegate

Staticnormalize

Staticround

Staticscale

StaticscaleAndAdd

Staticset

  • set(out: Vec4Like, x: number, y: number, z: number, w: number): Vec4Like

  • Set the components of a Vec4 to the given values

    +

    Parameters

    • out: Vec4Like

      the receiving vector

      +
    • x: number

      X component

      +
    • y: number

      Y component

      +
    • z: number

      Z component

      +
    • w: number

      W component

      +

    Returns Vec4Like

    out

    +

StaticsqrDist

StaticsqrLen

StaticsquaredDistance

StaticsquaredLength

  • squaredLength(a: Readonly<Vec4Like>): number

  • Calculates the squared length of a Vec4

    +

    Parameters

    Returns number

    squared length of a

    +

Staticstr

  • str(a: Readonly<Vec4Like>): string

  • Returns a string representation of a Vec4

    +

    Parameters

    Returns string

    string representation of the vector

    +

Staticsub

Staticsubtract

StatictransformMat4

StatictransformQuat

Staticzero

Vector Components

w

  • get w(): number

  • The w component of the vector. Equivalent to this[3];

    +

    Returns number

  • set w(value: number): void

  • Parameters

    • value: number

    Returns void

x

  • get x(): number

  • The x component of the vector. Equivalent to this[0];

    +

    Returns number

  • set x(value: number): void

  • Parameters

    • value: number

    Returns void

y

  • get y(): number

  • The y component of the vector. Equivalent to this[1];

    +

    Returns number

  • set y(value: number): void

  • Parameters

    • value: number

    Returns void

z

  • get z(): number

  • The z component of the vector. Equivalent to this[2];

    +

    Returns number

  • set z(value: number): void

  • Parameters

    • value: number

    Returns void

Settings

Member Visibility

On This Page

Accessors
Color Components
Constructor
Methods
Other
Static
Vector Components
\ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer_array-object.ArrayObjectStore.html b/docs/classes/_runtime_svelte_store_reducer_array-object.ArrayObjectStore.html new file mode 100644 index 0000000..2f59ce7 --- /dev/null +++ b/docs/classes/_runtime_svelte_store_reducer_array-object.ArrayObjectStore.html @@ -0,0 +1,53 @@ +ArrayObjectStore | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class ArrayObjectStore<T>

Type Parameters

+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Accessors

_data +dataReducer +length +EntryStore +

Methods

[iterator] +clearEntries +createEntry +deleteEntry +duplicateEntry +findEntry +getEntry +set +subscribe +toJSON +updateSubscribers +

Constructors

constructor

Accessors

Protected_data

  • get _data(): T[]
  • Protected

    Returns T[]

    The internal data array tracked allowing child classes direct access.

    +

dataReducer

length

  • get length(): number

  • Returns number

    The length of all data.

    +

StaticEntryStore

Methods

[iterator]

  • "[iterator]"(): Generator<T, void, unknown>

  • Provide an iterator for public access to entry stores.

    +

    Returns Generator<T, void, unknown>

    Yields

clearEntries

  • clearEntries(): void

  • Removes all child store entries.

    +

    Returns void

createEntry

  • createEntry(entryData?: object): T

  • Creates a new store from given data.

    +

    Parameters

    • OptionalentryData: object

    Returns T

    The store

    +

deleteEntry

  • deleteEntry(id: string): boolean

  • Deletes a given entry store by ID from this world setting array store instance.

    +

    Parameters

    • id: string

      ID of entry to delete.

      +

    Returns boolean

    Delete operation successful.

    +

duplicateEntry

  • duplicateEntry(id: string): any

  • Duplicates an entry store by the given ID.

    +

    Parameters

    • id: string

      UUIDv4 string.

      +

    Returns any

    Instance of StoreClass.

    +

findEntry

  • findEntry(predicate: (arg0: T) => void | T): void | T

  • Find an entry in the backing child store array.

    +

    Parameters

    • predicate: (arg0: T) => void | T

      A predicate function

      +

    Returns void | T

    Found entry in array or undefined.

    +

getEntry

  • getEntry(id: string): void | T

  • Finds an entry store instance by 'id' / UUIDv4.

    +

    Parameters

    • id: string

      A UUIDv4 string.

      +

    Returns void | T

    Entry store instance.

    +

set

  • set(updateList: T[]): void

  • Sets the children store data by 'id', adds new entry store instances, or removes entries that are no longer in the +update list.

    +

    Parameters

    • updateList: T[]

    Returns void

subscribe

toJSON

  • toJSON(): T[]

  • Returns T[]

updateSubscribers

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
\ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStore.html b/docs/classes/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStore.html new file mode 100644 index 0000000..71b9c65 --- /dev/null +++ b/docs/classes/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStore.html @@ -0,0 +1,55 @@ +CrudArrayObjectStore | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class CrudArrayObjectStore<T>

Type Parameters

+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Accessors

_data +dataReducer +length +EntryStore +

Methods

[iterator] +clearEntries +createEntry +deleteEntry +duplicateEntry +findEntry +getEntry +set +subscribe +toJSON +updateSubscribers +

Constructors

constructor

Accessors

Protected_data

  • get _data(): T[]
  • Protected

    Returns T[]

    The internal data array tracked allowing child classes direct access.

    +

dataReducer

length

  • get length(): number

  • Returns number

    The length of all data.

    +

StaticEntryStore

Methods

[iterator]

clearEntries

createEntry

  • createEntry(entryData?: object): T

  • Creates a new store from given data.

    +

    Parameters

    • OptionalentryData: object

    Returns T

    The store

    +

deleteEntry

  • deleteEntry(id: string): boolean

  • Deletes a given entry store by ID from this world setting array store instance.

    +

    Parameters

    • id: string

      ID of entry to delete.

      +

    Returns boolean

    Delete operation successful.

    +

duplicateEntry

  • duplicateEntry(id: string): any

  • Duplicates an entry store by the given ID.

    +

    Parameters

    • id: string

      UUIDv4 string.

      +

    Returns any

    Instance of StoreClass.

    +

findEntry

  • findEntry(predicate: (arg0: T) => void | T): void | T

  • Find an entry in the backing child store array.

    +

    Parameters

    • predicate: (arg0: T) => void | T

      A predicate function

      +

    Returns void | T

    Found entry in array or undefined.

    +

getEntry

  • getEntry(id: string): void | T

  • Finds an entry store instance by 'id' / UUIDv4.

    +

    Parameters

    • id: string

      A UUIDv4 string.

      +

    Returns void | T

    Entry store instance.

    +

set

  • set(updateList: T[]): void

  • Sets the children store data by 'id', adds new entry store instances, or removes entries that are no longer in the +update list.

    +

    Parameters

    • updateList: T[]

    Returns void

subscribe

toJSON

updateSubscribers

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
\ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer_array-object.ObjectEntryStore.html b/docs/classes/_runtime_svelte_store_reducer_array-object.ObjectEntryStore.html new file mode 100644 index 0000000..6e420ac --- /dev/null +++ b/docs/classes/_runtime_svelte_store_reducer_array-object.ObjectEntryStore.html @@ -0,0 +1,19 @@ +ObjectEntryStore | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class ObjectEntryStore

Provides a base implementation for store entries in ArrayObjectStore.

+

In particular providing the required getting / accessor for the 'id' property.

+

Constructors

constructor +

Accessors

_data +id +

Methods

_updateSubscribers +subscribe +toJSON +duplicate +

Constructors

constructor

Accessors

Protected_data

  • get _data(): any
  • Protected

    Returns any

    The object data tracked by this store.

    +

id

  • get id(): string

  • Returns string

    The ID attribute in object data tracked by this store.

    +

Methods

Protected_updateSubscribers

  • _updateSubscribers(): void
  • Protected

    Returns void

subscribe

toJSON

  • toJSON(): any

  • Returns any

Staticduplicate

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
\ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web-storage.TJSLocalStorage.html b/docs/classes/_runtime_svelte_store_web-storage.TJSLocalStorage.html new file mode 100644 index 0000000..871ae59 --- /dev/null +++ b/docs/classes/_runtime_svelte_store_web-storage.TJSLocalStorage.html @@ -0,0 +1,50 @@ +TJSLocalStorage | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSLocalStorage

Provides a TJSWebStorage instance for standard browser local storage use cases.

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Methods

entries +getItem +getStore +hasStore +keys +setItem +stores +swapItemBoolean +

Constructors

constructor

Methods

entries

getItem

  • getItem(key: string, defaultValue?: any): any

  • Get value from the storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: any

      A default value to return if key not present in session storage.

      +

    Returns any

    Value from session storage or if not defined any default value provided.

    +

getStore

  • getStore<T>(
        key: string,
        defaultValue?: T,
        storageStores?: StorageStores,
    ): Writable<T>

  • Returns the backing Svelte store for the given key; potentially sets a default value if the key +is not already set.

    +

    Type Parameters

    • T

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: T

      A default value to return if key not present in session storage.

      +
    • OptionalstorageStores: StorageStores

      Additional store creation options.

      +

    Returns Writable<T>

    The Svelte store for this key.

    +

hasStore

  • hasStore(key: string): boolean

  • Returns whether a store has already been created for the given key.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +

    Returns boolean

keys

  • keys(regex?: RegExp): IterableIterator<string, any, any>

  • Returns an iterable for the session storage keys from existing stores.

    +

    Parameters

    • Optionalregex: RegExp

      Optional regular expression to filter by storage keys.

      +

    Returns IterableIterator<string, any, any>

    Iterable iterator of session storage keys.

    +

    Yields

setItem

  • setItem(key: string, value: any): void

  • Sets the value for the given key in storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • value: any

      A value to set for this key.

      +

    Returns void

stores

swapItemBoolean

  • swapItemBoolean(key: string, defaultValue?: boolean): boolean

  • Convenience method to swap a boolean value stored in storage API updating the associated store value.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: boolean

      A default value to return if key not present in session storage.

      +

    Returns boolean

    The boolean swap for the given key.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web-storage.TJSSessionStorage.html b/docs/classes/_runtime_svelte_store_web-storage.TJSSessionStorage.html new file mode 100644 index 0000000..e44f3dc --- /dev/null +++ b/docs/classes/_runtime_svelte_store_web-storage.TJSSessionStorage.html @@ -0,0 +1,50 @@ +TJSSessionStorage | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSSessionStorage

Provides a TJSWebStorage instance for standard browser session storage use cases.

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Methods

entries +getItem +getStore +hasStore +keys +setItem +stores +swapItemBoolean +

Constructors

constructor

Methods

entries

getItem

  • getItem(key: string, defaultValue?: any): any

  • Get value from the storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: any

      A default value to return if key not present in session storage.

      +

    Returns any

    Value from session storage or if not defined any default value provided.

    +

getStore

  • getStore<T>(
        key: string,
        defaultValue?: T,
        storageStores?: StorageStores,
    ): Writable<T>

  • Returns the backing Svelte store for the given key; potentially sets a default value if the key +is not already set.

    +

    Type Parameters

    • T

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: T

      A default value to return if key not present in session storage.

      +
    • OptionalstorageStores: StorageStores

      Additional store creation options.

      +

    Returns Writable<T>

    The Svelte store for this key.

    +

hasStore

  • hasStore(key: string): boolean

  • Returns whether a store has already been created for the given key.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +

    Returns boolean

keys

  • keys(regex?: RegExp): IterableIterator<string, any, any>

  • Returns an iterable for the session storage keys from existing stores.

    +

    Parameters

    • Optionalregex: RegExp

      Optional regular expression to filter by storage keys.

      +

    Returns IterableIterator<string, any, any>

    Iterable iterator of session storage keys.

    +

    Yields

setItem

  • setItem(key: string, value: any): void

  • Sets the value for the given key in storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • value: any

      A value to set for this key.

      +

    Returns void

stores

swapItemBoolean

  • swapItemBoolean(key: string, defaultValue?: boolean): boolean

  • Convenience method to swap a boolean value stored in storage API updating the associated store value.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: boolean

      A default value to return if key not present in session storage.

      +

    Returns boolean

    The boolean swap for the given key.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web-storage.TJSWebStorage.html b/docs/classes/_runtime_svelte_store_web-storage.TJSWebStorage.html new file mode 100644 index 0000000..d789c47 --- /dev/null +++ b/docs/classes/_runtime_svelte_store_web-storage.TJSWebStorage.html @@ -0,0 +1,65 @@ +TJSWebStorage | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSWebStorage

Provides the base Storage API store manager. It is recommended to use TJSLocalStorage & +TJSSessionStorage for standard browser local and session storage use cases. TJSWebStorage exists +to provide additional customization options for custom Storage API compatible storage instances and custom +serialization configuration.

+
+
+ +
+ Implements +
+ +
+
+
+
+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Methods

entries +getItem +getStore +hasStore +keys +setItem +stores +swapItemBoolean +

Constructors

constructor

Methods

entries

getItem

  • getItem(key: string, defaultValue?: any): any

  • Get value from the storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: any

      A default value to return if key not present in session storage.

      +

    Returns any

    Value from session storage or if not defined any default value provided.

    +

getStore

  • getStore<T>(
        key: string,
        defaultValue?: T,
        storageStores?: StorageStores,
    ): Writable<T>

  • Returns the backing Svelte store for the given key; potentially sets a default value if the key +is not already set.

    +

    Type Parameters

    • T

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: T

      A default value to return if key not present in session storage.

      +
    • OptionalstorageStores: StorageStores

      Additional store creation options.

      +

    Returns Writable<T>

    The Svelte store for this key.

    +

hasStore

  • hasStore(key: string): boolean

  • Returns whether a store has already been created for the given key.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +

    Returns boolean

keys

  • keys(regex?: RegExp): IterableIterator<string, any, any>

  • Returns an iterable for the session storage keys from existing stores.

    +

    Parameters

    • Optionalregex: RegExp

      Optional regular expression to filter by storage keys.

      +

    Returns IterableIterator<string, any, any>

    Iterable iterator of session storage keys.

    +

    Yields

setItem

  • setItem(key: string, value: any): void

  • Sets the value for the given key in storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • value: any

      A value to set for this key.

      +

    Returns void

stores

swapItemBoolean

  • swapItemBoolean(key: string, defaultValue?: boolean): boolean

  • Convenience method to swap a boolean value stored in storage API updating the associated store value.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: boolean

      A default value to return if key not present in session storage.

      +

    Returns boolean

    The boolean swap for the given key.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSLocalStorageBCMP.html b/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSLocalStorageBCMP.html new file mode 100644 index 0000000..5eee1cd --- /dev/null +++ b/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSLocalStorageBCMP.html @@ -0,0 +1,50 @@ +TJSLocalStorageBCMP | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSLocalStorageBCMP

Provides a TJSWebStorage instance for browser local storage using compressed MessagePack to base64.

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Methods

entries +getItem +getStore +hasStore +keys +setItem +stores +swapItemBoolean +

Constructors

constructor

Methods

entries

getItem

  • getItem(key: string, defaultValue?: any): any

  • Get value from the storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: any

      A default value to return if key not present in session storage.

      +

    Returns any

    Value from session storage or if not defined any default value provided.

    +

getStore

  • getStore<T>(
        key: string,
        defaultValue?: T,
        storageStores?: StorageStores,
    ): Writable<T>

  • Returns the backing Svelte store for the given key; potentially sets a default value if the key +is not already set.

    +

    Type Parameters

    • T

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: T

      A default value to return if key not present in session storage.

      +
    • OptionalstorageStores: StorageStores

      Additional store creation options.

      +

    Returns Writable<T>

    The Svelte store for this key.

    +

hasStore

  • hasStore(key: string): boolean

  • Returns whether a store has already been created for the given key.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +

    Returns boolean

keys

  • keys(regex?: RegExp): IterableIterator<string, any, any>

  • Returns an iterable for the session storage keys from existing stores.

    +

    Parameters

    • Optionalregex: RegExp

      Optional regular expression to filter by storage keys.

      +

    Returns IterableIterator<string, any, any>

    Iterable iterator of session storage keys.

    +

    Yields

setItem

  • setItem(key: string, value: any): void

  • Sets the value for the given key in storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • value: any

      A value to set for this key.

      +

    Returns void

stores

swapItemBoolean

  • swapItemBoolean(key: string, defaultValue?: boolean): boolean

  • Convenience method to swap a boolean value stored in storage API updating the associated store value.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: boolean

      A default value to return if key not present in session storage.

      +

    Returns boolean

    The boolean swap for the given key.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSSessionStorageBCMP.html b/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSSessionStorageBCMP.html new file mode 100644 index 0000000..66e10af --- /dev/null +++ b/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSSessionStorageBCMP.html @@ -0,0 +1,50 @@ +TJSSessionStorageBCMP | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSSessionStorageBCMP

Provides a TJSWebStorage instance for browser session storage using compressed MessagePack to base64.

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Methods

entries +getItem +getStore +hasStore +keys +setItem +stores +swapItemBoolean +

Constructors

constructor

Methods

entries

getItem

  • getItem(key: string, defaultValue?: any): any

  • Get value from the storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: any

      A default value to return if key not present in session storage.

      +

    Returns any

    Value from session storage or if not defined any default value provided.

    +

getStore

  • getStore<T>(
        key: string,
        defaultValue?: T,
        storageStores?: StorageStores,
    ): Writable<T>

  • Returns the backing Svelte store for the given key; potentially sets a default value if the key +is not already set.

    +

    Type Parameters

    • T

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: T

      A default value to return if key not present in session storage.

      +
    • OptionalstorageStores: StorageStores

      Additional store creation options.

      +

    Returns Writable<T>

    The Svelte store for this key.

    +

hasStore

  • hasStore(key: string): boolean

  • Returns whether a store has already been created for the given key.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +

    Returns boolean

keys

  • keys(regex?: RegExp): IterableIterator<string, any, any>

  • Returns an iterable for the session storage keys from existing stores.

    +

    Parameters

    • Optionalregex: RegExp

      Optional regular expression to filter by storage keys.

      +

    Returns IterableIterator<string, any, any>

    Iterable iterator of session storage keys.

    +

    Yields

setItem

  • setItem(key: string, value: any): void

  • Sets the value for the given key in storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • value: any

      A value to set for this key.

      +

    Returns void

stores

swapItemBoolean

  • swapItemBoolean(key: string, defaultValue?: boolean): boolean

  • Convenience method to swap a boolean value stored in storage API updating the associated store value.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: boolean

      A default value to return if key not present in session storage.

      +

    Returns boolean

    The boolean swap for the given key.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/classes/_runtime_util_loader-module.ModuleLoadError.html b/docs/classes/_runtime_util_loader-module.ModuleLoadError.html new file mode 100644 index 0000000..1c63caf --- /dev/null +++ b/docs/classes/_runtime_util_loader-module.ModuleLoadError.html @@ -0,0 +1,28 @@ +ModuleLoadError | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class ModuleLoadError

Provides a custom error for Node to combine CJS and ESM module not found errors.

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Constructors

constructor +

Methods

captureStackTrace +

Properties

cause? +code +message +name +stack? +prepareStackTrace? +stackTraceLimit +

Constructors

constructor

  • new ModuleLoadError(options: { code: string; message: string }): ModuleLoadError

  • Parameters

    • options: { code: string; message: string }

      Options object.

      +
      • code: string

        Error code.

        +
      • message: string

        Error message.

        +

    Returns ModuleLoadError

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Properties

Optionalcause

cause?: unknown

code

code: string

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

+

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

+

StaticstackTraceLimit

stackTraceLimit: number

Settings

Member Visibility

On This Page

Constructors
Methods
Properties
\ No newline at end of file diff --git a/docs/classes/_runtime_util_loader-module.ModuleLoader.html b/docs/classes/_runtime_util_loader-module.ModuleLoader.html new file mode 100644 index 0000000..9d41044 --- /dev/null +++ b/docs/classes/_runtime_util_loader-module.ModuleLoader.html @@ -0,0 +1,10 @@ +ModuleLoader | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class ModuleLoader

Provides universal loading of ES Modules / CommonJS on Node and ES Modules in the browser.

+

ModuleLoaderObj is returned with the loaded module along with metadata that describes the loading mechanism.

+

Constructors

constructor +

Methods

load +

Constructors

constructor

Methods

Staticload

  • load<M, E>(
        options: { modulepath: string | URL; resolveModule?: (M: any) => E },
    ): Promise<ModuleLoaderObj<M, E>>

  • Type Parameters

    • M
    • E

    Parameters

    • options: { modulepath: string | URL; resolveModule?: (M: any) => E }

      Options object.

      +
      • modulepath: string | URL

        A module name, file path, or URL.

        +
      • OptionalresolveModule?: (M: any) => E

        An optional function which resolves the import to set instance.

        +

    Returns Promise<ModuleLoaderObj<M, E>>

    The module / instance and data about the loading process.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/classes/_standard_component_color_picker-colord.TJSColordButton.html b/docs/classes/_standard_component_color_picker-colord.TJSColordButton.html new file mode 100644 index 0000000..59d1a91 --- /dev/null +++ b/docs/classes/_standard_component_color_picker-colord.TJSColordButton.html @@ -0,0 +1,19 @@ +TJSColordButton | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSColordButton

--tjs-default-text-shadow-focus-hover: system default
--tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

--tjs-button-background
--tjs-button-background-focus-visible
--tjs-button-background-hover
--tjs-button-background-selected
--tjs-button-border
--tjs-button-border-radius
--tjs-button-border-width
--tjs-button-box-shadow-focus-visible
--tjs-button-clip-path
--tjs-button-clip-path-focus
--tjs-button-clip-path-hover
--tjs-button-cursor
--tjs-button-diameter
--tjs-button-outline-focus-visible
--tjs-button-text-shadow-focus: undefined
--tjs-button-text-shadow-hover: undefined
--tjs-button-transition
--tjs-button-transition-focus-visible

--tjs-icon-button-background
--tjs-icon-button-background-focus-visible
--tjs-icon-button-background-hover
--tjs-icon-button-background-selected
--tjs-icon-button-border
--tjs-icon-button-border-radius
--tjs-icon-button-border-width
--tjs-icon-button-box-shadow-focus-visible
--tjs-icon-button-clip-path
--tjs-icon-button-clip-path-focus
--tjs-icon-button-clip-path-hover
--tjs-icon-button-cursor
--tjs-icon-button-diameter
--tjs-icon-button-filter-disabled
--tjs-icon-button-outline-focus-visible
--tjs-icon-button-text-shadow-focus: undefined
--tjs-icon-button-text-shadow-hover: undefined
--tjs-icon-button-transition
--tjs-icon-button-transition-focus-visible
+
+ +
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [prop: string]: any

Constructors

constructor +

Methods

$destroy +$on +$set +

Constructors

constructor

Methods

$destroy

$on

$set

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/classes/_standard_component_color_picker-colord.TJSColordPicker.html b/docs/classes/_standard_component_color_picker-colord.TJSColordPicker.html new file mode 100644 index 0000000..539faac --- /dev/null +++ b/docs/classes/_standard_component_color_picker-colord.TJSColordPicker.html @@ -0,0 +1,21 @@ +TJSColordPicker | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSColordPicker

TODO: Finish documentation.

+

Events:

+
    +
  • color: current color
    • +
+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [prop: string]: any

Constructors

constructor +

Methods

$destroy +$on +$set +

Constructors

constructor

Methods

$destroy

$on

$set

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/classes/_standard_component_color_picker-colord.TJSColordPickerSavedColors.html b/docs/classes/_standard_component_color_picker-colord.TJSColordPickerSavedColors.html new file mode 100644 index 0000000..c7b8285 --- /dev/null +++ b/docs/classes/_standard_component_color_picker-colord.TJSColordPickerSavedColors.html @@ -0,0 +1,18 @@ +TJSColordPickerSavedColors | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSColordPickerSavedColors

Provides the main addon example for TJSColordPicker. Addons allow extension of the color picker. This addon provides +session storage for saving / restoring colors.

+

An oddon for TJSColordPicker must provide a static accessor for a unique id and also provide a +TJSFolderData object via a folderData accessor.

+

Constructors

constructor +

Accessors

folderData +savedColorsState +id +

Methods

destroy +

Constructors

constructor

  • new TJSColordPickerSavedColors(
        opts?: { internalState: InternalState; label: string },
    ): TJSColordPickerSavedColors

  • Parameters

    • Optionalopts: { internalState: InternalState; label: string }

      Options.

      +
      • internalState: InternalState

        Internal picker state.

        +
      • label: string

        Label for folder.

        +

    Returns TJSColordPickerSavedColors

Accessors

folderData

  • get folderData(): TJSFolderData

  • Returns TJSFolderData

    The TJSFolderData object to configure the +TJSSvgFolder component the addon is installed into.

    +

savedColorsState

  • get savedColorsState(): SavedColorsState

  • Returns SavedColorsState

    Gets SavedColorState data.

    +

Staticid

  • get id(): string

  • Returns string

    ID of the addon.

    +

Methods

destroy

  • destroy(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
\ No newline at end of file diff --git a/docs/classes/_standard_component_layer_side-slide.TJSSideSlideLayer.html b/docs/classes/_standard_component_layer_side-slide.TJSSideSlideLayer.html new file mode 100644 index 0000000..1a1112d --- /dev/null +++ b/docs/classes/_standard_component_layer_side-slide.TJSSideSlideLayer.html @@ -0,0 +1,18 @@ +TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class TJSSideSlideLayer

Provides a component to display an absolutely positioned side layer in a parent element featuring a column of +icons that slide out panels defined as Svelte components.

+
+
+ +
+ + Hierarchy
+ +
+
+
+

Indexable

  • [prop: string]: any

Constructors

constructor +

Methods

$destroy +$on +$set +

Constructors

constructor

Methods

$destroy

$on

  • $on<K extends string>(
        type: K,
        callback: (e: CustomEvent<any>) => void,
    ): () => void

  • Type Parameters

    • K extends string

    Parameters

    Returns () => void

$set

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver.updateCache.html b/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver.updateCache.html new file mode 100644 index 0000000..5ea3855 --- /dev/null +++ b/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver.updateCache.html @@ -0,0 +1,6 @@ +updateCache | TyphonJS Runtime Library (FVTT) 0.2.0
+

Function updateCache

  • updateCache(el: HTMLElement): void

  • Provides a function that when invoked with an element updates the cached styles for each subscriber of the element.

    +

    The style attributes cached to calculate offset height / width include border & padding dimensions. You only need +to update the cache if you change border or padding attributes of the element.

    +

    Parameters

    Returns void

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/_runtime_svelte_animate_gsap.draggableGsap.options.html b/docs/functions/_runtime_svelte_animate_gsap.draggableGsap.options.html new file mode 100644 index 0000000..6d292df --- /dev/null +++ b/docs/functions/_runtime_svelte_animate_gsap.draggableGsap.options.html @@ -0,0 +1,5 @@ +options | TyphonJS Runtime Library (FVTT) 0.2.0
+

Function options

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_position.draggable.options.html b/docs/functions/_runtime_svelte_store_position.draggable.options.html new file mode 100644 index 0000000..7731f43 --- /dev/null +++ b/docs/functions/_runtime_svelte_store_position.draggable.options.html @@ -0,0 +1,5 @@ +options | TyphonJS Runtime Library (FVTT) 0.2.0
+

Function options

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_web-storage.storeGenerator.html b/docs/functions/_runtime_svelte_store_web-storage.storeGenerator.html new file mode 100644 index 0000000..7878486 --- /dev/null +++ b/docs/functions/_runtime_svelte_store_web-storage.storeGenerator.html @@ -0,0 +1,12 @@ +storeGenerator | TyphonJS Runtime Library (FVTT) 0.2.0
+

Function storeGenerator

  • storeGenerator(
        opts: {
            deserialize?: (value: string, ...rest: any[]) => any;
            serialize?: (value: any, ...rest: any[]) => string;
            storage: Storage;
        },
    ): StorageStores

  • Generates derived, readable, writable helper functions wrapping the given Storage API provided with any additional +customization for data serialization. By default, JSON serialization is used.

    +

    Parameters

    • opts: {
          deserialize?: (value: string, ...rest: any[]) => any;
          serialize?: (value: any, ...rest: any[]) => string;
          storage: Storage;
      }

      Generator options.

      +
      • Optionaldeserialize?: (value: string, ...rest: any[]) => any

        Replace with custom deserialization; +default: JSON.parse.

        +
      • Optionalserialize?: (value: any, ...rest: any[]) => string

        Replace with custom serialization; +default: JSON.stringify.

        +
      • storage: Storage

        The web storage source.

        +

    Returns StorageStores

    A complete set of store helper functions and associated storage API instance and +serialization strategy.

    +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_writable-derived.propertyStore.html b/docs/functions/_runtime_svelte_store_writable-derived.propertyStore.html new file mode 100644 index 0000000..5e83d50 --- /dev/null +++ b/docs/functions/_runtime_svelte_store_writable-derived.propertyStore.html @@ -0,0 +1,32 @@ +propertyStore | TyphonJS Runtime Library (FVTT) 0.2.0
+

Function propertyStore

  • propertyStore<O extends object, K extends string | number | symbol>(
        origin: MinimalWritable<O>,
        propName: K | [K],
    ): Writable<O[K]>

  • Create a store for a property value in an object contained in another store. +Read more...

    +

    Type Parameters

    • O extends object
    • K extends string | number | symbol

    Parameters

    • origin: MinimalWritable<O>

      The store containing the object to get/set from.

      +
    • propName: K | [K]

      The property to get/set, or a path of +properties in nested objects.

      +

    Returns Writable<O[K]>

    A writable store.

    +
  • propertyStore<
        O extends object,
        K1 extends string | number | symbol,
        K2 extends string | number | symbol,
    >(
        origin: MinimalWritable<O>,
        propName: [K1, K2],
    ): Writable<O[K1][K2]>

  • Create a store for a property value in an object contained in another store. +Read more...

    +

    Type Parameters

    • O extends object
    • K1 extends string | number | symbol
    • K2 extends string | number | symbol

    Parameters

    • origin: MinimalWritable<O>

      The store containing the object to get/set from.

      +
    • propName: [K1, K2]

      The property to get/set, or a path of +properties in nested objects.

      +

    Returns Writable<O[K1][K2]>

    A writable store.

    +
  • propertyStore<
        O extends object,
        K1 extends string | number | symbol,
        K2 extends string | number | symbol,
        K3 extends string | number | symbol,
    >(
        origin: MinimalWritable<O>,
        propName: [K1, K2, K3],
    ): Writable<O[K1][K2][K3]>

  • Create a store for a property value in an object contained in another store. +Read more...

    +

    Type Parameters

    • O extends object
    • K1 extends string | number | symbol
    • K2 extends string | number | symbol
    • K3 extends string | number | symbol

    Parameters

    • origin: MinimalWritable<O>

      The store containing the object to get/set from.

      +
    • propName: [K1, K2, K3]

      The property to get/set, or a path of +properties in nested objects.

      +

    Returns Writable<O[K1][K2][K3]>

    A writable store.

    +
  • propertyStore<
        O extends object,
        K1 extends string | number | symbol,
        K2 extends string | number | symbol,
        K3 extends string | number | symbol,
        K4 extends string | number | symbol,
    >(
        origin: MinimalWritable<O>,
        propName: [K1, K2, K3, K4],
    ): Writable<O[K1][K2][K3][K4]>

  • Create a store for a property value in an object contained in another store. +Read more...

    +

    Type Parameters

    • O extends object
    • K1 extends string | number | symbol
    • K2 extends string | number | symbol
    • K3 extends string | number | symbol
    • K4 extends string | number | symbol

    Parameters

    • origin: MinimalWritable<O>

      The store containing the object to get/set from.

      +
    • propName: [K1, K2, K3, K4]

      The property to get/set, or a path of +properties in nested objects.

      +

    Returns Writable<O[K1][K2][K3][K4]>

    A writable store.

    +
  • propertyStore(
        origin: MinimalWritable<object>,
        propName: string | number | symbol | (string | number | symbol)[],
    ): Writable<any>

  • Create a store for a property value in an object contained in another store. +Read more...

    +

    Parameters

    • origin: MinimalWritable<object>

      The store containing the object to get/set from.

      +
    • propName: string | number | symbol | (string | number | symbol)[]

      The property to get/set, or a path of +properties in nested objects.

      +

    Returns Writable<any>

    A writable store.

    +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_writable-derived.writableDerived.html b/docs/functions/_runtime_svelte_store_writable-derived.writableDerived.html new file mode 100644 index 0000000..c8147a0 --- /dev/null +++ b/docs/functions/_runtime_svelte_store_writable-derived.writableDerived.html @@ -0,0 +1,28 @@ +writableDerived | TyphonJS Runtime Library (FVTT) 0.2.0
+

Function writableDerived

  • writableDerived<S extends Stores, T>(
        origins: S,
        derive: (values: StoresValues<S>) => T,
        reflect: (reflecting: T, old: StoresValues<S>) => SetValues<S>,
        initial?: T,
    ): Writable<T>

  • Create a store similar to Svelte's derived, but which +has its own set and update methods and can send values back to the origin stores. +Read more...

    +

    Type Parameters

    Parameters

    • origins: S

      One or more stores to derive from. Same as +derived's 1st parameter.

      +
    • derive: (values: StoresValues<S>) => T

      The callback to determine the derived value. Same as +derived's 2nd parameter.

      +
    • reflect: (reflecting: T, old: StoresValues<S>) => SetValues<S>

      Called when the +derived store gets a new value via its set or update methods, and determines new values for +the origin stores. Read more...

      +
    • Optionalinitial: T

      The new store's initial value. Same as +derived's 3rd parameter.

      +

    Returns Writable<T>

    A writable store.

    +
  • writableDerived<S extends Stores, T>(
        origins: S,
        derive: (
            values: StoresValues<S>,
            set: (value: T) => void,
            update: (fn: Updater<T>) => void,
        ) => void,
        reflect: (reflecting: T, old: StoresValues<S>) => SetValues<S>,
        initial?: T,
    ): Writable<T>

  • Create a store similar to Svelte's derived, but which +has its own set and update methods and can send values back to the origin stores. +Read more...

    +

    Type Parameters

    Parameters

    • origins: S

      One or more stores to derive from. Same as +derived's 1st parameter.

      +
    • derive: (
          values: StoresValues<S>,
          set: (value: T) => void,
          update: (fn: Updater<T>) => void,
      ) => void

      The callback to determine the derived value. Same as +derived's 2nd parameter.

      +
    • reflect: (reflecting: T, old: StoresValues<S>) => SetValues<S>

      Called when the +derived store gets a new value via its set or update methods, and determines new values for +the origin stores. Read more...

      +
    • Optionalinitial: T

      The new store's initial value. Same as +derived's 3rd parameter.

      +

    Returns Writable<T>

    A writable store.

    +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupDataCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupDataCallback.html new file mode 100644 index 0000000..1c1910a --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupDataCallback.html @@ -0,0 +1,11 @@ +GroupDataCallback | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface GroupDataCallback

Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing +different position data to be assigned to each instance in the grouped animation.

+
  • GroupDataCallback(options?: GroupCallbackOptions): TJSPositionDataRelative

  • Parameters

    • Optionaloptions: GroupCallbackOptions

      The group callback options defining the order of the current +position / positionable being processed.

      +

    Returns TJSPositionDataRelative

      +
    • The unique position data target to animate for this position / +positionable instance. When null or undefined is returned the current position / positionable is +removed from the animation.
      • +
    +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupQuickToCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupQuickToCallback.html new file mode 100644 index 0000000..75e1bf4 --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupQuickToCallback.html @@ -0,0 +1,24 @@ +GroupQuickToCallback | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface GroupQuickToCallback

The quickTo callback function returned from AnimationGroupAPI.quickTo. Extends QuickToCallback +accepting functions for setting each instance of group with new position data and / or options.

+
interface GroupQuickToCallback {
    keys: AnimationKey[];
    options: (
        options: QuickTweenOptions | GroupQuickTweenOptionsCallback,
    ) => GroupQuickToCallback;
    (arg: GroupDataCallback): void;
    (...args: (string | number)[]): void;
    (
        arg: Partial<
            {
                height: string
                | number;
                left: string | number;
                maxHeight: string | number;
                maxWidth: string | number;
                minHeight: string | number;
                minWidth: string | number;
                rotateX: string | number;
                rotateY: string | number;
                rotateZ: string | number;
                rotation: string | number;
                scale: string | number;
                top: string | number;
                translateX: string | number;
                translateY: string | number;
                translateZ: string | number;
                width: string | number;
                zIndex: string | number;
            },
        >,
    ): void;
}
+
+ +
+ + Hierarchy
+ +
+
+
+
  • GroupQuickToCallback(arg: GroupDataCallback): void

  • Parameters

    • arg: GroupDataCallback

      A callback function invoked for unique positional data for each instance of the group.

      +

    Returns void

  • GroupQuickToCallback(...args: (string | number)[]): void

  • Parameters

    • ...args: (string | number)[]

      Individual numbers or relative strings corresponding to the order in which animation keys are +specified.

      +

    Returns void

  • GroupQuickToCallback(
        arg: Partial<
            {
                height: string
                | number;
                left: string | number;
                maxHeight: string | number;
                maxWidth: string | number;
                minHeight: string | number;
                minWidth: string | number;
                rotateX: string | number;
                rotateY: string | number;
                rotateZ: string | number;
                rotation: string | number;
                scale: string | number;
                top: string | number;
                translateX: string | number;
                translateY: string | number;
                translateZ: string | number;
                width: string | number;
                zIndex: string | number;
            },
        >,
    ): void

  • Parameters

    • arg: Partial<
          {
              height: string
              | number;
              left: string | number;
              maxHeight: string | number;
              maxWidth: string | number;
              minHeight: string | number;
              minWidth: string | number;
              rotateX: string | number;
              rotateY: string | number;
              rotateZ: string | number;
              rotation: string | number;
              scale: string | number;
              top: string | number;
              translateX: string | number;
              translateY: string | number;
              translateZ: string | number;
              width: string | number;
              zIndex: string | number;
          },
      >

      A single object with animation keys specified and numerical or relative string values.

      +

    Returns void

Properties

keys +options +

Properties

Readonlykeys

keys: AnimationKey[]

The keys assigned for this quickTo callback.

+

options

options: (
    options: QuickTweenOptions | GroupQuickTweenOptionsCallback,
) => GroupQuickToCallback

Sets options of quickTo tween.

+

Type declaration

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupQuickTweenOptionsCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupQuickTweenOptionsCallback.html new file mode 100644 index 0000000..5a5e71f --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupQuickTweenOptionsCallback.html @@ -0,0 +1,10 @@ +GroupQuickTweenOptionsCallback | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface GroupQuickTweenOptionsCallback

Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing +different quick tween options to be assigned to each instance in the grouped animation.

+
  • GroupQuickTweenOptionsCallback(
        options?: GroupCallbackOptions,
    ): QuickTweenOptions

  • Parameters

    • Optionaloptions: GroupCallbackOptions

      The group callback options defining the order of the current +position / positionable being processed.

      +

    Returns QuickTweenOptions

      +
    • The unique quick tween options to set for this position / positionable instance. +When null or undefined is returned the current position / positionable is removed from the animation.
      • +
    +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupTweenOptionsCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupTweenOptionsCallback.html new file mode 100644 index 0000000..4091263 --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.GroupTweenOptionsCallback.html @@ -0,0 +1,10 @@ +GroupTweenOptionsCallback | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface GroupTweenOptionsCallback

Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing +different tween options to be assigned to each instance in the grouped animation.

+
  • GroupTweenOptionsCallback(options?: GroupCallbackOptions): TweenOptions

  • Parameters

    • Optionaloptions: GroupCallbackOptions

      The group callback options defining the order of the current +position / positionable being processed.

      +

    Returns TweenOptions

      +
    • The unique tween options to set for this position / positionable instance. When null +or undefined is returned the current position / positionable is removed from the animation.
      • +
    +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.QuickToCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.QuickToCallback.html new file mode 100644 index 0000000..448b805 --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.QuickToCallback.html @@ -0,0 +1,22 @@ +QuickToCallback | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface QuickToCallback

The quickTo callback function returned from AnimationAPI.quickTo.

+
interface QuickToCallback {
    keys: AnimationKey[];
    options: (options: QuickTweenOptions) => QuickToCallback;
    (...args: (string | number)[]): void;
    (
        arg: Partial<
            {
                height: string
                | number;
                left: string | number;
                maxHeight: string | number;
                maxWidth: string | number;
                minHeight: string | number;
                minWidth: string | number;
                rotateX: string | number;
                rotateY: string | number;
                rotateZ: string | number;
                rotation: string | number;
                scale: string | number;
                top: string | number;
                translateX: string | number;
                translateY: string | number;
                translateZ: string | number;
                width: string | number;
                zIndex: string | number;
            },
        >,
    ): void;
}
+
+ +
+ + Hierarchy
+ +
+
+
+
  • QuickToCallback(...args: (string | number)[]): void

  • Parameters

    • ...args: (string | number)[]

      Individual numbers or relative strings corresponding to the order in which animation keys are +specified.

      +

    Returns void

  • QuickToCallback(
        arg: Partial<
            {
                height: string
                | number;
                left: string | number;
                maxHeight: string | number;
                maxWidth: string | number;
                minHeight: string | number;
                minWidth: string | number;
                rotateX: string | number;
                rotateY: string | number;
                rotateZ: string | number;
                rotation: string | number;
                scale: string | number;
                top: string | number;
                translateX: string | number;
                translateY: string | number;
                translateZ: string | number;
                width: string | number;
                zIndex: string | number;
            },
        >,
    ): void

  • Parameters

    • arg: Partial<
          {
              height: string
              | number;
              left: string | number;
              maxHeight: string | number;
              maxWidth: string | number;
              minHeight: string | number;
              minWidth: string | number;
              rotateX: string | number;
              rotateY: string | number;
              rotateZ: string | number;
              rotation: string | number;
              scale: string | number;
              top: string | number;
              translateX: string | number;
              translateY: string | number;
              translateZ: string | number;
              width: string | number;
              zIndex: string | number;
          },
      >

      A single object with animation keys specified and numerical or relative string values.

      +

    Returns void

Properties

keys +options +

Properties

Readonlykeys

keys: AnimationKey[]

The keys assigned for this quickTo callback.

+

options

options: (options: QuickTweenOptions) => QuickToCallback

Sets options of quickTo tween.

+

Type declaration

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformData.html b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformData.html new file mode 100644 index 0000000..60cccd9 --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformData.html @@ -0,0 +1,13 @@ +TransformData | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface TransformData

Provides the output data for TransformAPI.getData.

+
interface TransformData {
    get boundingRect(): DOMRect;
    get corners(): Vec3[];
    get css(): string;
    get mat4(): Mat4;
    get originTranslations(): Mat4[];
}

Accessors

boundingRect +corners +css +mat4 +originTranslations +

Accessors

boundingRect

corners

  • get corners(): Vec3[]

  • Returns Vec3[]

    The transformed corner points as Vec3 in screen space.

    +

css

  • get css(): string

  • Returns string

    Returns the CSS style string for the transform matrix.

    +

mat4

  • get mat4(): Mat4

  • Returns Mat4

    The transform matrix.

    +

originTranslations

  • get originTranslations(): Mat4[]

  • Returns Mat4[]

    The pre / post translation matrices for origin translation.

    +

Settings

Member Visibility

On This Page

Accessors
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformDataConstructor.html b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformDataConstructor.html new file mode 100644 index 0000000..bf3a025 --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformDataConstructor.html @@ -0,0 +1,4 @@ +TransformDataConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface TransformDataConstructor

Describes the constructor function for TransformData.

+
interface TransformDataConstructor {
    new TransformDataConstructor(): TransformData;
}

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

On This Page

Constructors
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformOriginWritable.html b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformOriginWritable.html new file mode 100644 index 0000000..cee7293 --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.TransformOriginWritable.html @@ -0,0 +1,25 @@ +TransformOriginWritable | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface TransformOriginWritable

Provides a custom writable for the transformOrigin store adding a read only property values that +contains a list of all transform origin values.

+
interface TransformOriginWritable {
    get values(): readonly TransformOrigin[];
    set(this: void, value: TransformOrigin): void;
    subscribe(
        this: void,
        run: Subscriber<TransformOrigin>,
        invalidate?: Invalidator<TransformOrigin>,
    ): Unsubscriber;
    update(this: void, updater: Updater<TransformOrigin>): void;
}
+
+ +
+ + Hierarchy
+ +
+
+
+

Accessors

values +

Methods

set +subscribe +update +

Accessors

values

Methods

set

subscribe

update

Settings

Member Visibility

On This Page

Accessors
Methods
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.ValidatorFn.html b/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.ValidatorFn.html new file mode 100644 index 0000000..256add5 --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.ValidatorFn.html @@ -0,0 +1,45 @@ +ValidatorFn | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface ValidatorFn

interface ValidatorFn {
    arguments: any;
    caller: Function;
    length: number;
    name: string;
    prototype: any;
    "[hasInstance]"(value: any): boolean;
    apply(this: Function, thisArg: any, argArray?: any): any;
    bind(this: Function, thisArg: any, ...argArray: any[]): any;
    call(this: Function, thisArg: any, ...argArray: any[]): any;
    subscribe(
        this: void,
        run: Subscriber<any>,
        invalidate?: Invalidator<any>,
    ): Unsubscriber;
    toString(): string;
    (data: ValidationData): TJSPositionData;
}
+
+ +
+ + Hierarchy
+ +
+
+
+

Methods

[hasInstance] +apply +bind +call +subscribe? +toString +

Properties

arguments +caller +length +name +prototype +

Methods

[hasInstance]

  • "[hasInstance]"(value: any): boolean

  • Determines whether the given value inherits from this function if this function was used +as a constructor function.

    +

    A constructor function can control which objects are recognized as its instances by +'instanceof' by overriding this method.

    +

    Parameters

    • value: any

    Returns boolean

apply

  • apply(this: Function, thisArg: any, argArray?: any): any

  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    +

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the this object.

      +
    • OptionalargArray: any

      A set of arguments to be passed to the function.

      +

    Returns any

bind

  • bind(this: Function, thisArg: any, ...argArray: any[]): any

  • For a given function, creates a bound function that has the same body as the original function. +The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    +

    Parameters

    • this: Function
    • thisArg: any

      An object to which the this keyword can refer inside the new function.

      +
    • ...argArray: any[]

      A list of arguments to be passed to the new function.

      +

    Returns any

call

  • call(this: Function, thisArg: any, ...argArray: any[]): any

  • Calls a method of an object, substituting another object for the current object.

    +

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the current object.

      +
    • ...argArray: any[]

      A list of arguments to be passed to the method.

      +

    Returns any

Optionalsubscribe

  • subscribe(
        this: void,
        run: Subscriber<any>,
        invalidate?: Invalidator<any>,
    ): Unsubscriber

  • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will +be processed again.

    +

    Parameters

    Returns Unsubscriber

toString

  • toString(): string

  • Returns a string representation of a function.

    +

    Returns string

Properties

arguments

arguments: any

caller

caller: Function

Readonlylength

length: number

Readonlyname

name: string

Returns the name of the function. Function names are read-only and can not be changed.

+

prototype

prototype: any

Settings

Member Visibility

On This Page

Methods
Properties
\ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_web-storage.WebStorage.html b/docs/interfaces/_runtime_svelte_store_web-storage.WebStorage.html new file mode 100644 index 0000000..de02c36 --- /dev/null +++ b/docs/interfaces/_runtime_svelte_store_web-storage.WebStorage.html @@ -0,0 +1,49 @@ +WebStorage | TyphonJS Runtime Library (FVTT) 0.2.0
+

Interface WebStorage

Provides the TRL web storage store API.

+
interface WebStorage {
    entries<T>(
        regex?: RegExp,
    ): IterableIterator<[string, Writable<T>], any, any>;
    getItem(key: string, defaultValue?: any): unknown;
    getStore<T>(
        key: string,
        defaultValue?: T,
        storageStores?: StorageStores,
    ): Writable<T>;
    hasStore(key: string): boolean;
    keys(regex?: RegExp): IterableIterator<string, any, any>;
    setItem(key: string, value: any): void;
    stores<T>(regex?: RegExp): IterableIterator<Writable<T>, any, any>;
    swapItemBoolean(key: string, defaultValue?: boolean): boolean;
}
+
+ +
+ Implemented by +
+ +
+
+
+

Methods

entries +getItem +getStore +hasStore +keys +setItem +stores +swapItemBoolean +

Methods

entries

  • entries<T>(regex?: RegExp): IterableIterator<[string, Writable<T>], any, any>

  • Type Parameters

    • T

      Returns an iterable for the session storage keys and stores.

      +

    Parameters

    • Optionalregex: RegExp

      Optional regular expression to filter by storage keys.

      +

    Returns IterableIterator<[string, Writable<T>], any, any>

    Iterable iterator of keys and stores.

    +

    Yields

getItem

  • getItem(key: string, defaultValue?: any): unknown

  • Get value from the storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: any

      A default value to return if key not present in session storage.

      +

    Returns unknown

    Value from session storage or if not defined any default value provided.

    +

getStore

  • getStore<T>(
        key: string,
        defaultValue?: T,
        storageStores?: StorageStores,
    ): Writable<T>

  • Returns the backing Svelte store for the given key; potentially sets a default value if the key +is not already set.

    +

    Type Parameters

    • T

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: T

      A default value to return if key not present in session storage.

      +
    • OptionalstorageStores: StorageStores

      Additional store creation options.

      +

    Returns Writable<T>

    The Svelte store for this key.

    +

hasStore

  • hasStore(key: string): boolean

  • Returns whether a store has already been created for the given key.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +

    Returns boolean

keys

  • keys(regex?: RegExp): IterableIterator<string, any, any>

  • Returns an iterable for the session storage keys from existing stores.

    +

    Parameters

    • Optionalregex: RegExp

      Optional regular expression to filter by storage keys.

      +

    Returns IterableIterator<string, any, any>

    Iterable iterator of session storage keys.

    +

    Yields

setItem

  • setItem(key: string, value: any): void

  • Sets the value for the given key in storage API.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • value: any

      A value to set for this key.

      +

    Returns void

stores

swapItemBoolean

  • swapItemBoolean(key: string, defaultValue?: boolean): boolean

  • Convenience method to swap a boolean value stored in storage API updating the associated store value.

    +

    Parameters

    • key: string

      Key to lookup in storage API.

      +
    • OptionaldefaultValue: boolean

      A default value to return if key not present in session storage.

      +

    Returns boolean

    The boolean swap for the given key.

    +

Settings

Member Visibility

On This Page

Methods
\ No newline at end of file diff --git a/docs/modules/_runtime_data_struct_cache_quick-lru.html b/docs/modules/_runtime_data_struct_cache_quick-lru.html new file mode 100644 index 0000000..cab8790 --- /dev/null +++ b/docs/modules/_runtime_data_struct_cache_quick-lru.html @@ -0,0 +1,2 @@ +#runtime/data/struct/cache/quick-lru | TyphonJS Runtime Library (FVTT) 0.2.0
+

    Package #runtime/data/struct/cache/quick-lru

    Classes

    QuickLRU

    Type Aliases

    Options

    Settings

    Member Visibility

    On This Page

    Classes
    Type Aliases
    \ No newline at end of file diff --git a/docs/modules/_runtime_math_gl-matrix.html b/docs/modules/_runtime_math_gl-matrix.html new file mode 100644 index 0000000..78c3888 --- /dev/null +++ b/docs/modules/_runtime_math_gl-matrix.html @@ -0,0 +1,3 @@ +#runtime/math/gl-matrix | TyphonJS Runtime Library (FVTT) 0.2.0
    +

      Package #runtime/math/gl-matrix

      Provides the gl-matrix 32-bit library.

      +

      Classes

      Mat2
      Mat2d
      Mat3
      Mat4
      Quat
      Quat2
      Vec2
      Vec3
      Vec4

      Type Aliases

      FloatArray
      Mat2dLike
      Mat2Like
      Mat3Like
      Mat4Like
      Quat2Like
      QuatLike
      Vec2Like
      Vec3Like
      Vec4Like

      Settings

      Member Visibility

      On This Page

      Classes
      Type Aliases
      \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_reducer_array-object.html b/docs/modules/_runtime_svelte_store_reducer_array-object.html new file mode 100644 index 0000000..411c812 --- /dev/null +++ b/docs/modules/_runtime_svelte_store_reducer_array-object.html @@ -0,0 +1,2 @@ +#runtime/svelte/store/reducer/array-object | TyphonJS Runtime Library (FVTT) 0.2.0
      +

        Package #runtime/svelte/store/reducer/array-object

        Classes

        ArrayObjectStore
        CrudArrayObjectStore
        ObjectEntryStore

        Type Aliases

        ArrayObjectStoreParams
        ArrayObjectUpdateData
        BaseArrayObjectEntryStore
        CrudArrayObjectStoreParamProps
        CrudArrayObjectStoreParams
        CrudDispatch

        Settings

        Member Visibility

        On This Page

        Classes
        Type Aliases
        \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_web-storage.html b/docs/modules/_runtime_svelte_store_web-storage.html new file mode 100644 index 0000000..eb75f0a --- /dev/null +++ b/docs/modules/_runtime_svelte_store_web-storage.html @@ -0,0 +1,2 @@ +#runtime/svelte/store/web-storage | TyphonJS Runtime Library (FVTT) 0.2.0
        +

          Package #runtime/svelte/store/web-storage

          Classes

          TJSLocalStorage
          TJSSessionStorage
          TJSWebStorage

          Functions

          storeGenerator

          Variables

          localStores
          sessionStores

          Interfaces

          WebStorage

          Type Aliases

          StorageDerived
          StorageReadable
          StorageStores
          StorageWritable

          Settings

          Member Visibility

          On This Page

          Classes
          Functions
          Variables
          Interfaces
          Type Aliases
          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_web-storage_msgpack.html b/docs/modules/_runtime_svelte_store_web-storage_msgpack.html new file mode 100644 index 0000000..f9c7f27 --- /dev/null +++ b/docs/modules/_runtime_svelte_store_web-storage_msgpack.html @@ -0,0 +1,2 @@ +#runtime/svelte/store/web-storage/msgpack | TyphonJS Runtime Library (FVTT) 0.2.0
          +

            Package #runtime/svelte/store/web-storage/msgpack

            Classes

            TJSLocalStorageBCMP
            TJSSessionStorageBCMP

            Variables

            localStoresBCMP
            sessionStoresBCMP

            Settings

            Member Visibility

            On This Page

            Classes
            Variables
            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_writable-derived.html b/docs/modules/_runtime_svelte_store_writable-derived.html new file mode 100644 index 0000000..43cf145 --- /dev/null +++ b/docs/modules/_runtime_svelte_store_writable-derived.html @@ -0,0 +1,2 @@ +#runtime/svelte/store/writable-derived | TyphonJS Runtime Library (FVTT) 0.2.0
            +

              Package #runtime/svelte/store/writable-derived

              Functions

              propertyStore
              writableDerived

              Type Aliases

              SetValues
              Stores
              StoresValues

              Settings

              Member Visibility

              On This Page

              Functions
              Type Aliases
              \ No newline at end of file diff --git a/docs/modules/_runtime_util_loader-module.html b/docs/modules/_runtime_util_loader-module.html new file mode 100644 index 0000000..ccb45a6 --- /dev/null +++ b/docs/modules/_runtime_util_loader-module.html @@ -0,0 +1,2 @@ +#runtime/util/loader-module | TyphonJS Runtime Library (FVTT) 0.2.0
              +

                Package #runtime/util/loader-module

                Classes

                ModuleLoader
                ModuleLoadError

                Type Aliases

                ModuleLoaderObj

                Settings

                Member Visibility

                On This Page

                Classes
                Type Aliases
                \ No newline at end of file diff --git a/docs/modules/_standard_component_color_picker-colord.TJSColordButton-1.html b/docs/modules/_standard_component_color_picker-colord.TJSColordButton-1.html new file mode 100644 index 0000000..22d935b --- /dev/null +++ b/docs/modules/_standard_component_color_picker-colord.TJSColordButton-1.html @@ -0,0 +1,3 @@ +TJSColordButton | TyphonJS Runtime Library (FVTT) 0.2.0
                +

                Namespace TJSColordButton

                Event / Prop / Slot type aliases for associated component.

                +

                Type Aliases

                Events
                Props
                Slots

                Settings

                Member Visibility

                On This Page

                Type Aliases
                \ No newline at end of file diff --git a/docs/modules/_standard_component_color_picker-colord.TJSColordPicker-1.html b/docs/modules/_standard_component_color_picker-colord.TJSColordPicker-1.html new file mode 100644 index 0000000..7b93489 --- /dev/null +++ b/docs/modules/_standard_component_color_picker-colord.TJSColordPicker-1.html @@ -0,0 +1,3 @@ +TJSColordPicker | TyphonJS Runtime Library (FVTT) 0.2.0
                +

                Namespace TJSColordPicker

                Event / Prop / Slot type aliases for associated component.

                +

                Type Aliases

                Events
                Props
                Slots

                Settings

                Member Visibility

                On This Page

                Type Aliases
                \ No newline at end of file diff --git a/docs/modules/_standard_component_color_picker-colord.html b/docs/modules/_standard_component_color_picker-colord.html new file mode 100644 index 0000000..ba1a60f --- /dev/null +++ b/docs/modules/_standard_component_color_picker-colord.html @@ -0,0 +1,2 @@ +#standard/component/color/picker-colord | TyphonJS Runtime Library (FVTT) 0.2.0
                +

                  Package #standard/component/color/picker-colord

                  Classes

                  TJSColordButton
                  TJSColordPicker
                  TJSColordPickerSavedColors

                  Namespaces

                  TJSColordButton
                  TJSColordPicker

                  Type Aliases

                  TJSColordPickerColor
                  TJSColordPickerComponents
                  TJSColordPickerOptions

                  Settings

                  Member Visibility

                  On This Page

                  Classes
                  Namespaces
                  Type Aliases
                  \ No newline at end of file diff --git a/docs/modules/_standard_component_layer_side-slide.TJSSideSlideLayer-1.html b/docs/modules/_standard_component_layer_side-slide.TJSSideSlideLayer-1.html new file mode 100644 index 0000000..bb71464 --- /dev/null +++ b/docs/modules/_standard_component_layer_side-slide.TJSSideSlideLayer-1.html @@ -0,0 +1,3 @@ +TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0
                  +

                  Namespace TJSSideSlideLayer

                  Event / Prop / Slot type aliases for associated component.

                  +

                  Type Aliases

                  Events
                  Props
                  Slots

                  Settings

                  Member Visibility

                  On This Page

                  Type Aliases
                  \ No newline at end of file diff --git a/docs/modules/_standard_component_layer_side-slide.html b/docs/modules/_standard_component_layer_side-slide.html new file mode 100644 index 0000000..1c3c91b --- /dev/null +++ b/docs/modules/_standard_component_layer_side-slide.html @@ -0,0 +1,2 @@ +#standard/component/layer/side-slide | TyphonJS Runtime Library (FVTT) 0.2.0
                  +

                    Package #standard/component/layer/side-slide

                    Classes

                    TJSSideSlideLayer

                    Namespaces

                    TJSSideSlideLayer

                    Settings

                    Member Visibility

                    On This Page

                    Classes
                    Namespaces
                    \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_cache_quick-lru.Options.html b/docs/types/_runtime_data_struct_cache_quick-lru.Options.html new file mode 100644 index 0000000..0e495a5 --- /dev/null +++ b/docs/types/_runtime_data_struct_cache_quick-lru.Options.html @@ -0,0 +1,10 @@ +Options | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Options<KeyType, ValueType>

                    Options: {
                        maxAge?: number;
                        maxSize: number;
                        onEviction?: (key: KeyType, value: ValueType) => void;
                    }

                    Type Parameters

                    • KeyType
                    • ValueType

                    Type declaration

                    • Optional ReadonlymaxAge?: number

                      The maximum number of milliseconds an item should remain in the cache.

                      +

                      Default

                      Infinity

                      +

                      By default, maxAge will be Infinity, which means that items will never expire. +Lazy expiration upon the next write or read call.

                      +

                      Individual expiration of an item can be specified by the set(key, value, maxAge) method.

                      +
                    • ReadonlymaxSize: number

                      The maximum number of items before evicting the least recently used items.

                      +
                    • OptionalonEviction?: (key: KeyType, value: ValueType) => void

                      Called right before an item is evicted from the cache.

                      +

                      Useful for side effects or for items like object URLs that need explicit cleanup (revokeObjectURL).

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.FloatArray.html b/docs/types/_runtime_math_gl-matrix.FloatArray.html new file mode 100644 index 0000000..86bfe39 --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.FloatArray.html @@ -0,0 +1,3 @@ +FloatArray | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias FloatArray

                    FloatArray: Float32Array | Float64Array

                    The floating-point typed arrays that can be used in place of a vector, matrix, or quaternion.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.Mat2Like.html b/docs/types/_runtime_math_gl-matrix.Mat2Like.html new file mode 100644 index 0000000..3cd1f87 --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.Mat2Like.html @@ -0,0 +1,3 @@ +Mat2Like | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Mat2Like

                    Mat2Like: [number, number, number, number] | FloatArray

                    A 2x2 Matrix given as a Mat2, a 4-element floating-point TypedArray, or an array of 4 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.Mat2dLike.html b/docs/types/_runtime_math_gl-matrix.Mat2dLike.html new file mode 100644 index 0000000..a35b6ec --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.Mat2dLike.html @@ -0,0 +1,3 @@ +Mat2dLike | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Mat2dLike

                    Mat2dLike: [number, number, number, number, number, number] | FloatArray

                    A 2x3 Matrix given as a Mat2d, a 6-element floating-point TypedArray, or an array of 6 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.Mat3Like.html b/docs/types/_runtime_math_gl-matrix.Mat3Like.html new file mode 100644 index 0000000..a931ba4 --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.Mat3Like.html @@ -0,0 +1,3 @@ +Mat3Like | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Mat3Like

                    Mat3Like:
                        | [
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                        ]
                        | FloatArray

                    A 3x3 Matrix given as a Mat3, a 9-element floating-point TypedArray, or an array of 9 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.Mat4Like.html b/docs/types/_runtime_math_gl-matrix.Mat4Like.html new file mode 100644 index 0000000..4580715 --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.Mat4Like.html @@ -0,0 +1,3 @@ +Mat4Like | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Mat4Like

                    Mat4Like:
                        | [
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                            number,
                        ]
                        | FloatArray

                    A 4x4 Matrix given as a Mat4, a 16-element floating-point TypedArray, or an array of 16 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.Quat2Like.html b/docs/types/_runtime_math_gl-matrix.Quat2Like.html new file mode 100644 index 0000000..d61a892 --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.Quat2Like.html @@ -0,0 +1,3 @@ +Quat2Like | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Quat2Like

                    Quat2Like:
                        | [number, number, number, number, number, number, number, number]
                        | FloatArray

                    A Dual Quaternion given as a Quat2, an 8-element floating-point TypedArray, or an array of 8 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.QuatLike.html b/docs/types/_runtime_math_gl-matrix.QuatLike.html new file mode 100644 index 0000000..fc60c8a --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.QuatLike.html @@ -0,0 +1,3 @@ +QuatLike | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias QuatLike

                    QuatLike: Vec4Like

                    A Quaternion given as a Quat, a 4-element floating-point TypedArray, or an array of 4 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.Vec2Like.html b/docs/types/_runtime_math_gl-matrix.Vec2Like.html new file mode 100644 index 0000000..d7a4def --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.Vec2Like.html @@ -0,0 +1,3 @@ +Vec2Like | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Vec2Like

                    Vec2Like: [number, number] | FloatArray

                    A 2-dimensional vector given as a Vec2, a 2-element floating-point TypedArray, or an array of 2 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.Vec3Like.html b/docs/types/_runtime_math_gl-matrix.Vec3Like.html new file mode 100644 index 0000000..eba4af4 --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.Vec3Like.html @@ -0,0 +1,3 @@ +Vec3Like | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Vec3Like

                    Vec3Like: [number, number, number] | FloatArray

                    A 3-dimensional vector given as a Vec3, a 3-element floating-point TypedArray, or an array of 3 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_math_gl-matrix.Vec4Like.html b/docs/types/_runtime_math_gl-matrix.Vec4Like.html new file mode 100644 index 0000000..09fb369 --- /dev/null +++ b/docs/types/_runtime_math_gl-matrix.Vec4Like.html @@ -0,0 +1,3 @@ +Vec4Like | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Vec4Like

                    Vec4Like: [number, number, number, number] | FloatArray

                    A 4-dimensional vector given as a Vec4, a 4-element floating-point TypedArray, or an array of 4 numbers.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.ApplicationShell.Events.html b/docs/types/_runtime_svelte_component_application.ApplicationShell.Events.html new file mode 100644 index 0000000..6ad0e38 --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.ApplicationShell.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.ApplicationShell.Props.html b/docs/types/_runtime_svelte_component_application.ApplicationShell.Props.html new file mode 100644 index 0000000..6252daf --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.ApplicationShell.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        appOffsetHeight?: boolean;
                        appOffsetWidth?: boolean;
                        contentOffsetHeight?: boolean;
                        contentOffsetWidth?: boolean;
                        draggable?: any;
                        draggableOptions?: any;
                        elementContent?: any;
                        elementRoot?: any;
                        inTransition?: () => undefined;
                        inTransitionOptions?: {};
                        outTransition?: () => undefined;
                        outTransitionOptions?: {};
                        stylesApp?: any;
                        stylesContent?: any;
                        transition?: () => undefined;
                        transitionOptions?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.ApplicationShell.Slots.html b/docs/types/_runtime_svelte_component_application.ApplicationShell.Slots.html new file mode 100644 index 0000000..25548e3 --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.ApplicationShell.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Events.html b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Events.html new file mode 100644 index 0000000..3e865c1 --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Props.html b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Props.html new file mode 100644 index 0000000..ae860a0 --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        appOffsetHeight?: boolean;
                        appOffsetWidth?: boolean;
                        elementContent?: any;
                        elementRoot?: any;
                        inTransition?: () => undefined;
                        inTransitionOptions?: {};
                        outTransition?: () => undefined;
                        outTransitionOptions?: {};
                        stylesApp?: any;
                        transition?: () => undefined;
                        transitionOptions?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Slots.html b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Slots.html new file mode 100644 index 0000000..d8c3a28 --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Events.html b/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Events.html new file mode 100644 index 0000000..fca6efa --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Props.html b/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Props.html new file mode 100644 index 0000000..b761841 --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        appOffsetHeight?: boolean;
                        appOffsetWidth?: boolean;
                        contentOffsetHeight?: boolean;
                        contentOffsetWidth?: boolean;
                        draggable?: any;
                        draggableOptions?: any;
                        elementContent?: any;
                        elementRoot?: any;
                        inTransition?: () => undefined;
                        inTransitionOptions?: {};
                        outTransition?: () => undefined;
                        outTransitionOptions?: {};
                        stylesApp?: any;
                        stylesContent?: any;
                        transition?: () => undefined;
                        transitionOptions?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Slots.html b/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Slots.html new file mode 100644 index 0000000..ad4711c --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.TJSApplicationShell.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.TJSGlassPane.Events.html b/docs/types/_runtime_svelte_component_application.TJSGlassPane.Events.html new file mode 100644 index 0000000..844076c --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.TJSGlassPane.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: {
                        "glasspane:close":
                            | PointerEvent
                            | MouseEvent
                            | UIEvent
                            | Event
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | KeyboardEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                        "glasspane:keydown:escape":
                            | PointerEvent
                            | MouseEvent
                            | UIEvent
                            | Event
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | KeyboardEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                        "glasspane:pointerdown":
                            | PointerEvent
                            | MouseEvent
                            | UIEvent
                            | Event
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | KeyboardEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                    } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.TJSGlassPane.Props.html b/docs/types/_runtime_svelte_component_application.TJSGlassPane.Props.html new file mode 100644 index 0000000..e63d730 --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.TJSGlassPane.Props.html @@ -0,0 +1,4 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        background?: string;
                        captureInput?: boolean;
                        closeOnInput?: boolean;
                        id?: string;
                        inTransition?: any;
                        inTransitionOptions?: {};
                        outTransition?: any;
                        outTransitionOptions?: {};
                        slotSeparate?: boolean;
                        styles?: { [key: string]: string };
                        transition?: any;
                        transitionOptions?: any;
                        zIndex?: number;
                    }

                    Props type alias for associated component.

                    +

                    Type declaration

                    • Optionalbackground?: string
                    • OptionalcaptureInput?: boolean
                    • OptionalcloseOnInput?: boolean

                      When true any input fires an event glasspane:close.

                      +
                    • Optionalid?: string
                    • OptionalinTransition?: any
                    • OptionalinTransitionOptions?: {}
                    • OptionaloutTransition?: any
                    • OptionaloutTransitionOptions?: {}
                    • OptionalslotSeparate?: boolean
                    • Optionalstyles?: { [key: string]: string }
                    • Optionaltransition?: any
                    • OptionaltransitionOptions?: any
                    • OptionalzIndex?: number

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.TJSGlassPane.Slots.html b/docs/types/_runtime_svelte_component_application.TJSGlassPane.Slots.html new file mode 100644 index 0000000..7d075e0 --- /dev/null +++ b/docs/types/_runtime_svelte_component_application.TJSGlassPane.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI.AnimationKey.html b/docs/types/_runtime_svelte_store_position.AnimationAPI.AnimationKey.html new file mode 100644 index 0000000..660d7fa --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI.AnimationKey.html @@ -0,0 +1,3 @@ +AnimationKey | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias AnimationKey

                    AnimationKey:
                        | "left"
                        | "top"
                        | "maxWidth"
                        | "maxHeight"
                        | "minWidth"
                        | "minHeight"
                        | "width"
                        | "height"
                        | "rotateX"
                        | "rotateY"
                        | "rotateZ"
                        | "scale"
                        | "translateX"
                        | "translateY"
                        | "translateZ"
                        | "zIndex"
                        | "rotation"

                    The position keys that can be animated.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI.GroupCallbackOptions.html b/docs/types/_runtime_svelte_store_position.AnimationAPI.GroupCallbackOptions.html new file mode 100644 index 0000000..c6dd2c1 --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI.GroupCallbackOptions.html @@ -0,0 +1,7 @@ +GroupCallbackOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias GroupCallbackOptions

                    GroupCallbackOptions: {
                        entry?: Positionable;
                        index?: number;
                        position?: TJSPosition;
                    }

                    Options passed to any group animation callbacks for Data.TJSPositionDataRelative data or +TweenOptions.

                    +

                    Type declaration

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI.QuickTweenOptions.html b/docs/types/_runtime_svelte_store_position.AnimationAPI.QuickTweenOptions.html new file mode 100644 index 0000000..4e18b8b --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI.QuickTweenOptions.html @@ -0,0 +1,6 @@ +QuickTweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias QuickTweenOptions

                    QuickTweenOptions: {
                        duration?: number;
                        ease?: EasingReference;
                        interpolate?: InterpolateFunctionName;
                    }

                    Defines the quick tweening options.

                    +

                    Type declaration

                    • Optionalduration?: number

                      Duration in seconds; default: 1

                      +
                    • Optionalease?: EasingReference

                      Easing function or easing function name; controls the time variable for interpolation. Default: cubicOut

                      +
                    • Optionalinterpolate?: InterpolateFunctionName

                      Interpolation function name. Currently, only lerp is supported and doesn't need to be specified.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI.ScheduleOptions.html b/docs/types/_runtime_svelte_store_position.AnimationAPI.ScheduleOptions.html new file mode 100644 index 0000000..6edb3d7 --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI.ScheduleOptions.html @@ -0,0 +1,5 @@ +ScheduleOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias ScheduleOptions

                    ScheduleOptions: { active?: boolean; pending?: boolean }

                    Defines options for the AnimationGroupAPI.isScheduled.

                    +

                    Type declaration

                    • Optionalactive?: boolean

                      When false exclude searching active animations.

                      +
                    • Optionalpending?: boolean

                      When false exclude searching pending animations that have not started.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.TweenOptions.html b/docs/types/_runtime_svelte_store_position.AnimationAPI.TweenOptions.html similarity index 63% rename from docs/types/_runtime_svelte_store_position.AnimationAPI-1.TweenOptions.html rename to docs/types/_runtime_svelte_store_position.AnimationAPI.TweenOptions.html index 6009d48..a59106f 100644 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.TweenOptions.html +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI.TweenOptions.html @@ -1,11 +1,11 @@ -TweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                    -

                    Type Alias TweenOptions

                    TweenOptions: QuickTweenOptions & {
                        delay?: number;
                        strategy?: "cancel" | "cancelAll" | "exclusive";
                        transformOrigin?: TransformOrigin;
                    }

                    Defines the tweening options.

                    -

                    Type declaration

                    • Optionaldelay?: number

                      Delay in seconds before animation starts; default: 0

                      -
                    • Optionalstrategy?: "cancel" | "cancelAll" | "exclusive"

                      Defines the scheduling strategy for handling new animations when an existing animation is already scheduled for +TweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                      +

                      Type Alias TweenOptions

                      TweenOptions: QuickTweenOptions & {
                          delay?: number;
                          strategy?: "cancel" | "cancelAll" | "exclusive";
                          transformOrigin?: TransformOrigin;
                      }

                      Defines the tweening options.

                      +

                      Type declaration

                      • Optionaldelay?: number

                        Delay in seconds before animation starts; default: 0

                        +
                      • Optionalstrategy?: "cancel" | "cancelAll" | "exclusive"

                        Defines the scheduling strategy for handling new animations when an existing animation is already scheduled for the same target.

                        - `cancel`: Cancels any non `quickTo` pending and ongoing animations on the same target and schedules the new
                          animation immediately. This option ensures that the new animation takes precedence by clearing any existing
                          animations.

                        - `cancelAll`: Cancels _all_ pending and ongoing animations on the same target and schedules the new animation
                          immediately. This option ensures that the new animation takes precedence by clearing any existing animations.

                        - `exclusive`: Only schedules the new animation if there are no other animations currently scheduled for the
                          same target. This option avoids animation conflicts by ensuring that only one animation can run at a time.
                        -
                      • OptionaltransformOrigin?: TransformOrigin

                        A transform origin to apply for the animation. The initial transform origin is reset when the animation +

                      • OptionaltransformOrigin?: TransformOrigin

                        A transform origin to apply for the animation. The initial transform origin is reset when the animation finishes.

                        -

                      Settings

                      Member Visibility
                      \ No newline at end of file +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TransformAPI.TransformOrigin.html b/docs/types/_runtime_svelte_store_position.TransformAPI.TransformOrigin.html new file mode 100644 index 0000000..a753fab --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.TransformAPI.TransformOrigin.html @@ -0,0 +1,3 @@ +TransformOrigin | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias TransformOrigin

                    TransformOrigin:
                        | "top left"
                        | "top center"
                        | "top right"
                        | "center left"
                        | "center"
                        | "center right"
                        | "bottom left"
                        | "bottom center"
                        | "bottom right"

                    The supported transform origin strings.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.ValidatorAPI.RemoveByCallback.html b/docs/types/_runtime_svelte_store_position.ValidatorAPI.RemoveByCallback.html new file mode 100644 index 0000000..c05b157 --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.ValidatorAPI.RemoveByCallback.html @@ -0,0 +1,4 @@ +RemoveByCallback | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias RemoveByCallback

                    RemoveByCallback: (data: ValidatorData) => boolean

                    Callback function to evaluate each validator entry. Return true to remove.

                    +

                    Type declaration

                      • (data: ValidatorData): boolean

                      • Parameters

                        • data: ValidatorData

                          ValidatorData instance to potentially filter / remove.

                          +

                        Returns boolean

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidationData.html b/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidationData.html new file mode 100644 index 0000000..21b186d --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidationData.html @@ -0,0 +1,18 @@ +ValidationData | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias ValidationData

                    ValidationData: {
                        computed: CSSStyleDeclaration;
                        el: HTMLElement;
                        height: number;
                        marginLeft: number | undefined;
                        marginTop: number | undefined;
                        maxHeight: number | undefined;
                        maxWidth: number | undefined;
                        minHeight: number | undefined;
                        minWidth: number | undefined;
                        parent: PositionParent;
                        position: TJSPositionData;
                        rest: { [key: string]: any } | undefined;
                        transforms: TransformAPI;
                        width: number;
                    }

                    The data passed to validator functions to determine if the new position / TJSPosition data is valid.

                    +

                    Type declaration

                    • computed: CSSStyleDeclaration

                      Computed styles for the element.

                      +
                    • el: HTMLElement

                      Associated element being positioned.

                      +
                    • height: number

                      Current height

                      +
                    • marginLeft: number | undefined

                      Current left margin.

                      +
                    • marginTop: number | undefined

                      Current top margin.

                      +
                    • maxHeight: number | undefined

                      Current max height.

                      +
                    • maxWidth: number | undefined

                      Current max width.

                      +
                    • minHeight: number | undefined

                      Current min height.

                      +
                    • minWidth: number | undefined

                      Current min width.

                      +
                    • parent: PositionParent

                      Associated position parent instance.

                      +
                    • position: TJSPositionData

                      New position data to evaluate.

                      +
                    • rest: { [key: string]: any } | undefined

                      The rest of any data submitted to TJSPosition.set. This may be used to provide directives to +validators.

                      +
                    • transforms: TransformAPI

                      Current applies transforms / transform tracking & conversion utility.

                      +
                    • width: number

                      Current width

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidatorData.html b/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidatorData.html new file mode 100644 index 0000000..14c82a3 --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidatorData.html @@ -0,0 +1,10 @@ +ValidatorData | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias ValidatorData

                    ValidatorData: {
                        id?: any;
                        validate: ValidatorFn;
                        weight?: number;
                        subscribe(
                            this: void,
                            run: Subscriber<any>,
                            invalidate?: Invalidator<any>,
                        ): Unsubscriber;
                    }

                    Defines a validator function entry with optional data such as assigning an id / weight or providing more +interactivity through attaching a subscriber function to monitor for updates that triggers validation.

                    +

                    Type declaration

                    • Optionalid?: any

                      An ID associated with this validator. Can be used to remove the validator; default: undefined.

                      +
                    • validate: ValidatorFn

                      TJSPosition validator function that takes a Data.TJSPositionData instance potentially modifying it or +returning null if invalid.

                      +
                    • Optionalweight?: number

                      A number between 0 and 1 inclusive to position this validator against others; default: 1.

                      +
                    • subscribe?:function
                      • subscribe(
                            this: void,
                            run: Subscriber<any>,
                            invalidate?: Invalidator<any>,
                        ): Unsubscriber

                      • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will +be processed again.

                        +

                        Parameters

                        Returns Unsubscriber

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidatorOption.html b/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidatorOption.html new file mode 100644 index 0000000..2614c45 --- /dev/null +++ b/docs/types/_runtime_svelte_store_position.ValidatorAPI.ValidatorOption.html @@ -0,0 +1,3 @@ +ValidatorOption | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias ValidatorOption

                    ValidatorOption:
                        | ValidatorFn
                        | ValidatorData
                        | Iterable<ValidatorFn | ValidatorData>

                    Defines the TJSPosition validator option.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array-object.ArrayObjectStoreParams.html b/docs/types/_runtime_svelte_store_reducer_array-object.ArrayObjectStoreParams.html new file mode 100644 index 0000000..5b8b0cd --- /dev/null +++ b/docs/types/_runtime_svelte_store_reducer_array-object.ArrayObjectStoreParams.html @@ -0,0 +1,11 @@ +ArrayObjectStoreParams | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias ArrayObjectStoreParams

                    ArrayObjectStoreParams: {
                        childDebounce?: number;
                        dataReducer?: boolean;
                        defaultData?: object[];
                        manualUpdate?: boolean;
                        StoreClass: BaseArrayObjectEntryStore;
                    }

                    Type declaration

                    • OptionalchildDebounce?: number

                      An integer between and including 0 - 1000; a debounce time in +milliseconds for child store subscriptions to invoke ArrayObjectStore.updateSubscribers notifying +subscribers to this array store.

                      +
                    • OptionaldataReducer?: boolean

                      When true a DynArrayReducer will be instantiated wrapping store +data and accessible from ArrayObjectStore.dataReducer.

                      +
                    • OptionaldefaultData?: object[]

                      An array of default data objects.

                      +
                    • OptionalmanualUpdate?: boolean

                      When true ArrayObjectStore.updateSubscribers must be invoked +with a single boolean parameter for subscribers to be updated.

                      +
                    • StoreClass: BaseArrayObjectEntryStore

                      The entry store class that is instantiated.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array-object.ArrayObjectUpdateData.html b/docs/types/_runtime_svelte_store_reducer_array-object.ArrayObjectUpdateData.html new file mode 100644 index 0000000..7bf0dec --- /dev/null +++ b/docs/types/_runtime_svelte_store_reducer_array-object.ArrayObjectUpdateData.html @@ -0,0 +1,2 @@ +ArrayObjectUpdateData | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias ArrayObjectUpdateData

                    ArrayObjectUpdateData: boolean | object | undefined

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array-object.BaseArrayObjectEntryStore.html b/docs/types/_runtime_svelte_store_reducer_array-object.BaseArrayObjectEntryStore.html new file mode 100644 index 0000000..dd878d8 --- /dev/null +++ b/docs/types/_runtime_svelte_store_reducer_array-object.BaseArrayObjectEntryStore.html @@ -0,0 +1,2 @@ +BaseArrayObjectEntryStore | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias BaseArrayObjectEntryStore

                    BaseArrayObjectEntryStore: Writable<any> & { get id(): string }

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStoreParamProps.html b/docs/types/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStoreParamProps.html new file mode 100644 index 0000000..43d3746 --- /dev/null +++ b/docs/types/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStoreParamProps.html @@ -0,0 +1,8 @@ +CrudArrayObjectStoreParamProps | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias CrudArrayObjectStoreParamProps

                    CrudArrayObjectStoreParamProps: {
                        crudDispatch?: CrudDispatch;
                        extraData?: object;
                    }

                    Type declaration

                    • OptionalcrudDispatch?: CrudDispatch
                        +
                      • +
                      +
                    • OptionalextraData?: object
                        +
                      • +
                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStoreParams.html b/docs/types/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStoreParams.html new file mode 100644 index 0000000..b6d799a --- /dev/null +++ b/docs/types/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStoreParams.html @@ -0,0 +1,2 @@ +CrudArrayObjectStoreParams | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias CrudArrayObjectStoreParams

                    CrudArrayObjectStoreParams: ArrayObjectStoreParams & CrudArrayObjectStoreParamProps

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array-object.CrudDispatch.html b/docs/types/_runtime_svelte_store_reducer_array-object.CrudDispatch.html new file mode 100644 index 0000000..37a8376 --- /dev/null +++ b/docs/types/_runtime_svelte_store_reducer_array-object.CrudDispatch.html @@ -0,0 +1,4 @@ +CrudDispatch | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias CrudDispatch

                    CrudDispatch: (data: { action: string; data?: object; id?: string }) => boolean

                    A function that accepts an object w/ 'action', 'moduleId', 'key' properties and optional 'id' / UUIDv4 string and +'data' property.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_web-storage.StorageDerived.html b/docs/types/_runtime_svelte_store_web-storage.StorageDerived.html new file mode 100644 index 0000000..73742b6 --- /dev/null +++ b/docs/types/_runtime_svelte_store_web-storage.StorageDerived.html @@ -0,0 +1,7 @@ +StorageDerived | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias StorageDerived

                    StorageDerived: <S extends Stores, T>(
                        key: string,
                        stores: S,
                        fn: Deriver<S, T>,
                        initial_value?: T,
                    ) => Readable<T>

                    Type declaration

                      • <S extends Stores, T>(
                            key: string,
                            stores: S,
                            fn: Deriver<S, T>,
                            initial_value?: T,
                        ): Readable<T>

                      • Type Parameters

                        Parameters

                        • key: string

                          Storage key.

                          +
                        • stores: S

                          Input stores.

                          +
                        • fn: Deriver<S, T>

                          Function callback that aggregates the values.

                          +
                        • Optionalinitial_value: T

                          When used asynchronously.

                          +

                        Returns Readable<T>

                        A derived storage store.

                        +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_web-storage.StorageReadable.html b/docs/types/_runtime_svelte_store_web-storage.StorageReadable.html new file mode 100644 index 0000000..f379ed4 --- /dev/null +++ b/docs/types/_runtime_svelte_store_web-storage.StorageReadable.html @@ -0,0 +1,7 @@ +StorageReadable | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias StorageReadable

                    StorageReadable: <T>(
                        key: string,
                        value: T,
                        start: StartStopNotifier<T>,
                    ) => Readable<T>

                    Type declaration

                      • <T>(key: string, value: T, start: StartStopNotifier<T>): Readable<T>

                      • Type Parameters

                        • T

                          Creates a Readable store that allows reading by subscription.

                          +

                        Parameters

                        • key: string

                          storage key

                          +
                        • value: T

                          initial value

                          +
                        • start: StartStopNotifier<T>

                          Start and stop notifications for subscriptions.

                          +

                        Returns Readable<T>

                        A readable storage store.

                        +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_web-storage.StorageStores.html b/docs/types/_runtime_svelte_store_web-storage.StorageStores.html new file mode 100644 index 0000000..07bbf46 --- /dev/null +++ b/docs/types/_runtime_svelte_store_web-storage.StorageStores.html @@ -0,0 +1,4 @@ +StorageStores | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias StorageStores

                    StorageStores: {
                        derived: StorageDerived;
                        deserialize: (value: string, ...rest: any[]) => any;
                        readable: StorageReadable;
                        serialize: (value: any, ...rest: any[]) => string;
                        storage: Storage;
                        writable: StorageWritable;
                    }

                    The generated web storage store helper functions along with the associated storage API source and serialization +strategy.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_web-storage.StorageWritable.html b/docs/types/_runtime_svelte_store_web-storage.StorageWritable.html new file mode 100644 index 0000000..feb1ee6 --- /dev/null +++ b/docs/types/_runtime_svelte_store_web-storage.StorageWritable.html @@ -0,0 +1,7 @@ +StorageWritable | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias StorageWritable

                    StorageWritable: <T>(
                        key: string,
                        value: T,
                        start?: StartStopNotifier<T>,
                    ) => Writable<T>

                    Type declaration

                      • <T>(key: string, value: T, start?: StartStopNotifier<T>): Writable<T>

                      • Type Parameters

                        • T

                          Create a Writable store that allows both updating and reading by subscription.

                          +

                        Parameters

                        • key: string

                          Storage key.

                          +
                        • value: T

                          Default value.

                          +
                        • Optionalstart: StartStopNotifier<T>

                          Start and stop notifications for subscriptions.

                          +

                        Returns Writable<T>

                        A writable storage store.

                        +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_writable-derived.SetValues.html b/docs/types/_runtime_svelte_store_writable-derived.SetValues.html new file mode 100644 index 0000000..5837cba --- /dev/null +++ b/docs/types/_runtime_svelte_store_writable-derived.SetValues.html @@ -0,0 +1,3 @@ +SetValues | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias SetValues<T>

                    SetValues: T extends MinimalWritable<infer U>
                        ? U
                        : { [K in keyof T]?: T[K] extends MinimalWritable<infer U> ? U : never }

                    Values sent to origin stores.

                    +

                    Type Parameters

                    • T

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_writable-derived.Stores.html b/docs/types/_runtime_svelte_store_writable-derived.Stores.html new file mode 100644 index 0000000..9bb81f5 --- /dev/null +++ b/docs/types/_runtime_svelte_store_writable-derived.Stores.html @@ -0,0 +1,3 @@ +Stores | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Stores

                    Stores:
                        | MinimalWritable<any>
                        | [Readable<any>, ...Readable<any>[]]
                        | Readable<any>[]

                    Stores that may be used as origins.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_writable-derived.StoresValues.html b/docs/types/_runtime_svelte_store_writable-derived.StoresValues.html new file mode 100644 index 0000000..919a3db --- /dev/null +++ b/docs/types/_runtime_svelte_store_writable-derived.StoresValues.html @@ -0,0 +1,3 @@ +StoresValues | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias StoresValues<T>

                    StoresValues: T extends Readable<infer U>
                        ? U
                        : { [K in keyof T]: T[K] extends Readable<infer U> ? U : never }

                    Values retrieved from origin stores.

                    +

                    Type Parameters

                    • T

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_runtime_util_loader-module.ModuleLoaderObj.html b/docs/types/_runtime_util_loader-module.ModuleLoaderObj.html new file mode 100644 index 0000000..be8423c --- /dev/null +++ b/docs/types/_runtime_util_loader-module.ModuleLoaderObj.html @@ -0,0 +1,12 @@ +ModuleLoaderObj | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias ModuleLoaderObj<M, E>

                    ModuleLoaderObj: {
                        filepath: string;
                        instance: E;
                        isESM: boolean;
                        loadpath: string;
                        module: M;
                        modulepath: string | URL;
                        type:
                            | "import-module"
                            | "import-path"
                            | "import-url"
                            | "require-module"
                            | "require-path"
                            | "require-url";
                    }

                    The object passed back from ModuleLoader.load.

                    +

                    Type Parameters

                    • M
                    • E

                    Type declaration

                    • filepath: string

                      If available the file path on Node otherwise this will match loadpath in the +browser.

                      +
                    • instance: E

                      Either the module itself or any particular export the resolveModule function +selects.

                      +
                    • isESM: boolean

                      Indicates if the import was an ES Module.

                      +
                    • loadpath: string

                      A string representation of the module path being loaded.

                      +
                    • module: M

                      The direct module import.

                      +
                    • modulepath: string | URL

                      The initial string or URL sent to ModuleLoader.

                      +
                    • type:
                          | "import-module"
                          | "import-path"
                          | "import-url"
                          | "require-module"
                          | "require-path"
                          | "require-url"

                      The type and how the module was loaded.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSIconButton.Events.html b/docs/types/_standard_component_button.TJSIconButton.Events.html new file mode 100644 index 0000000..614b266 --- /dev/null +++ b/docs/types/_standard_component_button.TJSIconButton.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { click: MouseEvent; contextmenu: MouseEvent; press: CustomEvent<any> } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSIconButton.Props.html b/docs/types/_standard_component_button.TJSIconButton.Props.html new file mode 100644 index 0000000..88662b3 --- /dev/null +++ b/docs/types/_standard_component_button.TJSIconButton.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        button?: any;
                        clickPropagate?: any;
                        efx?: any;
                        enabled?: any;
                        icon?: any;
                        keyCode?: any;
                        onContextMenu?: any;
                        onPress?: any;
                        styles?: any;
                        title?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSIconButton.Slots.html b/docs/types/_standard_component_button.TJSIconButton.Slots.html new file mode 100644 index 0000000..583fb02 --- /dev/null +++ b/docs/types/_standard_component_button.TJSIconButton.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSSlotButton.Events.html b/docs/types/_standard_component_button.TJSSlotButton.Events.html new file mode 100644 index 0000000..48e061d --- /dev/null +++ b/docs/types/_standard_component_button.TJSSlotButton.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { click: MouseEvent; contextmenu: MouseEvent; press: CustomEvent<any> } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSSlotButton.Props.html b/docs/types/_standard_component_button.TJSSlotButton.Props.html new file mode 100644 index 0000000..10c1266 --- /dev/null +++ b/docs/types/_standard_component_button.TJSSlotButton.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        button?: any;
                        clickPropagate?: any;
                        efx?: any;
                        enabled?: any;
                        keyCode?: any;
                        onContextMenu?: any;
                        onPress?: any;
                        styles?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSSlotButton.Slots.html b/docs/types/_standard_component_button.TJSSlotButton.Slots.html new file mode 100644 index 0000000..d36cb95 --- /dev/null +++ b/docs/types/_standard_component_button.TJSSlotButton.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSToggleIconButton.Events.html b/docs/types/_standard_component_button.TJSToggleIconButton.Events.html new file mode 100644 index 0000000..60b3f6c --- /dev/null +++ b/docs/types/_standard_component_button.TJSToggleIconButton.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { click: MouseEvent; contextmenu: MouseEvent; press: CustomEvent<any> } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSToggleIconButton.Props.html b/docs/types/_standard_component_button.TJSToggleIconButton.Props.html new file mode 100644 index 0000000..5940999 --- /dev/null +++ b/docs/types/_standard_component_button.TJSToggleIconButton.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        button?: any;
                        clickPropagate?: any;
                        efx?: any;
                        enabled?: any;
                        icon?: any;
                        keyCode?: any;
                        onClose?: any;
                        onContextMenu?: any;
                        onPress?: any;
                        store?: any;
                        styles?: any;
                        title?: any;
                        titleSelected?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_button.TJSToggleIconButton.Slots.html b/docs/types/_standard_component_button.TJSToggleIconButton.Slots.html new file mode 100644 index 0000000..d6930da --- /dev/null +++ b/docs/types/_standard_component_button.TJSToggleIconButton.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordButton.Events.html b/docs/types/_standard_component_color_picker-colord.TJSColordButton.Events.html new file mode 100644 index 0000000..184382e --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordButton.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { click: MouseEvent; contextmenu: MouseEvent; press: CustomEvent<any> } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordButton.Props.html b/docs/types/_standard_component_color_picker-colord.TJSColordButton.Props.html new file mode 100644 index 0000000..bcc7b0b --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordButton.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        button?: any;
                        clickPropagate?: any;
                        color?: any;
                        efx?: any;
                        enabled?: any;
                        keyCode?: any;
                        onContextMenu?: any;
                        onPress?: any;
                        styles?: any;
                        title?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordButton.Slots.html b/docs/types/_standard_component_color_picker-colord.TJSColordButton.Slots.html new file mode 100644 index 0000000..ee2da45 --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordButton.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Events.html b/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Events.html new file mode 100644 index 0000000..f5a931a --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { color: CustomEvent<any> } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Props.html b/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Props.html new file mode 100644 index 0000000..7c5a561 --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Props.html @@ -0,0 +1,7 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        color?: TJSColordPickerColor;
                        options?: TJSColordPickerOptions;
                        webStorage?: WebStorage;
                    }

                    Props type alias for associated component.

                    +

                    Type declaration

                    • Optionalcolor?: TJSColordPickerColor

                      color properties

                      +
                    • Optionaloptions?: TJSColordPickerOptions

                      User settable options / customization properties.

                      +
                    • OptionalwebStorage?: WebStorage

                      External shared WebStorage instance. By assigning an external WebStorage instance you can share state like +the saved colors plugin across color picker instances.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Slots.html b/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Slots.html new file mode 100644 index 0000000..5cae032 --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordPicker.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordPickerColor.html b/docs/types/_standard_component_color_picker-colord.TJSColordPickerColor.html new file mode 100644 index 0000000..e8568cd --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordPickerColor.html @@ -0,0 +1,2 @@ +TJSColordPickerColor | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias TJSColordPickerColor

                    TJSColordPickerColor: object | string

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordPickerComponents.html b/docs/types/_standard_component_color_picker-colord.TJSColordPickerComponents.html new file mode 100644 index 0000000..4abb0ee --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordPickerComponents.html @@ -0,0 +1,11 @@ +TJSColordPickerComponents | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias TJSColordPickerComponents

                    TJSColordPickerComponents: {
                        alphaIndicator?: SvelteComponent;
                        alphaWrapper?: SvelteComponent;
                        focusWrap?: SvelteComponent;
                        pickerIndicator?: SvelteComponent;
                        pickerWrapper?: SvelteComponent;
                        sliderIndicator?: SvelteComponent;
                        sliderWrapper?: SvelteComponent;
                        textInput?: SvelteComponent;
                        wrapper?: SvelteComponent;
                    }

                    Type declaration

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker-colord.TJSColordPickerOptions.html b/docs/types/_standard_component_color_picker-colord.TJSColordPickerOptions.html new file mode 100644 index 0000000..5cec670 --- /dev/null +++ b/docs/types/_standard_component_color_picker-colord.TJSColordPickerOptions.html @@ -0,0 +1,22 @@ +TJSColordPickerOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias TJSColordPickerOptions

                    TJSColordPickerOptions: {
                        addons?: Iterable<Function>;
                        components?: TJSColordPickerComponents;
                        enabled?: boolean;
                        format?: "hex" | "hsl" | "hsv" | "rgb";
                        formatType?: "object" | "string";
                        hasAddons?: boolean;
                        hasAlpha?: boolean;
                        hasButtonBar?: boolean;
                        hasEyeDropper?: boolean;
                        hasTextInput?: boolean;
                        inputName?: string;
                        isPopup?: boolean;
                        layout?: "chrome";
                        lockTextFormat?: boolean;
                        precision?: number;
                        store?: MinimalWritable<TJSColordPickerColor>;
                        styles?: object;
                        width?: number | string;
                    }

                    Type declaration

                    • Optionaladdons?: Iterable<Function>

                      Iterable list of addon class constructor functions.

                      +
                    • Optionalcomponents?: TJSColordPickerComponents

                      User defined picker component overrides.

                      +
                    • Optionalenabled?: boolean

                      Enable state of the color picker input.

                      +
                    • Optionalformat?: "hex" | "hsl" | "hsv" | "rgb"

                      The user defined color format.

                      +
                    • OptionalformatType?: "object" | "string"

                      The user defined color format type.

                      +
                    • OptionalhasAddons?: boolean

                      Enables the addons panel / can set to false to hide panel when addons loaded.

                      +
                    • OptionalhasAlpha?: boolean

                      Enables alpha / opacity color selection and output.

                      +
                    • OptionalhasButtonBar?: boolean

                      Enables the button bar.

                      +
                    • OptionalhasEyeDropper?: boolean

                      Enables eye dropper support if available (requires secure context).

                      +
                    • OptionalhasTextInput?: boolean

                      Enables text input component.

                      +
                    • OptionalinputName?: string

                      Name attribute for hidden input element / form submission.

                      +
                    • OptionalisPopup?: boolean

                      Is the picker configured as a pop-up.

                      +
                    • Optionallayout?: "chrome"

                      Picker layout variant.

                      +
                    • OptionallockTextFormat?: boolean

                      When true text input format can not be changed from current format.

                      +
                    • Optionalprecision?: number

                      A positive integer defining rounding precision.

                      +
                    • Optionalstore?: MinimalWritable<TJSColordPickerColor>

                      An external minimal +writable store to update current color.

                      +
                    • Optionalstyles?: object

                      Inline styles to apply to TJSColordPicker span; useful to set CSS variables.

                      +
                    • Optionalwidth?: number | string

                      A positive integer greater than 50 defining the main container width in +pixels or a valid CSS dimension string.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_container.TJSScrollContainer.Events.html b/docs/types/_standard_component_container.TJSScrollContainer.Events.html new file mode 100644 index 0000000..dc4b930 --- /dev/null +++ b/docs/types/_standard_component_container.TJSScrollContainer.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_container.TJSScrollContainer.Props.html b/docs/types/_standard_component_container.TJSScrollContainer.Props.html new file mode 100644 index 0000000..f5e18d0 --- /dev/null +++ b/docs/types/_standard_component_container.TJSScrollContainer.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        container?: TJSScrollContainerData;
                        scrollTop?: Writable<number>;
                        styles?: { [key: string]: string };
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_container.TJSScrollContainer.Slots.html b/docs/types/_standard_component_container.TJSScrollContainer.Slots.html new file mode 100644 index 0000000..4725aca --- /dev/null +++ b/docs/types/_standard_component_container.TJSScrollContainer.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_dom_focus.TJSFocusWrap.Events.html b/docs/types/_standard_component_dom_focus.TJSFocusWrap.Events.html new file mode 100644 index 0000000..85e9c6e --- /dev/null +++ b/docs/types/_standard_component_dom_focus.TJSFocusWrap.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_dom_focus.TJSFocusWrap.Props.html b/docs/types/_standard_component_dom_focus.TJSFocusWrap.Props.html new file mode 100644 index 0000000..996daa0 --- /dev/null +++ b/docs/types/_standard_component_dom_focus.TJSFocusWrap.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: { elementRoot?: HTMLElement; enabled?: boolean }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_dom_focus.TJSFocusWrap.Slots.html b/docs/types/_standard_component_dom_focus.TJSFocusWrap.Slots.html new file mode 100644 index 0000000..247e9ab --- /dev/null +++ b/docs/types/_standard_component_dom_focus.TJSFocusWrap.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_folder.TJSIconFolder.Events.html b/docs/types/_standard_component_folder.TJSIconFolder.Events.html new file mode 100644 index 0000000..51a759c --- /dev/null +++ b/docs/types/_standard_component_folder.TJSIconFolder.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: {
                        click: MouseEvent;
                        close: Event;
                        closeAny:
                            | KeyboardEvent
                            | UIEvent
                            | Event
                            | PointerEvent
                            | MouseEvent
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                        keydown: KeyboardEvent;
                        keyup: KeyboardEvent;
                        open:
                            | KeyboardEvent
                            | UIEvent
                            | Event
                            | PointerEvent
                            | MouseEvent
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                        openAny:
                            | KeyboardEvent
                            | UIEvent
                            | Event
                            | PointerEvent
                            | MouseEvent
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                    } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_folder.TJSIconFolder.Props.html b/docs/types/_standard_component_folder.TJSIconFolder.Props.html new file mode 100644 index 0000000..6213af9 --- /dev/null +++ b/docs/types/_standard_component_folder.TJSIconFolder.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        animate?: boolean;
                        enabled?: boolean;
                        folder?: TJSIconFolderData;
                        iconClosed?: string;
                        iconOpen?: string;
                        id?: string;
                        keyCode?: string;
                        label?: string;
                        onClose?: (data?: { event?: KeyboardEvent | PointerEvent }) => void;
                        onContextMenu?: (data?: { event?: PointerEvent }) => void;
                        onOpen?: (data?: { event?: KeyboardEvent | PointerEvent }) => void;
                        options?: TJSFolderOptions;
                        store?: MinimalWritable<boolean>;
                        styles?: object;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_folder.TJSIconFolder.Slots.html b/docs/types/_standard_component_folder.TJSIconFolder.Slots.html new file mode 100644 index 0000000..4f3affd --- /dev/null +++ b/docs/types/_standard_component_folder.TJSIconFolder.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {}; label: {}; "summary-end": {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_folder.TJSSvgFolder.Events.html b/docs/types/_standard_component_folder.TJSSvgFolder.Events.html new file mode 100644 index 0000000..c2b5c4f --- /dev/null +++ b/docs/types/_standard_component_folder.TJSSvgFolder.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: {
                        click: MouseEvent;
                        close: Event;
                        closeAny:
                            | KeyboardEvent
                            | UIEvent
                            | Event
                            | PointerEvent
                            | MouseEvent
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                        keydown: KeyboardEvent;
                        keyup: KeyboardEvent;
                        open:
                            | KeyboardEvent
                            | UIEvent
                            | Event
                            | PointerEvent
                            | MouseEvent
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                        openAny:
                            | KeyboardEvent
                            | UIEvent
                            | Event
                            | PointerEvent
                            | MouseEvent
                            | ErrorEvent
                            | AnimationEvent
                            | ClipboardEvent
                            | CompositionEvent
                            | DragEvent
                            | FocusEvent
                            | FormDataEvent
                            | InputEvent
                            | ProgressEvent<EventTarget>
                            | SecurityPolicyViolationEvent
                            | SubmitEvent
                            | TouchEvent
                            | TransitionEvent
                            | WheelEvent;
                    } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_folder.TJSSvgFolder.Props.html b/docs/types/_standard_component_folder.TJSSvgFolder.Props.html new file mode 100644 index 0000000..c31f2ef --- /dev/null +++ b/docs/types/_standard_component_folder.TJSSvgFolder.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        animate?: boolean;
                        enabled?: boolean;
                        folder?: TJSFolderData;
                        id?: string;
                        keyCode?: string;
                        label?: string;
                        onClose?: (data?: { event?: KeyboardEvent | PointerEvent }) => void;
                        onContextMenu?: (data?: { event?: PointerEvent }) => void;
                        onOpen?: (data?: { event?: KeyboardEvent | PointerEvent }) => void;
                        options?: TJSFolderOptions;
                        store?: MinimalWritable<boolean>;
                        styles?: object;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_folder.TJSSvgFolder.Slots.html b/docs/types/_standard_component_folder.TJSSvgFolder.Slots.html new file mode 100644 index 0000000..f28a791 --- /dev/null +++ b/docs/types/_standard_component_folder.TJSSvgFolder.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {}; label: {}; "summary-end": {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSButton.Events.html b/docs/types/_standard_component_form.TJSButton.Events.html new file mode 100644 index 0000000..d167ca8 --- /dev/null +++ b/docs/types/_standard_component_form.TJSButton.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { click: MouseEvent; contextmenu: MouseEvent; press: CustomEvent<any> } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSButton.Props.html b/docs/types/_standard_component_form.TJSButton.Props.html new file mode 100644 index 0000000..ff7a4dd --- /dev/null +++ b/docs/types/_standard_component_form.TJSButton.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        button?: any;
                        clickPropagate?: any;
                        efx?: any;
                        enabled?: any;
                        icon?: any;
                        keyCode?: any;
                        label?: any;
                        onContextMenu?: any;
                        onPress?: any;
                        styles?: any;
                        title?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSButton.Slots.html b/docs/types/_standard_component_form.TJSButton.Slots.html new file mode 100644 index 0000000..a42d3c7 --- /dev/null +++ b/docs/types/_standard_component_form.TJSButton.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInput.Events.html b/docs/types/_standard_component_form.TJSInput.Events.html new file mode 100644 index 0000000..11d920a --- /dev/null +++ b/docs/types/_standard_component_form.TJSInput.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { click: any; contextmenu: any; press: any } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInput.Props.html b/docs/types/_standard_component_form.TJSInput.Props.html new file mode 100644 index 0000000..ea32e0d --- /dev/null +++ b/docs/types/_standard_component_form.TJSInput.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: { input?: any; type?: any }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInput.Slots.html b/docs/types/_standard_component_form.TJSInput.Slots.html new file mode 100644 index 0000000..46c82ff --- /dev/null +++ b/docs/types/_standard_component_form.TJSInput.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputCheckbox.Events.html b/docs/types/_standard_component_form.TJSInputCheckbox.Events.html new file mode 100644 index 0000000..31a381e --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputCheckbox.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { pointerdown: PointerEvent } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputCheckbox.Props.html b/docs/types/_standard_component_form.TJSInputCheckbox.Props.html new file mode 100644 index 0000000..ea6f368 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputCheckbox.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        efx?: any;
                        enabled?: any;
                        input?: any;
                        label?: any;
                        readonly?: any;
                        store?: any;
                        styles?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputCheckbox.Slots.html b/docs/types/_standard_component_form.TJSInputCheckbox.Slots.html new file mode 100644 index 0000000..52f1271 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputCheckbox.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputNumber.Events.html b/docs/types/_standard_component_form.TJSInputNumber.Events.html new file mode 100644 index 0000000..e19dff8 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputNumber.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { pointerdown: PointerEvent } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputNumber.Props.html b/docs/types/_standard_component_form.TJSInputNumber.Props.html new file mode 100644 index 0000000..b462af4 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputNumber.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        efx?: any;
                        enabled?: any;
                        input?: any;
                        label?: any;
                        max?: any;
                        min?: any;
                        options?: any;
                        placeholder?: any;
                        readonly?: any;
                        step?: any;
                        store?: any;
                        storeIsValid?: any;
                        styles?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputNumber.Slots.html b/docs/types/_standard_component_form.TJSInputNumber.Slots.html new file mode 100644 index 0000000..f86f3a5 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputNumber.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputRange.Events.html b/docs/types/_standard_component_form.TJSInputRange.Events.html new file mode 100644 index 0000000..f752f4f --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputRange.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { pointerdown: PointerEvent } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputRange.Props.html b/docs/types/_standard_component_form.TJSInputRange.Props.html new file mode 100644 index 0000000..02f915b --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputRange.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        efx?: any;
                        enabled?: any;
                        input?: any;
                        label?: any;
                        max?: any;
                        min?: any;
                        options?: any;
                        readonly?: any;
                        step?: any;
                        store?: any;
                        styles?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputRange.Slots.html b/docs/types/_standard_component_form.TJSInputRange.Slots.html new file mode 100644 index 0000000..9315a49 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputRange.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputRangeNumber.Events.html b/docs/types/_standard_component_form.TJSInputRangeNumber.Events.html new file mode 100644 index 0000000..8ef74ec --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputRangeNumber.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputRangeNumber.Props.html b/docs/types/_standard_component_form.TJSInputRangeNumber.Props.html new file mode 100644 index 0000000..4e388c7 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputRangeNumber.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        efx?: any;
                        enabled?: any;
                        input?: any;
                        label?: any;
                        max?: any;
                        min?: any;
                        options?: any;
                        readonly?: any;
                        step?: any;
                        store?: any;
                        styles?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputRangeNumber.Slots.html b/docs/types/_standard_component_form.TJSInputRangeNumber.Slots.html new file mode 100644 index 0000000..e2d9f32 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputRangeNumber.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputText.Events.html b/docs/types/_standard_component_form.TJSInputText.Events.html new file mode 100644 index 0000000..61530b5 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputText.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { pointerdown: PointerEvent } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputText.Props.html b/docs/types/_standard_component_form.TJSInputText.Props.html new file mode 100644 index 0000000..6bc0f6c --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputText.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        efx?: any;
                        enabled?: any;
                        input?: any;
                        label?: any;
                        options?: any;
                        placeholder?: any;
                        readonly?: any;
                        store?: any;
                        storeIsValid?: any;
                        styles?: any;
                        type?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSInputText.Slots.html b/docs/types/_standard_component_form.TJSInputText.Slots.html new file mode 100644 index 0000000..1aa7286 --- /dev/null +++ b/docs/types/_standard_component_form.TJSInputText.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSSelect.Events.html b/docs/types/_standard_component_form.TJSSelect.Events.html new file mode 100644 index 0000000..7348554 --- /dev/null +++ b/docs/types/_standard_component_form.TJSSelect.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { change: Event; pointerdown: PointerEvent } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSSelect.Props.html b/docs/types/_standard_component_form.TJSSelect.Props.html new file mode 100644 index 0000000..ef1fb19 --- /dev/null +++ b/docs/types/_standard_component_form.TJSSelect.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        efx?: any;
                        enabled?: any;
                        label?: any;
                        options?: any;
                        select?: any;
                        selected?: any;
                        store?: any;
                        styles?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_form.TJSSelect.Slots.html b/docs/types/_standard_component_form.TJSSelect.Slots.html new file mode 100644 index 0000000..9a9de58 --- /dev/null +++ b/docs/types/_standard_component_form.TJSSelect.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Events.html b/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Events.html new file mode 100644 index 0000000..fd397a1 --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: {
                        "editor:cancel": CustomEvent<any>;
                        "editor:document:deleted": CustomEvent<any>;
                        "editor:enrichedContent": CustomEvent<any>;
                        "editor:save": CustomEvent<any>;
                        "editor:start": CustomEvent<any>;
                    } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Props.html b/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Props.html new file mode 100644 index 0000000..3189a40 --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Props.html @@ -0,0 +1,4 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        content?: string;
                        enrichedContent?: string;
                        options?: TJSContentEditOptions;
                    }

                    Props type alias for associated component.

                    +

                    Type declaration

                    • Optionalcontent?: string
                    • OptionalenrichedContent?: string
                    • Optionaloptions?: TJSContentEditOptions

                      Provides the options object that can be reactively updated. See documentation above.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Slots.html b/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Slots.html new file mode 100644 index 0000000..4d119e6 --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSContentEdit.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Events.html b/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Events.html new file mode 100644 index 0000000..62daade --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: {
                        "editor:cancel": CustomEvent<any>;
                        "editor:document:deleted": CustomEvent<any>;
                        "editor:enrichedContent": CustomEvent<any>;
                        "editor:save": CustomEvent<any>;
                        "editor:start": CustomEvent<any>;
                    } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Props.html b/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Props.html new file mode 100644 index 0000000..ad4985b --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Props.html @@ -0,0 +1,4 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        content?: string;
                        enrichedContent?: string;
                        options?: TJSProseMirrorOptions;
                    }

                    Props type alias for associated component.

                    +

                    Type declaration

                    • Optionalcontent?: string
                    • OptionalenrichedContent?: string
                    • Optionaloptions?: TJSProseMirrorOptions

                      Provides the options object that can be reactively updated. See documentation above.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Slots.html b/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Slots.html new file mode 100644 index 0000000..4163122 --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSProseMirror.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Events.html b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Events.html new file mode 100644 index 0000000..b26d2b2 --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: {
                        "editor:cancel": CustomEvent<any>;
                        "editor:document:deleted": CustomEvent<any>;
                        "editor:enrichedContent": CustomEvent<any>;
                        "editor:save": CustomEvent<any>;
                        "editor:start": CustomEvent<any>;
                    } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Props.html b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Props.html new file mode 100644 index 0000000..f20b61d --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Props.html @@ -0,0 +1,4 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        content?: string;
                        enrichedContent?: string;
                        options?: TJSTinyMCEOptions;
                    }

                    Props type alias for associated component.

                    +

                    Type declaration

                    • Optionalcontent?: string
                    • OptionalenrichedContent?: string
                    • Optionaloptions?: TJSTinyMCEOptions

                      Provides the options object that can be reactively updated. See documentation above.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Slots.html b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Slots.html new file mode 100644 index 0000000..3fd7e62 --- /dev/null +++ b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Events.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Events.html new file mode 100644 index 0000000..ad3b342 --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { "filepicker:urlString": CustomEvent<any> } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Props.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Props.html new file mode 100644 index 0000000..d31612a --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        button?: object;
                        pickerOptions?: FVTTFilePickerBrowseOptions;
                        urlString?: string;
                        [x: string]: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Slots.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Slots.html new file mode 100644 index 0000000..3b865e9 --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Events.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Events.html new file mode 100644 index 0000000..bde7521 --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { "filepicker:urlString": CustomEvent<any> } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Props.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Props.html new file mode 100644 index 0000000..f86464e --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        button?: object;
                        pickerOptions?: FVTTFilePickerBrowseOptions;
                        urlString?: string;
                        [x: string]: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Slots.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Slots.html new file mode 100644 index 0000000..fcebdc5 --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Events.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Events.html new file mode 100644 index 0000000..9dead44 --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { "filepicker:urlString": CustomEvent<any> } & {
                        [evt: string]: CustomEvent<any>;
                    }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Props.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Props.html new file mode 100644 index 0000000..4775156 --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        button?: object;
                        pickerOptions?: FVTTFilePickerBrowseOptions;
                        urlString?: string;
                        [x: string]: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Slots.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Slots.html new file mode 100644 index 0000000..9e21b9d --- /dev/null +++ b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Events.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Events.html new file mode 100644 index 0000000..eff1147 --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Props.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Props.html new file mode 100644 index 0000000..c75d817 --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Props.html @@ -0,0 +1,4 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        options?: TJSSettingsCreateOptions;
                        settings?: TJSGameSettingsWithUI;
                        styles?: object;
                    }

                    Props type alias for associated component.

                    +

                    Type declaration

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Slots.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Slots.html new file mode 100644 index 0000000..e61cbe6 --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {
                        "settings-footer": { options: any; settings: any; uiSettings: any };
                        "settings-header": { options: any; settings: any; uiSettings: any };
                    }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Events.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Events.html new file mode 100644 index 0000000..28007be --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Props.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Props.html new file mode 100644 index 0000000..bdf21c9 --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: { options?: TJSSettingsCreateOptions; settings?: TJSGameSettingsWithUI }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Slots.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Slots.html new file mode 100644 index 0000000..32fa0f5 --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {
                        default: {};
                        "settings-footer": {
                            options: any;
                            settings: any;
                            slot: string;
                            uiSettings: any;
                        };
                        "settings-header": {
                            options: any;
                            settings: any;
                            slot: string;
                            uiSettings: any;
                        };
                    }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Events.html b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Events.html new file mode 100644 index 0000000..5102a18 --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Props.html b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Props.html new file mode 100644 index 0000000..d5c66f8 --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: { themeStore?: any }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Slots.html b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Slots.html new file mode 100644 index 0000000..cee7e51 --- /dev/null +++ b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_label.TJSSlotLabel.Events.html b/docs/types/_standard_component_label.TJSSlotLabel.Events.html new file mode 100644 index 0000000..66d729f --- /dev/null +++ b/docs/types/_standard_component_label.TJSSlotLabel.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_label.TJSSlotLabel.Props.html b/docs/types/_standard_component_label.TJSSlotLabel.Props.html new file mode 100644 index 0000000..99d559f --- /dev/null +++ b/docs/types/_standard_component_label.TJSSlotLabel.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: { enabled?: boolean; label?: any }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_label.TJSSlotLabel.Slots.html b/docs/types/_standard_component_label.TJSSlotLabel.Slots.html new file mode 100644 index 0000000..d60a4b6 --- /dev/null +++ b/docs/types/_standard_component_label.TJSSlotLabel.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_label.TJSToggleLabel.Events.html b/docs/types/_standard_component_label.TJSToggleLabel.Events.html new file mode 100644 index 0000000..2959b64 --- /dev/null +++ b/docs/types/_standard_component_label.TJSToggleLabel.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: {
                        click: MouseEvent;
                        contextmenu: MouseEvent;
                        pointerdown: PointerEvent;
                        press: CustomEvent<any>;
                    } & { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_label.TJSToggleLabel.Props.html b/docs/types/_standard_component_label.TJSToggleLabel.Props.html new file mode 100644 index 0000000..f6ffbfa --- /dev/null +++ b/docs/types/_standard_component_label.TJSToggleLabel.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        clickPropagate?: any;
                        comp?: any;
                        efx?: any;
                        enabled?: any;
                        keyCode?: any;
                        label?: any;
                        onClose?: any;
                        onContextMenu?: any;
                        onPress?: any;
                        store?: any;
                        styles?: any;
                        text?: any;
                        title?: any;
                        titleSelected?: any;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_label.TJSToggleLabel.Slots.html b/docs/types/_standard_component_label.TJSToggleLabel.Slots.html new file mode 100644 index 0000000..46e5148 --- /dev/null +++ b/docs/types/_standard_component_label.TJSToggleLabel.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {}; left: {}; outer: {}; right: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Events.html b/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Events.html new file mode 100644 index 0000000..83ba03a --- /dev/null +++ b/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Props.html b/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Props.html new file mode 100644 index 0000000..f0e573c --- /dev/null +++ b/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        boundingRect?: any;
                        components?: any;
                        controls?: ControlsStore;
                        enabled?: boolean;
                        validate?: boolean;
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Slots.html b/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Slots.html new file mode 100644 index 0000000..c32c1f1 --- /dev/null +++ b/docs/types/_standard_component_layer_position.TJSPositionControlLayer.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Events.html b/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Events.html new file mode 100644 index 0000000..632ce6c --- /dev/null +++ b/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Props.html b/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Props.html new file mode 100644 index 0000000..3c314bc --- /dev/null +++ b/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Props.html @@ -0,0 +1,21 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        allowLocking?: boolean;
                        classes?: Iterable<string>;
                        clickToOpen?: boolean;
                        duration?: number;
                        easingIn?: EasingReference;
                        easingOut?: EasingReference;
                        items?: Iterable<
                            {
                                condition?: boolean
                                | () => boolean;
                                icon: string | TJSSvelteConfig;
                                svelte: TJSSvelteConfig;
                                title?: string;
                            },
                        >;
                        side?: "left"
                        | "right";
                        styles?: { [key: string]: string };
                        top?: string | number;
                        topUnit?: string;
                        zIndex?: number;
                    }

                    Props type alias for associated component.

                    +

                    Type declaration

                    • OptionalallowLocking?: boolean

                      Controls whether items can be locked when clickToOpen is false. By default, items can be locked.

                      +
                    • Optionalclasses?: Iterable<string>

                      An iterable list of additional classes to add to the main slide layer element

                      +
                    • OptionalclickToOpen?: boolean

                      When true items are only opened / closed by click / keyboard interaction.

                      +
                    • Optionalduration?: number

                      Duration of transition effect.

                      +
                    • OptionaleasingIn?: EasingReference

                      Either the name of a Svelte easing function or a Svelte compatible easing function.

                      +
                    • OptionaleasingOut?: EasingReference

                      Either the name of a Svelte easing function or a Svelte compatible easing function.

                      +
                    • Optionalitems?: Iterable<
                          {
                              condition?: boolean
                              | () => boolean;
                              icon: string | TJSSvelteConfig;
                              svelte: TJSSvelteConfig;
                              title?: string;
                          },
                      >

                      An iterable list of side slide items including icon (Font awesome string), a Svelte configuration object, and +title.

                      +

                      You may provide a condition boolean or function that returns a boolean to hide the item. This is useful for +adding items / panels only visible for the GM amongst other conditional tests.

                      +
                    • Optionalside?: "left" | "right"

                      The side in layers parent element to display.

                      +
                    • Optionalstyles?: { [key: string]: string }

                      Additional inline styles to apply to the side slide layer. Useful for setting CSS variables.

                      +
                    • Optionaltop?: string | number

                      A valid CSS value for the top positioning attribute for the top of the side slide layer.

                      +

                      When top is a number it will be treated as pixels unless topUnit is defined.

                      +
                    • OptionaltopUnit?: string

                      When top is defined as a number and topUnit is defined then it is used to create the top style. This +facilitates creating a UI for editing side slide layer via a range input and separately storing the unit type.

                      +

                      Examples are: px, %, em, rem. Either px or % make the most sense depending on the layout constraints.

                      +
                    • OptionalzIndex?: number

                      The z-index for the side slide layer inside the parent element.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Slots.html b/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Slots.html new file mode 100644 index 0000000..9982889 --- /dev/null +++ b/docs/types/_standard_component_layer_side-slide.TJSSideSlideLayer.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: {}

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_media.TJSMediaContent.Events.html b/docs/types/_standard_component_media.TJSMediaContent.Events.html new file mode 100644 index 0000000..8437f69 --- /dev/null +++ b/docs/types/_standard_component_media.TJSMediaContent.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_media.TJSMediaContent.Props.html b/docs/types/_standard_component_media.TJSMediaContent.Props.html new file mode 100644 index 0000000..1044e7d --- /dev/null +++ b/docs/types/_standard_component_media.TJSMediaContent.Props.html @@ -0,0 +1,12 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        imgAlt?: string;
                        media?: object;
                        title?: string;
                        url?: string | URL;
                        urlDefault?: string | URL;
                        videoAutoplay?: boolean;
                        videoLoop?: boolean;
                        videoMuted?: boolean;
                        videoPlaybackRate?: number;
                        videoPlayOnHover?: boolean;
                    }

                    Props type alias for associated component.

                    +

                    Type declaration

                    • OptionalimgAlt?: string

                      Alternate image text.

                      +
                    • Optionalmedia?: object
                    • Optionaltitle?: string

                      A title for the media element.

                      +
                    • Optionalurl?: string | URL

                      URL path / URL for media content.

                      +
                    • OptionalurlDefault?: string | URL

                      Default URL path / URL for media content when no URL is configured.

                      +
                    • OptionalvideoAutoplay?: boolean

                      Automatically start video playback; default: true

                      +
                    • OptionalvideoLoop?: boolean

                      Automatically loop video; default: true

                      +
                    • OptionalvideoMuted?: boolean

                      Mute video playback audio; default: true

                      +
                    • OptionalvideoPlaybackRate?: number

                      Video playback rate - clamped internally between 0 - 2.

                      +
                    • OptionalvideoPlayOnHover?: boolean

                      Play video on pointer hover.

                      +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_media.TJSMediaContent.Slots.html b/docs/types/_standard_component_media.TJSMediaContent.Slots.html new file mode 100644 index 0000000..30083ec --- /dev/null +++ b/docs/types/_standard_component_media.TJSMediaContent.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { "video-fallback": {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_menu.TJSMenu.Events.html b/docs/types/_standard_component_menu.TJSMenu.Events.html new file mode 100644 index 0000000..d2dc433 --- /dev/null +++ b/docs/types/_standard_component_menu.TJSMenu.Events.html @@ -0,0 +1,3 @@ +Events | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Events

                    Events: { [evt: string]: CustomEvent<any> }

                    Events type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_menu.TJSMenu.Props.html b/docs/types/_standard_component_menu.TJSMenu.Props.html new file mode 100644 index 0000000..82a2d9e --- /dev/null +++ b/docs/types/_standard_component_menu.TJSMenu.Props.html @@ -0,0 +1,3 @@ +Props | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Props

                    Props: {
                        efx?: Function;
                        focusEl?: HTMLElement | string;
                        items?: Iterable<TJSMenuItemData>;
                        keyCode?: string;
                        menu?: TJSMenuData;
                        offset?: { x?: number; y?: number };
                        styles?: { [key: string]: string };
                        transitionOptions?: { duration: number; easing: Function };
                    }

                    Props type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/types/_standard_component_menu.TJSMenu.Slots.html b/docs/types/_standard_component_menu.TJSMenu.Slots.html new file mode 100644 index 0000000..47aa407 --- /dev/null +++ b/docs/types/_standard_component_menu.TJSMenu.Slots.html @@ -0,0 +1,3 @@ +Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Type Alias Slots

                    Slots: { after: {}; before: {}; default: {} }

                    Slots type alias for associated component.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_web-storage.localStores.html b/docs/variables/_runtime_svelte_store_web-storage.localStores.html new file mode 100644 index 0000000..4aa0fff --- /dev/null +++ b/docs/variables/_runtime_svelte_store_web-storage.localStores.html @@ -0,0 +1,3 @@ +localStores | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Variable localStoresConst

                    localStores: StorageStores

                    Provides all Storage API enabled localStorage store helper functions. Data is serialized as JSON.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_web-storage.sessionStores.html b/docs/variables/_runtime_svelte_store_web-storage.sessionStores.html new file mode 100644 index 0000000..0cd6ff5 --- /dev/null +++ b/docs/variables/_runtime_svelte_store_web-storage.sessionStores.html @@ -0,0 +1,3 @@ +sessionStores | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Variable sessionStoresConst

                    sessionStores: StorageStores

                    Provides all Storage API enabled sessionStorage store helper functions. Data is serialized as JSON.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_web-storage_msgpack.localStoresBCMP.html b/docs/variables/_runtime_svelte_store_web-storage_msgpack.localStoresBCMP.html new file mode 100644 index 0000000..d2611ac --- /dev/null +++ b/docs/variables/_runtime_svelte_store_web-storage_msgpack.localStoresBCMP.html @@ -0,0 +1,3 @@ +localStoresBCMP | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Variable localStoresBCMPConst

                    localStoresBCMP: StorageStores

                    Provides all MessagePack enabled localStorage store helper functions. Data is compressed and converted to base64.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_web-storage_msgpack.sessionStoresBCMP.html b/docs/variables/_runtime_svelte_store_web-storage_msgpack.sessionStoresBCMP.html new file mode 100644 index 0000000..facb9c9 --- /dev/null +++ b/docs/variables/_runtime_svelte_store_web-storage_msgpack.sessionStoresBCMP.html @@ -0,0 +1,3 @@ +sessionStoresBCMP | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                    Variable sessionStoresBCMPConst

                    sessionStoresBCMP: StorageStores

                    Provides all MessagePack enabled sessionStorage store helper functions. Data is compressed and converted to base64.

                    +

                    Settings

                    Member Visibility
                    \ No newline at end of file