unreal.WaterCheckResult

class unreal.WaterCheckResult(swimmable_volume: bool = False, hit_result: HitResult = Ellipsis, water_spline_data: WaterFlowSplineData = [])

Bases: StructBase

Data about the overlapping volume typically used for swimming

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: WaterMovementUtils.h

Editor Properties: (see get_editor_property/set_editor_property)

  • hit_result (HitResult): [Read-Only] Hit result of the test that found a volume. Includes more specific data about the point of impact and surface normal at that point.

  • swimmable_volume (bool): [Read-Only] True if the hit found a valid swimmable volume.

  • water_spline_data (WaterFlowSplineData): [Read-Only] Water Spline data to be used in calculating swimming movement, FX, etc.

property hit_result: HitResult

[Read-Only] Hit result of the test that found a volume. Includes more specific data about the point of impact and surface normal at that point.

Type:

(HitResult)

property swimmable_volume: bool

[Read-Only] True if the hit found a valid swimmable volume.

Type:

(bool)

property water_spline_data: WaterFlowSplineData

[Read-Only] Water Spline data to be used in calculating swimming movement, FX, etc.

Type:

(WaterFlowSplineData)