Blueprint and Python
Disturbance nodes
All are in the VDB Studio Disturbance category. Positions are world space, velocities cm/s. Static nodes return the number of volumes hit.
Every node also takes Outward (60), Raggedness (0.3) and Edge Softness (0.4).
| Node | Parameters (defaults) |
|---|---|
| Add Disturbance (on a component) | Start, End, Radius (12), Velocity, Cut (1) |
| Disturb Volumes Along Line | Start, End, Radius (12), Velocity, Cut (1) |
| Fire Bullet Through Volumes | Start, End, Radius (10), Speed (600), Cut (1) |
| Disturb Volumes Along Projectile | Previous Location, Location, Velocity, Radius (10), Push Multiplier (1), Cut (1) |
| Fire Projectile Arc Through Volumes | Start, Velocity, Gravity Z (-980), Duration (2), Radius (10), Push Multiplier (1), Cut (1), Drag (0), Segments (24) |
| Swing Through Volumes | Pivot, Axis, Start Direction, Angle Degrees (140), Length (180), Radius (8), Duration (0.25), Push Multiplier (1), Cut (1), Steps (12) |
| Is Disturbed | Pure. True while the field is simulating. |
Other component nodes
| Node | Description |
|---|---|
| Apply Gameplay Quality / Apply Cinematic Quality | Quality presets. |
| Get Volume Fade | The volume's share of the picture under Far Effects. |
| Get Far Effect Fade | Each far layer's fade, by index. |
| Get Far Effect Component | A far layer's Niagara component. |
Component properties marked in the component reference are readable and writable from Blueprint.
Editor library
unreal.VDBStudioEditorLibrary in Python, the VDB Studio category in Editor Utility Blueprints. Editor only.
| Function | Purpose |
|---|---|
import_compressed_volume(filename, package, quality=2, single_frame=False, calibrate_velocity=True, downsample_velocity=False) | Import a .vdb directly. |
create_compressed_volume(svt, quality=2, downsample_velocity=False) | Encode an SVT's source files. |
reimport_compressed_volume(volume) | Encode again, keeping settings. |
create_material_from_compressed_volume(volume, preset, package) | Generate a material. |
create_material_from_preset(svt, preset, package) | The same for an SVT. |
bake_scatter_field_for_compressed_volume(volume, radius=-1, falloff=-1, downscale=4, dest="") | Scatter bake. |
bake_scatter_field(svt, radius=-1, falloff=-1, downscale=4, dest="") | The same for an SVT. |
bake_fire_light_for_compressed_volume(volume) / bake_fire_light(svt) | Fire light bake. |
bake_flow_field(asset, cycle_frames=-1, downscale=4) | Micro detail flow bake. |
calibrate_compressed_volume_velocity(volume) | Velocity calibration. |
bake_loop(svt, start, end, blend, curve, dest) / bake_loop_for_compressed_volume(...) | Loop bake. End -1 is the last frame. |
save_clipped_copy(asset, min_fraction, max_fraction, package) | Cropped copy. |
link_preset(svt, preset) / get_linked_preset(svt) | Preset link. |
get_volume_report(path) / get_svt_report(path) | List volumes. |
get_compressed_volume_info(volume) / get_svt_info(svt) | One volume. |
export_svt_report_csv(file, path) | Report as CSV. |
analyse_svt_channels(svt, frame=-1) | Min and max of each channel. |
measure_burning_temperature(asset) | Burning temperature range. |
render_proxy_image(asset) | Regenerate the proxy image. |
create_gradient_curve_from_texture(texture) | Convert a gradient texture. |
compile_material_and_get_errors(material) | Compile now and return errors. |
ensure_plugin_content() | Recreate missing plugin content. |
Save the asset after a bake; none of them save automatically unless stated.