Skip to content

@temporary-escape/mod-sdk / Generators

Class: Generators ​

Defined in: generators.ts:82

Reusable sector generators. Accessible as engine.generators.

Constructors ​

Constructor ​

ts
new Generators(): Generators;

Returns ​

Generators

Methods ​

register() ​

ts
register(
   name: string, 
   fn: GeneratorFn, 
   replace?: bool
): void;

Defined in: generators.ts:88

Registers a generator under name. The name is namespaced (mod:generator) and referenced from a sector type's spawns list with kind: Generator.

Parameters ​

ParameterTypeDefault value
namestringundefined
fnGeneratorFnundefined
replaceboolfalse

Returns ​

void