Class UltraLoot

Todo

detect recursively required tables

Example

import {UltraLoot} from "ultraloot";

const ultralootDefaultRng = new UltraLoot();           // default RNG
const ultralootCustomRng = new UltraLoot("UL7R4L007"); // seeding the built in RNG
const ultralootCustomRng = new UltraLoot(rngSource);   // using a custom RNG

Index

Constructors

constructor

Properties

conditions defaultRng functions rng? rngConstructor? throwOnMissingConditions throwOnMissingFunctions version version

Constructors

constructor

new UltraLoot(rng?): UltraLoot
Parameters
- Optionalrng: Seed | RngInterface
Returns UltraLoot
- Defined in src/ultraloot.ts:154

Properties

`Protected`conditions

conditions: Record<string, LootTableConditionSignature> = {}

Global conditions that can be used by loot table pools and entries.

The keys in the object are the function identifier used in the table entries/pools

`Protected`defaultRng

defaultRng: RngInterface

Default RNG source when none is given

`Protected`functions

functions: Record<string, LootTableFunctionSignature> = {}

Global functions that can be used by loot table entries.

The keys in the object are the function identifier used in the table entries

`Protected` `Optional`rng

rng?: RngInterface

RNG source given by the end user

`Protected` `Optional`rngConstructor

rngConstructor?: RngConstructor

RNG Constructor for making new RNGs

throwOnMissingConditions

throwOnMissingConditions: boolean = true

Whether to throw errors when conditions are missing, otherwise just does console.error

throwOnMissingFunctions

throwOnMissingFunctions: boolean = true

Whether to throw errors when functions are missing, otherwise just does console.error

version

version: string = CURRENT_VERSION

`Static`version

version: string = CURRENT_VERSION

Methods

applyCondition

applyCondition(conditionDefinition, __namedParameters): Promise<boolean>
Parameters
- conditionDefinition: ConditionDefinition
- __namedParameters: {
      context: any;
      looter: any;
      result: LootTableEntryResults;
      rng: RngInterface;
  }
  - context: any
  - looter: any
  - result: LootTableEntryResults
  - rng: RngInterface
Returns Promise<boolean>
- Defined in src/ultraloot.ts:373

applyConditionSync

applyConditionSync(conditionDefinition, __namedParameters): boolean
Parameters
- conditionDefinition: ConditionDefinition
- __namedParameters: {
      context: any;
      looter: any;
      result: LootTableEntryResults;
      rng: RngInterface;
  }
  - context: any
  - looter: any
  - result: LootTableEntryResults
  - rng: RngInterface
Returns boolean
- Defined in src/ultraloot.ts:335

applyFunction

applyFunction(functionDefinition, __namedParameters): Promise<void>
Parameters
- functionDefinition: FunctionDefinition
- __namedParameters: {
      context: any;
      looted: LootTableEntryResult;
      looter: any;
      result: LootTableEntryResults;
      rng: RngInterface;
  }
  - context: any
  - looted: LootTableEntryResult
  - looter: any
  - result: LootTableEntryResults
  - rng: RngInterface
Returns Promise<void>
- Defined in src/ultraloot.ts:355

applyFunctionSync

applyFunctionSync(functionDefinition, __namedParameters): void
Parameters
- functionDefinition: FunctionDefinition
- __namedParameters: {
      context: any;
      looted: LootTableEntryResult;
      looter: any;
      result: LootTableEntryResults;
      rng: RngInterface;
  }
  - context: any
  - looted: LootTableEntryResult
  - looter: any
  - result: LootTableEntryResults
  - rng: RngInterface
Returns void
- Defined in src/ultraloot.ts:317

conditionCheck

conditionCheck(cond): boolean
Parameters
- cond: ConditionDefinition
Returns boolean
- Defined in src/ultraloot.ts:302

createEntry

createEntry(def): LootTableEntry
Create an entry for a loot pool, either with object definition or from a loot table
Parameters
- def: LootTableEntryDefinition | LootTable
Returns LootTableEntry
- Defined in src/ultraloot.ts:456

