fsVfxStopInstance

The fsVfxStopInstance function is used to stop a (previously spawned) VFX instance from playing.

Syntax

bool fsVfxStopInstance(
    FsVfxId id
);

Members

Parameters	Description
`id`	The ID of the VFX to stop, as returned by either `fsVfxSpawnInWorld` or `fsVfxSpawnOnSimObject`.

Return Values

The function will return TRUE if the command has been properly executed, otherwise it will return FALSE (for example if the vfx was destroyed).

Example

fsVfxStopInstance(vfxId);

Remarks

A VFX instance can be stopped and restarted again (using the fsVfxPlayInstance function), however it should be noted that a VFX that has finished emitting, has no particles alive, and that has no static meshes, will be automatically destroyed after 100 frames, meaning that it canot be played again.