Skip to main content

SimFluid

17 tools in this family (folder Editor/Tools/SimFluid/ 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.

ToolEffectDescription
sim_fluid_add_buoyancy_bodywritesMake a Rigidbody float in the fluid using Archimedes' principle (F = ρ · V · g per sample point).
sim_fluid_add_capsule_colliderwritesAdd a capsule body collider that fluid particles collide with. Capsule is defined by two end-points
sim_fluid_add_force_fieldwritesAttach an attractor (positive strength) or repellor (negative strength) force field to the fluid.
sim_fluid_add_sphere_colliderwritesAdd a sphere body collider that fluid particles collide with. Centre is local if 'attached_to' is
sim_fluid_add_wind_zonewritesAttach a wind zone to a fluid. Shapes: 'global' (uniform direction), 'sphere' (linear falloff from
sim_fluid_apply_material_presetwritesApply a named fluid material preset to an existing fluid actor. Mass, density, viscosity, surface
sim_fluid_burstwritesEmit a one-shot burst of N particles centred at a world position. Velocity is randomised inside a
sim_fluid_configure_foamwritesTune the secondary foam / mist sim. Foam spawns when a fluid particle's impact velocity against a
sim_fluid_configure_mesh_reconstructionwritesEnable surface-mesh extraction via marching-cubes-like iso-surface reconstruction over the fluid's
sim_fluid_create_emitterwritesCreate a fluid emitter (SPH actor) under the given id and attach it to a Transform.
sim_fluid_export_setupread-onlyExport a fluid actor's full configuration (material, properties, shape, foam, mesh reconstruction,
sim_fluid_get_stateread-onlyRead the runtime state of a fluid actor — particle count, foam count, average density, surface Y,
sim_fluid_resetwritesReset a fluid actor: kill every active particle and foam particle, clear emission accumulators,
sim_fluid_set_emission_modewritesSwitch how the emitter feeds particles to the solver. Continuous (steady stream), Burst (one
sim_fluid_set_emitter_shapewritesChange an emitter's spawn shape. Point = single-point fountain, Circle = disk (radius), Box = AABB
sim_fluid_set_materialwritesOverride individual fluid material parameters on an existing actor. Omitted fields keep their
sim_fluid_set_solverwritesConfigure the SPH solver: substep count (1..16, higher = more stable but slower), iteration count