fsVfxIsMinTimePassed

The fsVfxIsMinTimePassed function can be used to check if a minimum number of frames have passed since the VFX started playing. This minimum number is set when the VFX is spawned in the world using either fsVfxSpawnInWorld or fsVfxSpawnOnSimObject, and is an arbitrary value that can be used for anything you want in the code.

Syntax

bool fsVfxIsInstancePlaying(
    FsVfxId id
);

Members

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

Return Values

The function will return TRUE if the given instance has been playing for longer than the minimum time, or if the minimum time was set to -1. Otherwise it will return FALSE (it may also return FALSE if the vfx was destroyed).

Example

if (fsVfxIsMinTimePassed(vfxId)) {
    fsVfxStopInstance(vfxId);
    }

Remarks

N/A