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
| Term | Description |
|---|---|
BP_FluxSimulationDomain | Runs the shallow water simulation, captures the ground map and exports the simulation state. |
BP_FluxCoastlineDomain | Bakes the area around the coast into a coastline state used to render coastline waves. |
BP_FluxSurface | Renders the water: surface, underwater post-process, caustics and audio. Use one of its templates. |
BP_FluxOceanWave | Ocean waves outside the simulation area, based on an animated 3D texture. |
BP_FluxModifierComponent | Base class of modifiers – components that change the simulation state. |
BP_FluxModifierSourceComponent | Adds or removes fluid and changes its velocity in an area. |
BP_FluxModifierSourceActor | Actor for placing a source modifier in the level. |
BP_FluxModifierWaveActor | Generates waves on the edges of the simulation domain. |
FluxDataComponent | Reads water height, velocity and surface location for blueprints. |
FluxHeightmapComponent | Captures the ground map from above. Used by both domains. |
BP_FluxBuoyancyComponent | Applies buoyancy, drag and current forces using pontoons. |
FluxBuoyancyEditor | Editor tool (EUW_FluxBuoyancyEditor) for editing pontoons in a 3D viewport. |
BP_FluxInteractionCapture | Simulates ripples around the camera from overlapping interactive actors. |
BP_FluxInteractionComponent | Stores the interaction sources (spheres) that create waves. |
BPI_FluxInteraction | Interface of interactive actors. GetInteractions returns their interaction sources. |
BP_FluxSwimmingComponent | Example swimming movement for the default mannequin. |
BP_FluxDriverComponent | Lets the player character possess vehicles. |
BP_FluxBuoyancyVehiclePawn | Template of a drivable vehicle, e.g. the demo boat. |
BP_FluxNiagaraActor | Sends simulation data to Niagara systems. |
FluxWorldBrush | Paints color, wave size or wave type on the water. |
BP_FluxSurfaceMeshGenerator | Bakes a simulation state into a static mesh. |
BP_SDFVolumeDomain | Builds the SDF volume that cuts holes in the water surface. |
BP_FluxGlassActor | Base class of underwater glass actors. |
BP_FluxSurfaceCutMask | Removes the water surface in a rectangular area. |
Data assets
| Term | Description |
|---|---|
PDA_FluxSimulationState | Stores one frame of the simulation. |
CoastlineState | Stores the baked coastline data used by the surface. |
PDA_FluxBuoyancyData | Pontoons and density settings of a floating body. |
BaseColorPreset | Surface attribute that selects the water color preset. |
Attributes
| Term | Description |
|---|---|
SurfaceActorReference | Domain attribute: the surface actor that renders the domain’s data. |
AffectWorld | Domain attribute. False disables the domain, so an exported state can be rendered directly. |
IsEditorOnlyActor | Engine flag that removes the actor from the final build. |
RuntimeCaptureDelay | Delays the ground map capture at runtime until the level is loaded. |
Terms
| Term | Description |
|---|---|
Ground map | Height map of the scene that defines where water can flow. |
Pontoon | Sphere approximating part of a floating body. |
SDF | Signed distance field – a 3D texture with the distance to the nearest surface. |
M_PhantomMesh | Material visible only to the ground capture. |
MF_FluxPixelDepthOffset | Disables Pixel Depth Offset during ground capture. |
