ConfettiThe main Confetti class which you get access to by requiring the library.
Spawn a registered custom particle
overload 1:
Confetti.newParticle(name: string, pos: Vector3, vel: Vector3): Confetto | Method Property | Fluent Description | Representation |
|---|---|---|
| name accepts | typings.-891985903||
| pos accepts | typings.2002444080||
| vel accepts | typings.2002444080||
| Return Value | typings.-515601234
overload 2:
Confetti.newParticle(name: string, pos: Vector3, vel: Vector3, options: ConfettoOptions): Confetto | Method Property | Fluent Description | Representation |
|---|---|---|
| name accepts | typings.-891985903||
| pos accepts | typings.2002444080||
| vel accepts | typings.2002444080||
| options accepts | typings.-1030647280||
| Return Value | typings.-515601234
Spawn a registered custom particle without checking arguments. This uses less instructions, but doesn't allow different argument types. In the options, scaleOverTime, rotationOverTime and acceleration must be Vector3 if used.
overload 1:
Confetti.newParticleUnchecked(): nil | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.109073
Register a new mesh particle.
overload 1:
Confetti.registerMesh(name: string, mesh: ModelPart): nil | Method Property | Fluent Description | Representation |
|---|---|---|
| name accepts | typings.-891985903||
| mesh accepts | typings.-6801764||
| Return Value | typings.109073
overload 2:
Confetti.registerMesh(name: string, mesh: ModelPart, lifetime: number): nil | Method Property | Fluent Description | Representation |
|---|---|---|
| name accepts | typings.-891985903||
| mesh accepts | typings.-6801764||
| lifetime accepts | typings.-1034364087||
| Return Value | typings.109073
Register a new sprite particle.
overload 1:
Confetti.registerSprite(name: string, sprite: Texture, bounds: Vector4, lifetime: number|nil, pivot: Vector2|nil): nil | Method Property | Fluent Description | Representation |
|---|---|---|
| name accepts | typings.-891985903||
| sprite accepts | typings.246836475||
| bounds accepts | typings.2002444081||
| lifetime accepts | typings.-390981922||
| pivot accepts | typings.-2086422588||
| Return Value | typings.109073