unreal.LinearTurnGenerator

class unreal.LinearTurnGenerator(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Modular mechanism for turning a Mover actor in place using linear angular velocity.

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: ModularMovement.h

Editor Properties: (see get_editor_property/set_editor_property)

  • heading_rate (float): [Read-Write] Maximum angular velocity of heading changes (degrees per second). AKA Yaw, AKA Z. Negative numbers will cause rotation to snap instantly to desired orientation.

  • pitch_rate (float): [Read-Write] Maximum angular velocity of pitch changes (degrees per second). Negative numbers will cause rotation to snap instantly to desired orientation.

  • roll_rate (float): [Read-Write] Maximum angular velocity of roll changes (degrees per second). Negative numbers will cause rotation to snap instantly to desired orientation.

get_turn(target_orientation, full_start_state, mover_state, time_step, proposed_move, sim_blackboard) → Vector

Returns an additive angular velocity (degrees/second) based on the starting state and timestep. The vector points in the direction of the rotation axis

Parameters:
Return type:

Vector

property heading_rate: float

[Read-Write] Maximum angular velocity of heading changes (degrees per second). AKA Yaw, AKA Z. Negative numbers will cause rotation to snap instantly to desired orientation.

Type:

(float)

property pitch_rate: float

[Read-Write] Maximum angular velocity of pitch changes (degrees per second). Negative numbers will cause rotation to snap instantly to desired orientation.

Type:

(float)

property roll_rate: float

[Read-Write] Maximum angular velocity of roll changes (degrees per second). Negative numbers will cause rotation to snap instantly to desired orientation.

Type:

(float)