createPool

createPool(def): LootTablePool
Create a loot pool for use in a loot table
Parameters
- def: LootTablePoolDefinition | LootTablePoolEasyDefinition
Returns LootTablePool
- Defined in src/ultraloot.ts:443

createTable

createTable(def): LootTable

Create a loot table, with this ultraloot instance

Parameters

def: LootTable | LootTableDefinition | LootTableEasyDefinition

Returns LootTable

Example

const ul = new UltraLoot('UL7R4L007');
const table = ul.createTable({name: 'Food'});

table.addPool([
  {
    rolls: 1,
    name: 'Cakes'
    entries: [
      {id: 'chocolate_cake'},
      {id: 'fruit_cake'},
      {id: 'star_cake'}
    ]
  }
]);

`Protected`finishWith

finishWith(str, ending): string
Parameters
- str: string
- ending: string
Returns string
- Defined in src/ultraloot.ts:575

`Protected`finishWithExtension

finishWithExtension(str, extension): string
Parameters
- str: string
- extension: string
Returns string
- Defined in src/ultraloot.ts:582

functionCheck

functionCheck(fn): boolean
Parameters
- fn: FunctionDefinition
Returns boolean
- Defined in src/ultraloot.ts:287

getDefaultRng

getDefaultRng(): RngInterface
Returns RngInterface
- Defined in src/ultraloot.ts:201

`Protected`getExtension

getExtension(str): string
Parameters
- str: string
Returns string
- Defined in src/ultraloot.ts:593

getRng

getRng(): RngInterface
Returns RngInterface
- Defined in src/ultraloot.ts:197

getRngConstructor

getRngConstructor(): RngConstructor
Returns RngConstructor
- Defined in src/ultraloot.ts:209

hasCondition

hasCondition(name): boolean
Parameters
- name: string
Returns boolean
- Defined in src/ultraloot.ts:271

hasFunction

hasFunction(name): boolean
Parameters
- name: string
Returns boolean
- Defined in src/ultraloot.ts:267

instance

instance(rng?): UltraLoot
As we dont expose the class as default, in browser it would be nice if there was a way to create new instances. This can be done using this function.
Parameters
- Optionalrng: Seed | RngInterface
Returns UltraLoot
- Defined in src/ultraloot.ts:186

`Protected`isEasyLootTableDefinition

isEasyLootTableDefinition(def): def is LootTableEasyDefinition
Used for Typescript type guarding and parameter checking
Parameters
- def: any
Returns def is LootTableEasyDefinition
- Defined in src/ultraloot.ts:493

`Protected`isEasyLootTablePoolDefinition

isEasyLootTablePoolDefinition(def): def is LootTablePoolEasyDefinition
Used for Typescript type guarding and parameter checking
Parameters
- def: any
Returns def is LootTablePoolEasyDefinition
- Defined in src/ultraloot.ts:514

`Protected`isLootTableDefinition

isLootTableDefinition(def): def is LootTableDefinition
Used for Typescript type guarding and parameter checking
Parameters
- def: any
Returns def is LootTableDefinition
- Defined in src/ultraloot.ts:472

isRng

isRng(rng?): rng is RngInterface
Parameters
- Optionalrng: any
Returns rng is RngInterface
- Defined in src/ultraloot.ts:213

loadTable

loadTable(filename, __namedParameters?): Promise<LootTable>
Load a table from a file.

The file can be local or a url. If running in browser, it's always treated as a URL. When run in node, it will only treat it as a URL if it's prefixed with http.

This function expects a single table to be located in the file, as the base object.
Parameters
- filename: string
- __namedParameters: LoadSaveArgs = {}
Returns Promise<LootTable>
- Defined in src/ultraloot.ts:836

loadTableFromFile

loadTableFromFile(filename, __namedParameters?): Promise<LootTable>
Loads a table from a local file
Parameters
- filename: string
- __namedParameters: LoadSaveArgs = {}
Returns Promise<LootTable>
- Defined in src/ultraloot.ts:861

