SpriteFx
18 tools in this family (folder Editor/Tools/SpriteFx/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.
| Tool | Effect | Description |
|---|---|---|
sprite_fx_animate_property | writes | Schedule a PulseFx driver that pings the named material property between [min, max] at the given |
sprite_fx_apply_preset | writes | Replace the working stack with a named preset (PowerUp, EnemyHit, Frozen, Burning, Stunned, |
sprite_fx_apply_to_renderer | writes | Generate the shader for the working stack, create or update a Material at 'material_path', and |
sprite_fx_chain_effects | writes | Set the explicit emit order for effects on the working stack. Supply 'effect_ids' as an ordered |
sprite_fx_configure_color_shift | writes | Configure the ColorShiftFx color-op pass. Modes: Hsv | ContrastBrightness | Greyscale | Negative.… |
sprite_fx_configure_dissolve | writes | Configure the DissolveFx alpha-shape pass. Either supply a 'texture_path' (grayscale noise) or |
sprite_fx_configure_distortion | writes | Configure the DistortionFx UV jitter pass. Modes: Noise | Sine | Uv | Warp. Adjust strength, |
sprite_fx_configure_glitch | writes | Configure the GlitchFx resample pass — RGB split, block intensity / size, animation speed, and |
sprite_fx_configure_glow | writes | Configure the GlowFx emissive layer. Choose blend mode (Additive | Multiply | Screen) and tune |
sprite_fx_configure_hologram | writes | Configure the HologramFx scanline / RGB-shift / glitch composite. Drives an animated stripe pattern,… |
sprite_fx_configure_outline | writes | Configure the OutlineFx layer on the working stack. Modes: FourDir | EightDir | Pixel | Sobel | … |
sprite_fx_disable_effect | writes | Disable an effect by id. If 'remove' is true the effect is dropped from the stack entirely; |
sprite_fx_enable_effect | writes | Add an effect to the working stack (or re-enable an existing one) by its public id — outline, glow, |
sprite_fx_export_setup | read-only | Export the working stack to a Buril-flavoured JSON document. Returns the JSON text inline and, if |
sprite_fx_generate_shader | writes | Run the shader builder on the working stack and write a complete ShaderLab/HLSL file to disk. |
sprite_fx_load_profile | writes | Load a saved SpriteFxProfile ScriptableObject and install its stack into the working session. |
sprite_fx_save_profile | writes | Save the working stack as a SpriteFxProfile ScriptableObject at 'asset_path'. The profile stores a |
sprite_fx_setup | writes | Initialise a SpriteFx working stack and register a runtime for the SpriteRenderer found on the |