unreal.SwimmingMode
¶
- class unreal.SwimmingMode(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
BaseMovementMode
SwimmingMode: a default movement mode for traversing water volumes
C++ Source:
Plugin: Mover
Module: Mover
File: SwimmingMode.h
Editor Properties: (see get_editor_property/set_editor_property)
shared_settings_class
(type(Class)): [Read-Write] Settings object type that this mode depends on. May be shared with other movement modes. When the mode is added to a Mover Component, it will create a shared instance of this settings class.surface_swimming_water_control_settings
(SwimmingControlSettings): [Read-Write]transitions
(Array[BaseMovementModeTransition]): [Read-Write] Transition checks for the current mode. Evaluated in order, stopping at the first successful transition check
- on_generate_move(start_state, time_step) ProposedMove ¶
On Generate Move
- Parameters:
start_state (MoverTickStartData) –
time_step (MoverTimeStep) –
- Returns:
out_proposed_move (ProposedMove):
- Return type:
- on_simulation_tick(params) MoverTickEndData ¶
On Simulation Tick
- Parameters:
params (SimulationTickParams) –
- Returns:
output_state (MoverTickEndData):
- Return type:
- property surface_swimming_water_control_settings: SwimmingControlSettings¶
[Read-Only]
- Type: