Class Generator<M, C>

abstract

Type parameters

M: Mod
C: Container<any>

Hierarchy

Generator

Index

Constructors

constructor

Properties

mods

Methods

Constructors

constructor

new Generator(mods: M[]): Generator

- Defined in packages/mods/src/generators/Generator.ts:30
Parameters
- mods: M[]
Returns Generator

Properties

mods

mods: M[]

Methods

Abstract applicableTo

applicableTo(container: C): Flags

- Defined in packages/mods/src/generators/Generator.ts:43
Parameters
- container: C
Returns Flags

Abstract applyTo

applyTo(container: C): C

- Defined in packages/mods/src/generators/Generator.ts:36
Parameters
- container: C
Returns C

getAvailableMods

getAvailableMods(): M[]

- Defined in packages/mods/src/generators/Generator.ts:50
returns a copy of #mods

we can stick with a shallow copy since Mod are supposed to be immutable

Returns M[]

isApplicableTo

isApplicableTo(container: C, whitelist?: string[]): boolean

- Defined in packages/mods/src/generators/Generator.ts:54
Parameters
- container: C
- Default value whitelist: string[] = []
Returns boolean

isModApplicableTo

isModApplicableTo(mod: M, container: C): ModApplicableFlags

- Defined in packages/mods/src/generators/Generator.ts:58
Parameters
- mod: M
- container: C
Returns ModApplicableFlags

Abstract modsFor

modsFor(container: C, whitelist: string[]): Array<GeneratorDetails<M>>

- Defined in packages/mods/src/generators/Generator.ts:38
Parameters
- container: C
- whitelist: string[]
Returns Array<GeneratorDetails<M>>

Generated using TypeDoc