fsVfxIsValid
The fsVfxIsValid function checks a VFX instance ID (as returned by either fsVfxSpawnInWorld
or fsVfxSpawnOnSimObject
) to see if it is valid, ie: it's not null and the VFX exists in the world.
Syntax
bool fsVfxIsValid(
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 ID exists and is a valid VFX instance, otherwise it will return FALSE (it may also return FALSE if the vfx was destroyed).
Example
if (fsVfxIsValid(vfxId)) {
if (fsVfxIsInstancePlaying(vfxId)) {
fsVfxDestroyInstance(vfxId);
}
Remarks
N/A
See Also