UE2:ACTION WaitForTimer (UT2004): Difference between revisions
Auto-generated page |
filled in class description and mentioned trigger completion bug |
||
| Line 5: | Line 5: | ||
| parent3 = Object | | parent3 = Object | ||
}} | }} | ||
{{ | A latent action for {{cl|AIScript}}s that waits for a certain amount of time to pass. | ||
'''Note:''' For some reason this action was implemented to not only complete when the time interval has passed, but also earlier if it was preceded by an {{cl|ACTION_WaitForTrigger}} and the same event as specified in the WaitForTrigger action is triggered again when the WaitForTimer action is active. If this causes problems with your script sequence, try using the custom class [[UE2:ACTION_WaitOnlyForTimer (UT2004)|ACTION_WaitOnlyForTimer]] instead. | |||
==Properties== | ==Properties== | ||
| Line 13: | Line 14: | ||
'''Type:''' [[float]] | '''Type:''' [[float]] | ||
The time interval that must pass before this action completed. Waiting time may be reduced due to the "trigger completion" feature mentioned above. | |||
===Default values=== | ===Default values=== | ||
| Line 30: | Line 31: | ||
'''Overrides:''' {{tl|CompleteWhenTimer|LatentScriptedAction}} | '''Overrides:''' {{tl|CompleteWhenTimer|LatentScriptedAction}} | ||
Returns ''True'' to signal that this action waits for a timer event to complete. | |||
====CompleteWhenTriggered==== | ====CompleteWhenTriggered==== | ||
| Line 37: | Line 38: | ||
'''Overrides:''' {{tl|CompleteWhenTriggered|LatentScriptedAction}} | '''Overrides:''' {{tl|CompleteWhenTriggered|LatentScriptedAction}} | ||
Returns ''True'' to signal that this action waits for a trigger event. This is the origin of the "trigger completion" bug/feature mentioned in the class description. | |||
====GetActionString==== | ====GetActionString==== | ||
| Line 44: | Line 45: | ||
'''Overrides:''' {{tl|GetActionString|ScriptedAction}} | '''Overrides:''' {{tl|GetActionString|ScriptedAction}} | ||
Returns the {{tl|ActionString||ScriptedAction}} space-concatenated with the {{tl|PauseTime}}. | |||
====InitActionFor==== | ====InitActionFor==== | ||
| Line 51: | Line 52: | ||
'''Overrides:''' {{tl|InitActionFor|LatentScriptedAction}} | '''Overrides:''' {{tl|InitActionFor|LatentScriptedAction}} | ||
Sets up the timer of the sequence controller. | |||
Revision as of 09:48, 30 November 2008
|
Object >> ScriptedAction >> LatentScriptedAction >> ACTION_WaitForTimer |
- Package:
- Gameplay
- Known custom subclasses:
- ACTION_WaitOnlyForTimer (UT2004), Crusha/UltimateMappingTools
- This class in other games:
A latent action for AIScripts that waits for a certain amount of time to pass.
Note: For some reason this action was implemented to not only complete when the time interval has passed, but also earlier if it was preceded by an ACTION_WaitForTrigger and the same event as specified in the WaitForTrigger action is triggered again when the WaitForTimer action is active. If this causes problems with your script sequence, try using the custom class ACTION_WaitOnlyForTimer instead.
Properties
Property group 'Action'
PauseTime
Type: float
The time interval that must pass before this action completed. Waiting time may be reduced due to the "trigger completion" feature mentioned above.
Default values
| Property | Value |
|---|---|
| ActionString | "Wait for timer" |
Instance functions
CompleteWhenTimer
Overrides: LatentScriptedAction.CompleteWhenTimer
Returns True to signal that this action waits for a timer event to complete.
CompleteWhenTriggered
Overrides: LatentScriptedAction.CompleteWhenTriggered
Returns True to signal that this action waits for a trigger event. This is the origin of the "trigger completion" bug/feature mentioned in the class description.
GetActionString
Overrides: ScriptedAction.GetActionString
Returns the ActionString space-concatenated with the PauseTime.
InitActionFor
Overrides: LatentScriptedAction.InitActionFor
Sets up the timer of the sequence controller.
