# WaveModifier(Modifier)

base classes — `bpy_struct`, `Modifier`

class `bpy.types.``WaveModifier`(Modifier)

  Wave effect modifier

  `damping_time`

    Number of frames in which the wave damps out after it dies

    Type: | float in [-300000, 300000], default 0.0

  `falloff_radius`

    Distance after which it fades out

    Type: | float in [0, inf], default 0.0

  `height`

    Height of the wave

    Type: | float in [-inf, inf], default 0.0

  `lifetime`

    Lifetime of the wave in frames, zero means infinite

    Type: | float in [-300000, 300000], default 0.0

  `narrowness`

    Distance between the top and the base of a wave, the higher the value, the more narrow the wave

    Type: | float in [0, inf], default 0.0

  `speed`

    Speed of the wave, towards the starting point when negative

    Type: | float in [-inf, inf], default 0.0

  `start_position_object`

    Object which defines the wave center

    Type: | `Object`

  `start_position_x`

    X coordinate of the start position

    Type: | float in [-inf, inf], default 0.0

  `start_position_y`

    Y coordinate of the start position

    Type: | float in [-inf, inf], default 0.0

  `texture`

    Type: | `Texture`

  `texture_coords`
    - `LOCAL` Local, Use the local coordinate system for the texture coordinates.
    - `GLOBAL` Global, Use the global coordinate system for the texture coordinates.
    - `OBJECT` Object, Use the linked object’s local coordinate system for the texture coordinates.
    - `UV` UV, Use UV coordinates for the texture coordinates.

    Type: | enum in [‘LOCAL’, ‘GLOBAL’, ‘OBJECT’, ‘UV’], default ‘LOCAL’

  `texture_coords_object`

    Object to set the texture coordinates

    Type: | `Object`

  `time_offset`

    Either the starting frame (for positive speed) or ending frame (for negative speed.)

    Type: | float in [-300000, 300000], default 0.0

  `use_cyclic`

    Cyclic wave effect

    Type: | boolean, default False

  `use_normal`

    Displace along normals

    Type: | boolean, default False

  `use_normal_x`

    Enable displacement along the X normal

    Type: | boolean, default False

  `use_normal_y`

    Enable displacement along the Y normal

    Type: | boolean, default False

  `use_normal_z`

    Enable displacement along the Z normal

    Type: | boolean, default False

  `use_x`

    X axis motion

    Type: | boolean, default False

  `use_y`

    Y axis motion

    Type: | boolean, default False

  `uv_layer`

    UV map name

    Type: | string, default “”, (never None)

  `vertex_group`

    Vertex group name for modulating the wave

    Type: | string, default “”, (never None)

  `width`

    Distance between the waves

    Type: | float in [0, inf], default 0.0

Inherited Properties

`bpy_struct.id_data` `Modifier.name` `Modifier.type` `Modifier.show_viewport` `Modifier.show_render` | `Modifier.show_in_editmode` `Modifier.show_on_cage` `Modifier.show_expanded` `Modifier.use_apply_on_spline`

Inherited Functions

`bpy_struct.as_pointer` `bpy_struct.driver_add` `bpy_struct.driver_remove` `bpy_struct.get` `bpy_struct.is_property_hidden` `bpy_struct.is_property_readonly` `bpy_struct.is_property_set` `bpy_struct.items` | `bpy_struct.keyframe_delete` `bpy_struct.keyframe_insert` `bpy_struct.keys` `bpy_struct.path_from_id` `bpy_struct.path_resolve` `bpy_struct.property_unset` `bpy_struct.type_recast` `bpy_struct.values`