← Documentation Home

CreateParticleSystem

Category: Particle Effects (Pro)

Back to System Functions


Signature

CreateParticleSystem(capacity As Integer)

Returns

Integer

Description

Creates a native particle system with storage for up to capacity live particles. Returns 0 if capacity is invalid, memory cannot be reserved, or all system slots are in use.

Performance and behavior

The capacity is fixed so emitting and updating particles performs no per-frame particle allocation. Values from 1 through 1,000,000 are accepted.

Pro feature: compiling code that uses this function requires a license with the GamePhysics feature enabled.

Example

particles = CreateParticleSystem(20000)