EK: Created page with "Stop an active action (an action that is currently being executed). {| class="ts" |- | style="width:15%" | Related functions | startAction |}..."

2023-05-03T10:01:54Z

Created page with "Stop an active action (an action that is currently being executed). {| class="ts" |- | style="width:15%" | Related functions | startAction |}..."

New page

Stop an active action (an action that is currently being executed).

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: startAction|startAction]]
|}

== Syntax ==
<syntaxhighlight lang="lua">
stopAction(action)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| action
| TVisObj
| Visionaire object representing an active action.
|}

== Return values ==

none

== Examples ==

'''Example 1:''' Stop an active action.
<syntaxhighlight lang="lua">
local myActiveAction = ActiveActions["action_name"]
stopAction(myActiveAction)
</syntaxhighlight>

'''Example 2:''' Start an action and stop it after a certain time, depending on a Visionaire value called "duration" holding the amount of seconds.
<syntaxhighlight lang="lua">
local myDelay = Values["duration"].Int
myActiveAction = startAction(Actions["action_name"])

setDelay(myDelay * 1000, "stopAction(myActiveAction)")
</syntaxhighlight>
{{toc}}

Global Command: stopAction - Revision history

EK: Created page with "Stop an active action (an action that is currently being executed). {| class="ts" |- | style="width:15%" | Related functions | startAction |}..."