SubstanceRegistry

Explained in Chemistry.

class SubstanceRegistry

import { SubstanceRegistry } from '@driftengine/chemistry';

Constructor

`new`

constructor(species: SpeciesRegistry, reactions?: ReactionRegistry | undefined)

Parameter	Type	Description
`species`	`SpeciesRegistry`
`reactions?`	`ReactionRegistry \| undefined`

Properties

Name	Type	Description
`species`readonly	`SpeciesRegistry`

Accessors

Name	Type	Description
`count`get	`number`

Methods

`define`

define(substance: SubstanceThermal): number

Parameter	Type	Description
`substance`	`SubstanceThermal`

`indexOf`

indexOf(id: string): number

Parameter	Type	Description
`id`	`string`

`idOf`

idOf(substance: number): string

Parameter	Type	Description
`substance`	`number`

`conductionOf`

conductionOf(substance: number): ConductionModel

Parameter	Type	Description
`substance`	`number`

`conductionAt`

conductionAt(substance: number, shells: number): ConductionModel

The conduction model for a substance resolved to shells, which a tier may have reduced it to.

Parameter	Type	Description
`substance`	`number`
`shells`	`number`

Precomputed at registration; see byShellCount for why it is not derived on demand.

`densityOf`

densityOf(substance: number): number

Parameter	Type	Description
`substance`	`number`

`porosityOf`

porosityOf(substance: number): number

Void fraction, 0..1. Zero means it exchanges no gas with the air at all.

Parameter	Type	Description
`substance`	`number`

`emissivityOf`

emissivityOf(substance: number): number

How readily it radiates and absorbs, 0..1.

Parameter	Type	Description
`substance`	`number`

`ignitionOf`

ignitionOf(substance: number): IgnitionModel | null

When this material catches, or null where nobody said it does.

Parameter	Type	Description
`substance`	`number`

`appearanceOf`

appearanceOf(substance: number): AppearanceModel | null

What it looks like, or null where nobody said.

Parameter	Type	Description
`substance`	`number`

null rather than a grey default: present/ writes nothing for a substance with no appearance rather than inventing one, so a consumer sees their own material unchanged instead of finding the engine has quietly recoloured it.

`definitionOf`

definitionOf(substance: number): SubstanceThermal

Parameter	Type	Description
`substance`	`number`

`speciesSetOf`

speciesSetOf(substance: number): Int32Array

Global species indices this substance's parcels carry, ascending.

Parameter	Type	Description
`substance`	`number`

`localSlotOf`

localSlotOf(substance: number, species: number): number

The local slot a global species occupies for this substance, or -1.

Parameter	Type	Description
`substance`	`number`
`species`	`number`

`reactionsOf`

reactionsOf(substance: number): SubstanceReactions

Parameter	Type	Description
`substance`	`number`