Learn / Documentation / Script Reference / ProgressTargetAction
Manual

ProgressTargetAction

class in Doozy.Engine.Progress / Inherits from ProgressTarget

Description

The ProgressTargetAction class is used by a Progressor to trigger an UIAction at a set progress or value

Properties

  • public bool IsActive – Returns TRUE if the UIAction can be triggered

Public Variables

  • public UIAction ActionsUIAction executed when triggered

  • public CompareType CompareMethod – Determines how the trigger value should be compared to the target value

  • public bool DisableTriggerAfterActivation – If TRUE, the trigger will get disabled after it has been activated

  • public bool ResetAfterDelay – If TRUE, the trigger will reset after a set reset delay

  • public float ResetDelay – Time duration to wait before enabling the trigger, after it has been activated. If Reset After Delay is enabled.

  • public bool ResetOnDisable – If TRUE, the trigger will reset OnDisable

  • public bool ResetOnEnable – If TRUE, the trigger will reset OnEnable

  • public float TriggerValue – The value that will trigger the UIAction

  • public float TriggerMinValue – The minimum value that will trigger the UIAction

  • public float TriggerMaxValue – The maximum value that will trigger the UIAction

  • public ProgressorVariable TargetVariable – The Progressor variable that will get compared with the TargetValue

  • public float Tolerance – Minimum tolerance to trigger this UIAction

  • public bool UseUnscaledTime – If TRUE, unscaled delta time will be used for the reset delay. Otherwise, the scaled delta time well get used

Public Methods

  • public void ResetTrigger() – Reset the trigger

  • public void TriggerActions() – Trigger the Actions (UIAction)

  • public void UpdateTarget(Progressor progressor) – Method used by a Progressor to when the current Value has changed