ScriptAction QML Type

Defines scripts to be run during an animation. More...

Import Statement: import QtQuick 2.14
Inherits:

Animation

Properties

Detailed Description

ScriptAction can be used to run a script at a specific point in an animation.

SequentialAnimation {
    NumberAnimation {
        // ...
    }
    ScriptAction { script: doSomething(); }
    NumberAnimation {
        // ...
    }
}

When used as part of a Transition, you can also target a specific StateChangeScript to run using the scriptName property.

State {
    name: "state1"
    StateChangeScript {
        name: "myScript"
        script: doStateStuff();
    }
    // ...
}
// ...
Transition {
    to: "state1"
    SequentialAnimation {
        NumberAnimation { /* ... */ }
        ScriptAction { scriptName: "myScript" }
        NumberAnimation { /* ... */ }
    }
}

See also StateChangeScript.

Property Documentation

script : script

This property holds the script to run.

scriptName : string

This property holds the name of the StateChangeScript to run.

This property is only valid when ScriptAction is used as part of a transition. If both script and scriptName are set, scriptName will be used.

Note: When using scriptName in a reversible transition, the script will only be run when the transition is being run forwards.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.14/qml-qtquick-scriptaction.html