loadTableFromUrl

loadTableFromUrl(url, __namedParameters?): Promise<LootTable>
Loads a table from a url
Parameters
- url: string
- __namedParameters: LoadSaveArgs = {}
Returns Promise<LootTable>
- Defined in src/ultraloot.ts:929

loadTables

loadTables(filename, __namedParameters?): Promise<Record<string, LootTable>>
Load serialized tables from a file.

This is just a wrapper around unserializing json contents of a file.
Parameters
- filename: string
- __namedParameters: LoadSaveArgs = {}
Returns Promise<Record<string, LootTable>>
- Defined in src/ultraloot.ts:766

loadTablesFromFile

loadTablesFromFile(filename, __namedParameters?): Promise<Record<string, LootTable>>
Loads serialized tables from a local file
Parameters
- filename: string
- __namedParameters: LoadSaveArgs = {}
Returns Promise<Record<string, LootTable>>
- Defined in src/ultraloot.ts:783

loadTablesFromUrl

loadTablesFromUrl(url, __namedParameters?): Promise<Record<string, LootTable>>
Load serialized tables from a url
Parameters
- url: string
- __namedParameters: LoadSaveArgs = {}
Returns Promise<Record<string, LootTable>>
- Defined in src/ultraloot.ts:809

makeRng

makeRng(rng?): RngInterface
Parameters
- Optionalrng: Seed | RngInterface
Returns RngInterface
- Defined in src/ultraloot.ts:251

noThrowOnMissingFunctionsOrConditions

noThrowOnMissingFunctionsOrConditions(): UltraLoot
Returns UltraLoot
- Defined in src/ultraloot.ts:275

`Protected`pathJoin

pathJoin(parts, sep?): string
Parameters
- parts: string[]
- sep: string = '/'
Returns string
- Defined in src/ultraloot.ts:571

registerCondition

registerCondition(name, fn): void
Parameters
- name: string
- fn: LootTableConditionSignature
Returns void
- Defined in src/ultraloot.ts:263

registerDefaultConditions

registerDefaultConditions(): UltraLoot
Returns UltraLoot
- Defined in src/ultraloot.ts:174

registerDefaultFunctions

registerDefaultFunctions(): UltraLoot
Returns UltraLoot
- Defined in src/ultraloot.ts:167

registerDefaults

registerDefaults(): UltraLoot
Returns UltraLoot
- Defined in src/ultraloot.ts:161

registerFunction

registerFunction(name, fn): void
Parameters
- name: string
- fn: LootTableFunctionSignature
Returns void
- Defined in src/ultraloot.ts:259

resolveTable

resolveTable(table, __namedParameters?): Promise<LootTable>
Turns a JSON representation into a LootTable, and does the same for all nested tables inside pools recursively.
Parameters
- table: LootTableJsonDefinition
- __namedParameters: LoadSaveArgs = {}
Returns Promise<LootTable>
- Defined in src/ultraloot.ts:950

saveTable

saveTable(table, __namedParameters?): Promise<void>
Parameters
- table: LootTable
- __namedParameters: LoadSaveArgs = {}
Returns Promise<void>
Todo
Implement this
- Defined in src/ultraloot.ts:757

serialize

serialize(table, __namedParameters?): SerializedTables

Serializes a LootTable ready for converting to text, e.g. JSON

Returns a key value object, where the keys are the loot table filenames/ids

Parameters

table: LootTable
__namedParameters: {
    had?: Set<any>;
    includeRng?: boolean;
    key?: string;
} = {}
- Optionalhad?: Set<any>
- OptionalincludeRng?: boolean
- Optionalkey?: string

Returns SerializedTables

Example

const result = await ultraloot.serialize(table);

