Mod Features
Functions
initModFeatures
▸ initModFeatures<T>(mod, modFeatures, init?): { [K in keyof T]: InstanceType<T[K]> }
Helper function to instantiate an array of mod features all at once. Use this function if your
mod uses the pattern of expressing mod features as ModFeature classes.
If your feature classes have v variables, then this function will successfully register them
with the save data manager.
For example:
const MOD_FEATURES = [
MyFeature1,
MyFeature2,
MyFeature3,
] as const;
initModFeatures(mod, MOD_FEATURES);
Type parameters
| Name | Type |
|---|---|
T | extends readonly typeof ModFeature[] |
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
mod | ModUpgraded | undefined | The upgraded mod to use. |
modFeatures | T | undefined | An array of the feature classes that you have in your mod. |
init | boolean | true | Optional. Whether to automatically add the callbacks on the feature. Defaults to true. |
Returns
{ [K in keyof T]: InstanceType<T[K]> }
An array of the instantiated features in the same order that the constructors were passed in. (In most cases, you probably won't need the returned array.)