Class WaterSettings

constructor

• new WaterSettings(isInternalConstructor?): WaterSettings

• Parameters

  • OptionalisInternalConstructor: boolean

  Returns WaterSettings

material

• get material(): Material

• Material that controls how objects are rendered. It is represented by a shader and parameters used to set up that shader. It provides a simple interface for manipulating the parameters.

  Returns Material
• set material(value): void

• Material that controls how objects are rendered. It is represented by a shader and parameters used to set up that shader. It provides a simple interface for manipulating the parameters.

  Parameters

  • value: Material

  Returns void

materialHandle

• get materialHandle(): ResourceHandle<Material>

• Material that controls how objects are rendered. It is represented by a shader and parameters used to set up that shader. It provides a simple interface for manipulating the parameters.

  Returns ResourceHandle<Material>
• set materialHandle(value): void

• Parameters

  • value: Material | ResourceHandle<Material>

  Returns void

waterLevel

• get waterLevel(): number

• The level of the water in scene units.

  Returns number
• set waterLevel(value): void

• Parameters

  • value: number

  Returns void

markAsDirty

• markAsDirty(dirtyFlags): void

• Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action): void

• Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

  Parameters

  • action: (() => void)

    The scope where the object is modified.

    • • (): void

      • Returns void

  Returns void

ReadonlyonDirty