unreal.QuartzQuantizationBoundary

class unreal.QuartzQuantizationBoundary(quantization=QuartzCommandQuantization.NONE, multiplier=1.0, counting_reference_point=QuarztQuantizationReference.BAR_RELATIVE, fire_on_clock_start=True, cancel_command_if_clock_is_not_running=False, reset_clock_on_queued=False, resume_clock_on_queued=False)

Bases: unreal.StructBase

struct used to specify the quantization boundary of an event

C++ Source:

  • Module: Engine

  • File: QuartzQuantizationUtilities.h

Editor Properties: (see get_editor_property/set_editor_property)

  • cancel_command_if_clock_is_not_running (bool): [Read-Write] Cancel Command if Clock Is Not Running: If this is true, this command will be canceled if the Clock is stopped or otherwise not running

  • counting_reference_point (QuarztQuantizationReference): [Read-Write] Counting Reference Point

  • fire_on_clock_start (bool): [Read-Write] Fire on Clock Start: If this is true and the Clock hasn’t started yet, the event will fire immediately when the Clock starts

  • multiplier (float): [Read-Write] Multiplier: how many “Resolutions” to wait before the onset we care about

  • quantization (QuartzCommandQuantization): [Read-Write] Quantization: resolution we are interested in

  • reset_clock_on_queued (bool): [Read-Write] Reset Clock on Queued: If this is true, queueing the sound will also call a Reset Clock command

  • resume_clock_on_queued (bool): [Read-Write] Resume Clock on Queued: If this is true, queueing the sound will also call a Resume Clock command

property cancel_command_if_clock_is_not_running

[Read-Write] Cancel Command if Clock Is Not Running: If this is true, this command will be canceled if the Clock is stopped or otherwise not running

Type

(bool)

property counting_reference_point

[Read-Write] Counting Reference Point

Type

(QuarztQuantizationReference)

property fire_on_clock_start

[Read-Write] Fire on Clock Start: If this is true and the Clock hasn’t started yet, the event will fire immediately when the Clock starts

Type

(bool)

property multiplier

[Read-Write] Multiplier: how many “Resolutions” to wait before the onset we care about

Type

(float)

property quantization

[Read-Write] Quantization: resolution we are interested in

Type

(QuartzCommandQuantization)

property reset_clock_on_queued

[Read-Write] Reset Clock on Queued: If this is true, queueing the sound will also call a Reset Clock command

Type

(bool)

property resume_clock_on_queued

[Read-Write] Resume Clock on Queued: If this is true, queueing the sound will also call a Resume Clock command

Type

(bool)