unreal.BoostMotorSimComponent

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

Bases: AudioMotorSimComponent

Uses Boost input to momentarily scale throttle input and pitch output

C++ Source:

  • Plugin: AudioMotorSim

  • Module: AudioMotorSimStandardComponents

  • File: BoostMotorSimComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • boost_to_pitch_curve (RuntimeFloatCurve): [Read-Write] Curve to derive final pitch value (in playback speed) from boost strength

  • cached_input (AudioMotorSimInputContext): [Read-Write] Input data after running this component

  • cached_runtime_info (AudioMotorSimRuntimeContext): [Read-Write] runtime info after running this component

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • component_tags (Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • enabled (bool): [Read-Write] will only update if enabled

  • interp_exp (float): [Read-Write] controls shape of the scaling

  • interp_time (float): [Read-Write] How fast the torque scales when starting to boost

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • modify_pitch (bool): [Read-Write] whether scale the overall pitch by the boost strength

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • pitch_modifier_interp_speed (float): [Read-Write] Speed at which pitch approaches its target value

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • scale_throttle_with_boost_strength (bool): [Read-Write] whether to use the boost strength to scale ThrottleScale, or just check if it is > 0 to apply the throttle scalar

  • throttle_scale (float): [Read-Write] Scale the engine torque by this value when boost is active