- class unreal.PawnMovementComponent(outer=None, name='None')¶
PawnMovementComponent can be used to update movement for an associated Pawn. It also provides ways to accumulate and read directional input in a generic way (with AddInputVector(), ConsumeInputVector(), etc). see: APawn
Editor Properties: (see get_editor_property/set_editor_property)
asset_user_data(Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the component
auto_activate(bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.
auto_register_physics_volume_updates(bool): [Read-Write] Auto Register Physics Volume Updates: If true, then applies the value of bComponentShouldUpdatePhysicsVolume to the UpdatedComponent. If false, will not change bShouldUpdatePhysicsVolume on the UpdatedComponent at all. see: bComponentShouldUpdatePhysicsVolume
auto_register_updated_component(bool): [Read-Write] Auto Register Updated Component: If true, registers the owner’s Root component as the UpdatedComponent if there is not one currently assigned.
auto_update_tick_registration(bool): [Read-Write] Auto Update Tick Registration: If true, whenever the updated component is changed, this component will enable or disable its tick dependent on whether it has something to update. This will NOT enable tick at startup if bAutoActivate is false, because presumably you have a good reason for not wanting it to start ticking initially.
can_ever_affect_navigation(bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation
component_should_update_physics_volume(bool): [Read-Write] Component Should Update Physics Volume: If true, enables bShouldUpdatePhysicsVolume on the UpdatedComponent during initialization from SetUpdatedComponent(), otherwise disables such updates. Only enabled if bAutoRegisterPhysicsVolumeUpdates is true. WARNING: UpdatePhysicsVolume is potentially expensive if overlap events are also disabled because it requires a separate query against all physics volumes in the world.
component_tags(Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.
constrain_to_plane(bool): [Read-Write] Constrain to Plane: If true, movement will be constrained to a plane. see: PlaneConstraintNormal, PlaneConstraintOrigin, PlaneConstraintAxisSetting
editable_when_inherited(bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class
fixed_path_braking_distance(float): [Read-Write] Fixed Path Braking Distance: Braking distance override used with acceleration driven path following (bUseAccelerationForPaths)
is_editor_only(bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds
nav_agent_props(NavAgentProperties): [Read-Write] Nav Agent Props: Properties that define how the component can move.
on_component_activated(ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset
on_component_deactivated(ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated
plane_constraint_axis_setting(PlaneConstraintAxisSetting): [Read-Write] Plane Constraint Axis Setting: Setting that controls behavior when movement is restricted to a 2D plane defined by a specific axis/normal, so that movement along the locked axis is not be possible. see: SetPlaneConstraintAxisSetting
plane_constraint_normal(Vector): [Read-Write] Plane Constraint Normal: The normal or axis of the plane that constrains movement, if bConstrainToPlane is enabled. If for example you wanted to constrain movement to the X-Z plane (so that Y cannot change), the normal would be set to X=0 Y=1 Z=0. This is recalculated whenever PlaneConstraintAxisSetting changes. It is normalized once the component is registered with the game world. see: bConstrainToPlane, SetPlaneConstraintNormal(), SetPlaneConstraintFromVectors()
plane_constraint_origin(Vector): [Read-Write] Plane Constraint Origin: The origin of the plane that constrains movement, if plane constraint is enabled. This defines the behavior of snapping a position to the plane, such as by SnapUpdatedComponentToPlane(). see: bConstrainToPlane, SetPlaneConstraintOrigin().
primary_component_tick(ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component
replicates(bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
snap_to_plane_at_start(bool): [Read-Write] Snap to Plane at Start: If true and plane constraints are enabled, then the updated component will be snapped to the plane when first attached.
tick_before_owner(bool): [Read-Write] Tick Before Owner: If true, after registration we will add a tick dependency to tick before our owner (if we can both tick). This is important when our tick causes an update in the owner’s position, so that when the owner ticks it uses the most recent position without lag. Disabling this can improve performance if both objects tick but the order of ticks doesn’t matter.
update_nav_agent_with_owners_collision(bool): [Read-Write] Update Nav Agent with Owners Collision: If set to true NavAgentProps’ radius and height will be updated with Owner’s collision capsule size
update_only_if_rendered(bool): [Read-Write] Update Only if Rendered: If true, skips TickComponent() if UpdatedComponent was not recently rendered.
updated_component(SceneComponent): [Read-Write] Updated Component: The component we move and update. If this is null at startup and bAutoRegisterUpdatedComponent is true, the owning Actor’s root component will automatically be set as our UpdatedComponent at startup. see: bAutoRegisterUpdatedComponent, SetUpdatedComponent(), UpdatedPrimitive
updated_primitive(PrimitiveComponent): [Read-Write] Updated Primitive: UpdatedComponent, cast as a UPrimitiveComponent. May be invalid if UpdatedComponent was null or not a UPrimitiveComponent.
use_acceleration_for_paths(bool): [Read-Write] Use Acceleration for Paths: If set, pathfollowing will control character movement via acceleration values. If false, it will set velocities directly.
use_fixed_braking_distance_for_paths(bool): [Read-Write] Use Fixed Braking Distance for Paths: If set, FixedPathBrakingDistance will be used for path following deceleration
velocity(Vector): [Read-Write] Velocity: Current velocity of updated component.
- add_input_vector(world_vector, force=False) None ¶
Adds the given vector to the accumulated input in world space. Input vectors are usually between 0 and 1 in magnitude. They are accumulated during a frame then applied as acceleration during the movement update. see: APawn::AddMovementInput()
- consume_input_vector() Vector ¶
- Returns the pending input vector and resets it to zero.
This should be used during a movement update (by the Pawn or PawnMovementComponent) to prevent accumulation of control input between frames.
Copies the pending input vector to the saved input vector (GetLastMovementInputVector()).
The pending input vector.
- Return type
deprecated: ‘get_input_vector’ was renamed to ‘get_pending_input_vector’.
- get_last_input_vector() Vector ¶
Return the last input vector in world space that was processed by ConsumeInputVector(), which is usually done by the Pawn or PawnMovementComponent. Any user that needs to know about the input that last affected movement should use this function. see: AddInputVector(), ConsumeInputVector(), GetPendingInputVector()
The last input vector in world space that was processed by ConsumeInputVector().
- Return type
- get_pending_input_vector() Vector ¶
Return the pending input vector in world space. This is the most up-to-date value of the input vector, pending ConsumeMovementInputVector() which clears it. PawnMovementComponents implementing movement usually want to use either this or ConsumeInputVector() as these functions represent the most recent state of input. see: AddInputVector(), ConsumeInputVector(), GetLastInputVector()
The pending input vector in world space.
- Return type