Small World Engine API Reference - v0.76.20
    Preparing search index...

    Class FluidSurfaceMaterial

    A robust material for rendering fluid surfaces like water, lava, or slime with depth fade.

    Hierarchy (View Summary)

    Index
    constructor
    _renderManifest color cullMode depthTest depthWrite distortion edgeColor flowSpeed noiseMap normalMap time transparent type uuid viscosity
    _createBaseManifest _syncBaseManifestState _syncTexOffsetRepeat getRenderManifest getShaderDefinition

    Protected_renderManifest

    _renderManifest: RenderManifest | undefined = undefined

    Cached render manifest to avoid frequent allocations.

    color: Color

    The base color of the fluid.

    cullMode: CullMode = CullMode.DEFAULT

    The culling mode for this material. Defaults to BACK.

    depthTest: boolean = true

    Whether the material performs depth testing. Defaults to true.

    depthWrite: boolean = true

    Whether the material writes to the depth buffer. Defaults to true.

    distortion: number

    The scale of the noise distortion.

    edgeColor: Color

    The color of the edge intersection.

    flowSpeed: number

    The speed of the flow animation.

    noiseMap: Texture | undefined

    The noise texture.

    normalMap: Texture | undefined

    Optional normal map.

    time: number = 0.0

    The current time/frame for animation.

    transparent: boolean = false

    Whether the material is transparent. Defaults to false.

    type: string

    The type of the material.

    uuid: string = ...

    The unique identifier of the material.

    viscosity: number

    The viscosity (controls wave properties).

    Protected_createBaseManifest

    Protected_syncBaseManifestState

    Protected_syncTexOffsetRepeat

    • _syncTexOffsetRepeat(
          tex:
              | {
                  offset: { x: number; y: number };
                  repeat: { x: number; y: number };
              }
              | undefined,
      ): void

      Helper to synchronize texture offset and repeat from a given texture.

      Parameters

      • tex:
            | { offset: { x: number; y: number }; repeat: { x: number; y: number } }
            | undefined

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods