Impact CFX Main Page Index API Reference Change Logs
Legacy Impact Comparison Conversion From Legacy Impact
Impact CFX Project Settings Impact Tags Logging Impact Material Registry
Impact CFX Manager Material Mapping Managing Registered Materials
Impact Materials
Audio Effect Audio Source Prefab Audio Effect Processor Particle Effect Particle System Prefab Particle Effect Processor Decal Effect Decal Prefab Decal Effect Processor URP & HDRP Decals VFX Batch Effect VFX Batch Master Creating a Visual Effect VFX Batch Effect Processor Managing Attached Effects
Impact Objects Impact Object Single Material Impact Object Rigidbody Impact Object Rigidbody (Cheap) Impact Object Custom Velocity Objects With Multiple Materials Impact Terrain
Impact Triggers Common Trigger Properties Material Count Impact Collision Trigger Impact Slide and Roll Trigger Impact Speculative Collision Trigger Impact Simple Collision Trigger Impact Particle Collision Trigger Impact On Trigger Enter Impact On Trigger Stay
Impact Raycasting
FMOD Integration Wwise Integration Master Audio Integration
Custom Triggers Custom Objects Creating an Impact Object Script Impact Material Processors Custom Effects Impact Effect Authoring Asset Effect Result Effect Data Impact Effect Processors Impact Simple Effect Processor Impact Pooled Effect Processor Pooled Effect Object Pooled Effect Authoring Pooled Effect Result Pooled Effect Data Object Pool Pooled Effect Processor Add to Impact CFX Manager Example Effect Download

Conversion From Legacy Impact

Converting your project to use Impact CFX from legacy Impact requires a few steps:

  • Convert Assets - Impact Material and Interaction assets will need to be re-created using their Impact CFX counterparts.
  • Convert Components - Impact components will need to be replaced with their Impact CFX counterparts, and any references to assets will need to be updated.
  • Convert Scripts - Any custom scripts that use the legacy Impact API will need to be updated.

This can be done manually, or you can use the Impact CFX Conversion Tool to automatically convert all assets and components in your project.

Impact CFX Conversion Tool (1.0.4)

Latest Release: 19/01/2024

The conversion tool will not convert any custom scripts that use the Impact API or inherit from Impact components. You will need to convert these custom scripts yourself.

IT IS VERY IMPORTANT THAT YOU HAVE A BACKUP OF YOUR PROJECT BEFORE ATTEMPTING TO CONVERT!

Using the Impact CFX Conversion Tool

1) Import Impact CFX

Import Impact CFX into your project as normal. Impact CFX and legacy Impact can safely be in your project at the same time without any conflicts or errors.

2) Import the Impact CFX Conversion Tool

Import the Impact CFX Conversion Tool into your project.

3) Open the Impact CFX Conversion Tool Window

Open the Impact CFX Conversion Tool by going to Window > Impact CFX > Conversion Tool.

First, click the Scan button scan your project for all Impact assets.

Once this is done, a listing of all Impact assets that were found will be shown. These lists are categorized by the kind of asset and show you the path for each asset. The conversion tool will also go into scenes and convert any components inside of scenes.

Make sure to carefully look over all of the assets listed here to make sure that they are correct.

There is also the Impact Tag Library field. This is the Impact Tag Library the conversion tool will use to convert your tag names into Impact CFX project settings.

When you are ready to proceed, click the Convert button. This may take some time, depending on the size of your project. The specific order of conversion is as follows:

  1. First, the Impact Tag Library you provided will be converted to Impact CFX project settings.
  2. New Audio, Particle, and Decal effect assets are created to match each corresponding Audio, Particle, or Decal interaction. The prefabs used by these interactions will have the new Impact CFX components added to them.
  3. New Impact CFX Material assets are created to match each corresponding Impact Material.
  4. An Impact Material Registry asset is created using the newly created materials from the previous step.
  5. All prefabs with Impact Object, Impact Trigger, or Impact Decal Manager components have the corresponding Impact CFX components added to them.
  6. Old Impact components are now deleted from the prefabs.
  7. Scenes are now opened and scanned for objects with Impact components, adding the corresponding Impact CFX components. The old Impact components are deleted when the scene conversion is finished, before saving the scene and loading the next scene.
  8. Once scene conversion is complete, all old Impact Material and Audio, Particle, or Decal interaction assets are deleted.
4) Test Conversion Results

All of your Impact assets and components will now be replaced with their Impact CFX counterparts, and should work without any further modifications. Make sure to thoroughly test your project to make sure everything works as expected. The console will also have a log of all assets and components that were converted.

5) Update custom scripts

You will need to manually update any scripts that use the Impact API, or any custom components that inherit from Impact components.

6) Remove Legacy Impact

Finally, you can remove legacy Impact from your project.