unreal.PlanarConstraint

class unreal.PlanarConstraint(constrain_to_plane: bool = False, plane_constraint_normal: Vector = Ellipsis, plane_constraint_origin: Vector = Ellipsis)

Bases: StructBase

Encapsulates info about constraining movement to a plane, such as in a side-scroller

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: ConstrainedMoveUtils.h

Editor Properties: (see get_editor_property/set_editor_property)

  • constrain_to_plane (bool): [Read-Write] If true, movement will be constrained to a plane.

  • plane_constraint_normal (Vector): [Read-Write] 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. It is normalized once the component is registered with the game world.

  • plane_constraint_origin (Vector): [Read-Write] The origin of the plane that constrains movement, if plane constraint is enabled.

property constrain_to_plane: bool

[Read-Write] If true, movement will be constrained to a plane.

Type:

(bool)

property plane_constraint_normal: Vector

[Read-Write] 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. It is normalized once the component is registered with the game world.

Type:

(Vector)

property plane_constraint_origin: Vector

[Read-Write] The origin of the plane that constrains movement, if plane constraint is enabled.

Type:

(Vector)