Skip to content

Glossary ​

Short explanations of the classes, data assets and terms used in this documentation. Class names with a dotted underline in the text show their description when you point at them (or tap them on a phone).

Actors and components ​

TermDescription
BP_FluxSimulationDomainRuns the shallow water simulation, captures the ground map and exports the simulation state.
BP_FluxCoastlineDomainBakes the area around the coast into a coastline state used to render coastline waves.
BP_FluxSurfaceRenders the water: surface, underwater post-process, caustics and audio. Use one of its templates.
BP_FluxOceanWaveOcean waves outside the simulation area, based on an animated 3D texture.
BP_FluxModifierComponentBase class of modifiers – components that change the simulation state.
BP_FluxModifierSourceComponentAdds or removes fluid and changes its velocity in an area.
BP_FluxModifierSourceActorActor for placing a source modifier in the level.
BP_FluxModifierWaveActorGenerates waves on the edges of the simulation domain.
FluxDataComponentReads water height, velocity and surface location for blueprints.
FluxHeightmapComponentCaptures the ground map from above. Used by both domains.
BP_FluxBuoyancyComponentApplies buoyancy, drag and current forces using pontoons.
FluxBuoyancyEditorEditor tool (EUW_FluxBuoyancyEditor) for editing pontoons in a 3D viewport.
BP_FluxInteractionCaptureSimulates ripples around the camera from overlapping interactive actors.
BP_FluxInteractionComponentStores the interaction sources (spheres) that create waves.
BPI_FluxInteractionInterface of interactive actors. GetInteractions returns their interaction sources.
BP_FluxSwimmingComponentExample swimming movement for the default mannequin.
BP_FluxDriverComponentLets the player character possess vehicles.
BP_FluxBuoyancyVehiclePawnTemplate of a drivable vehicle, e.g. the demo boat.
BP_FluxNiagaraActorSends simulation data to Niagara systems.
FluxWorldBrushPaints color, wave size or wave type on the water.
BP_FluxSurfaceMeshGeneratorBakes a simulation state into a static mesh.
BP_SDFVolumeDomainBuilds the SDF volume that cuts holes in the water surface.
BP_FluxGlassActorBase class of underwater glass actors.
BP_FluxSurfaceCutMaskRemoves the water surface in a rectangular area.

Data assets ​

TermDescription
PDA_FluxSimulationStateStores one frame of the simulation.
CoastlineStateStores the baked coastline data used by the surface.
PDA_FluxBuoyancyDataPontoons and density settings of a floating body.
BaseColorPresetSurface attribute that selects the water color preset.

Attributes ​

TermDescription
SurfaceActorReferenceDomain attribute: the surface actor that renders the domain’s data.
AffectWorldDomain attribute. False disables the domain, so an exported state can be rendered directly.
IsEditorOnlyActorEngine flag that removes the actor from the final build.
RuntimeCaptureDelayDelays the ground map capture at runtime until the level is loaded.

Terms ​

TermDescription
Ground mapHeight map of the scene that defines where water can flow.
PontoonSphere approximating part of a floating body.
SDFSigned distance field – a 3D texture with the distance to the nearest surface.
M_PhantomMeshMaterial visible only to the ground capture.
MF_FluxPixelDepthOffsetDisables Pixel Depth Offset during ground capture.