Difference between revisions of "Wait (Procedure)"
Jump to navigation
Jump to search
imported>Henning m (moved Procedure Wait to Wait (Procedure)) |
m (Correct small typo) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Procedures | {{Procedures | ||
|Name=Wait | |Name=Wait | ||
|Description=If not paired with another procedure in a Simultaneous Branch, the '''Wait''' Procedure allows an actor to stop doing things for a defined period of time. If paired with another procedure in a [[:Category:Package_Templates#Branches| | |Description=If not paired with another procedure in a Simultaneous Branch, the '''Wait''' Procedure allows an actor to stop doing things for a defined period of real-world time. If paired with another procedure in a [[:Category:Package_Templates#Branches|Simultaneous Branch]], it will complete that branch after the specified amount of time. Time in menu mode is not counted. | ||
|Completes=After the specified time elapses. | |Completes=After the specified time elapses (the wait time counts down to zero). | ||
|Param1=ActualSeconds | |Param1=ActualSeconds | ||
|Type1=Float | |Type1=Float | ||
|Desc1=How | |Desc1=How many real-world secnds the procedure will wait until completing, not counting time in menus. A time of zero causes the wait procedure to never complete. | ||
|Param2=StopMovement | |Param2=StopMovement | ||
| Line 13: | Line 13: | ||
|Notes= | |Notes= | ||
* | * Interaction of the StopMovement flag with other procedures in a simultaneous branch is undocumented - please use with care and document the results of your tests on this page. | ||
* There are a wide range of other ways for Actors and scripts to wait, many of which are listed under [[Wait - Utility]]. | |||
* | |||
|SeeAlso= | |||
*[[Wait - Utility]] | |||
* | |||
}} | }} | ||
Latest revision as of 20:28, 2 October 2023
Behavior
Description:
If not paired with another procedure in a Simultaneous Branch, the Wait Procedure allows an actor to stop doing things for a defined period of real-world time. If paired with another procedure in a Simultaneous Branch, it will complete that branch after the specified amount of time. Time in menu mode is not counted.
The procedure completes:
After the specified time elapses (the wait time counts down to zero).
Parameters
- ActualSeconds (Float): How many real-world secnds the procedure will wait until completing, not counting time in menus. A time of zero causes the wait procedure to never complete.
- StopMovement (Bool): If this is true, it makes the actor stop moving -- which is to say, it stops the actor's pathfinding/locomotion. (It does not stop any other incidental animations.)
Notes
- Interaction of the StopMovement flag with other procedures in a simultaneous branch is undocumented - please use with care and document the results of your tests on this page.
- There are a wide range of other ways for Actors and scripts to wait, many of which are listed under Wait - Utility.
See Also