RSX Code Reference
    Preparing search index...
    • rsx
    • WaterSettings

    Class WaterSettings

    Class that triggers an onDirty event when one of its members changes.

    Index
    • Parameters

      • OptionalisInternalConstructor: boolean

      Returns WaterSettings

    • 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: Material): 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

      Returns void

    • get waterLevel(): number

      The level of the water in scene units.

      Returns number

    • set waterLevel(value: number): void

      Parameters

      • value: number

      Returns 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.

      Returns void

    onDirty: Event<[dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>]>

    Event that is triggered when a member changes.