Skip to main content
Skip to main content

ShallowWaterSimulation

createShallowWaterSimulation

Description

Creates a shallow water simulation

Definition

createShallowWaterSimulation(string name, integer gridWidth, integer gridHeight, float physicalWidth, float physicalHeight, boolean? useHeightDisplacement)

Arguments

stringnamename
integergridWidthNumber of simulation grid cells in the x direction
integergridHeightNumber of simulation grid cells in the y direction
floatphysicalWidthPhysical (world) width of the whole grid
floatphysicalHeightPhysical (world) height/length of the whole grid
boolean?useHeightDisplacement[optional] Determines whether the simulation will make use of the height displacement of the water surface for rendering. Setting this to false assumes the output will only be used to modify water surface normals. Defaults to false

Return Values

entityIdshallowWaterSimulationIdID of the created simulation