Class: ModuleBuilder
index.ModuleBuilder
Represents a builder for particle modules. Returns an evaluatable module function, that can be consumed by emitters.
remarks
Not all properties can be driven. TypeScript will validate this at compile time,
but no internal validation is performed due to performance reasons. Also, note
that the driving factor is "lifetime" by default.
example
new ModuleBuilder() .drive("size") .by((t) => t * 2) .through("lifetime") .build();Constructors#
constructor#
• new ModuleBuilder()
Methods#
build#
â–¸ build(): ModuleFunction
Consumes the builder and returns an evaluatable module function.
remarks
Note that you need to specify the driving key and value, otherwise an error
will be thrown.
Returns#
Defined in#
by#
â–¸ by<TDriver>(driver): ModuleBuilder
Specifies the value to drive the module behaviour by. This can be a constant, a spline or an evaluable function. Note that in the last case, the driving factor is passed as a parameter.
Type parameters#
| Name | Type |
|---|---|
TDriver | extends DrivableType |
Parameters#
| Name | Type |
|---|---|
driver | ModuleDriverValue<TDriver> |
Returns#
The chained builder instance.
Defined in#
drive#
â–¸ drive<TKey>(key): ModuleBuilder
Specifies the key in the particle that should be driven.
remarks
Note that not all of a particle's properties are drivable through modules. If you
need full control of a particle inside of a module, you can use a module function directly.
Type parameters#
| Name | Type |
|---|---|
TKey | extends "size" | "rotation" | "color" | "opacity" |
Parameters#
| Name | Type |
|---|---|
key | TKey |
Returns#
The chained builder instance.
Defined in#
relative#
â–¸ relative(isRelative?): ModuleBuilder
Specifies that the module function is supposed to act relative to the properties initial value.
remarks
Note that this is only possible if an "initial*" property exists on the
particle object. The operation applied to the initial and new value
is dependant on their type:
Vector: Both vectors are added.number: Both numbers are multiplied.
For more advanced relative customizations, consider using the particle object in the driver value function instead, like:
.by((t, p) => p.initialSize + t * 2);Parameters#
| Name | Type | Default value |
|---|---|---|
isRelative | boolean | true |
Returns#
Defined in#
through#
â–¸ through(factor): ModuleBuilder
Specifies the factor to drive the evaluated value by. Supports "lifetime" and "size".
Parameters#
| Name | Type |
|---|---|
factor | DrivableFactor |
Returns#
The chained builder instance.