result = {
  kitchen_cupboard: {
    fn: 'kitchen_cupboard',
    pools: [
      {
        entries: [
          {
            type: 'table',
            item: 'vegetables'
          },
          {
            type: 'table',
            item: 'fruit'
          }
        ]
      }
    ]
  },
  fruit_bowl: {
    fn: 'fruit_bowl',
    pools: [
      {
        entries: [
          {
            type: 'table',
            item: 'fruit'
          }
        ]
      }
    ]
  },
  vegetables: {
    fn: 'vegetables',
    pools: [
      {
        entries: [
          {
            id: 'carrot'
          },
          {
            id: 'cabbage'
          },
        ]
      }
    ]
  },
  fruit: {
    fn: 'fruit',
    pools: [
      {
        entries: [
          {
            id: 'apple'
          },
          {
            id: 'pear'
          },
        ]
      }
    ]
  }
}

setRng

setRng(rng): void
Parameters
- rng: RngInterface
Returns void
- Defined in src/ultraloot.ts:190

setRngConstructor

setRngConstructor(rngConstructor): void
Parameters
- rngConstructor: RngConstructor
Returns void
- Defined in src/ultraloot.ts:205

throwOnMissingFunctionsOrConditions

throwOnMissingFunctionsOrConditions(): UltraLoot
Returns UltraLoot
- Defined in src/ultraloot.ts:281

toJson

toJson(table, options?): string
Convert a LootTable to JSON
Parameters
- table: LootTable
  The table to serialize
- options: {
  includeRng?: boolean;
  } = {}
  Options
  - OptionalincludeRng?: boolean
    Whether to include the RNG seed in the serialized tables
Returns string
The resulting LootTable representation in a JSON string
- Defined in src/ultraloot.ts:750

`Protected`transformEasyToProperLootTableDefinition

transformEasyToProperLootTableDefinition(def): LootTableDefinition
Parameters
- def: LootTableEasyDefinition
Returns LootTableDefinition
- Defined in src/ultraloot.ts:532

`Protected`transformEasyToProperLootTablePoolDefinition

transformEasyToProperLootTablePoolDefinition(def): LootTablePoolDefinition
Parameters
- def: LootTablePoolEasyDefinition
Returns LootTablePoolDefinition
- Defined in src/ultraloot.ts:548

unserialize

unserialize(tables): Record<string, LootTable>
Unserializes tables serialized with the "serialize" function
Parameters
- tables: SerializedTables
  Record of tables serialized using the "serialize" function
Returns Record<string, LootTable>
A key/value pairing of tables
- Defined in src/ultraloot.ts:968

Class UltraLoot

Todo

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UltraLoot

Properties

Protectedconditions

ProtecteddefaultRng

Protectedfunctions

Protected Optionalrng

Protected OptionalrngConstructor

throwOnMissingConditions

throwOnMissingFunctions

version

Staticversion

Methods

applyCondition

Parameters

context: any

looter: any

result: LootTableEntryResults

rng: RngInterface

Returns Promise<boolean>

applyConditionSync

Parameters

context: any

looter: any

result: LootTableEntryResults

rng: RngInterface

Returns boolean

applyFunction

Parameters

context: any

looted: LootTableEntryResult

looter: any

result: LootTableEntryResults

rng: RngInterface

Returns Promise<void>

applyFunctionSync

Parameters

context: any

looted: LootTableEntryResult

looter: any

result: LootTableEntryResults

rng: RngInterface

Returns void

conditionCheck

Parameters

Returns boolean

createEntry

Parameters

Returns LootTableEntry

createPool

Parameters

Returns LootTablePool

createTable

Parameters

Returns LootTable

Example

ProtectedfinishWith

Parameters

Returns string

ProtectedfinishWithExtension

Parameters

Returns string

functionCheck

Parameters

Returns boolean

getDefaultRng

Returns RngInterface

ProtectedgetExtension

Parameters

Returns string

getRng

`Protected`conditions

`Protected`defaultRng

`Protected`functions

`Protected` `Optional`rng

`Protected` `Optional`rngConstructor

`Static`version

`Protected`finishWith

`Protected`finishWithExtension

`Protected`getExtension

`Protected`isEasyLootTableDefinition

`Protected`isEasyLootTablePoolDefinition

`Protected`isLootTableDefinition

`Protected`pathJoin