DuAEF

The Duduf After Effects ExtendScript Framework.
by Rainbox Lab.
Version:
  • 0.1.1-Beta
Author:
  • Nicolas Dufresne and contributors
Copyright:
  • 2017 - 2019 Nicolas Dufresne, Rainbox Laboratory
License:
  • GPL-3.0
    DuAEF is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    DuAEF is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DuAEF. If not, see http://www.gnu.org/licenses/. })(this);

Example

//Encapsulate the script in a function to avoid global variables.
(function(thisObj) {
    //include the framework
    #include DuAEF.jsxinc
    //you need to initialize DuAEF, with a script name and a version
    DuAEF.init("YourScriptName", "1.0.2");
    //The framework version is
    DuAEF.version;
    //If you need to get the OS the script is running on
    DuAEF.mac; //true on mac
    DuAEF.win; //true on windows
    //implement what you need, build the UI....
    //At the end, after everything in your script has been loaded and initilized, you need to tell DuAEF you're now in runtime
    DuAEF.enterRunTime();

Namespaces

Audition
DuAEF.Audition

Debug
DuAEF.Debug

DuAE
DuAEF.DuAE

DuBinary
DuAEF.DuBinary

DuExpression
DuAEF.DuExpression

Dugr
DuAEF.Dugr

Duik
DuAEF.Duik

DuJS
DuAEF.DuJS

DuRenderer
DuAEF.DuRenderer

DuRSS
DuAEF.DuRSS

DuScriptUI
DuAEF.DuScriptUI

DuSystem
DuAEF.DuSystem

Dutranslator
DuAEF.Dutranslator

DuXML
DuAEF.DuXML

Interchange
DuAEF.Interchange

Krita
DuAEF.Krita

Ramses
DuAEF.Ramses

TVPaint
DuAEF.TVPaint

WUStoryboarder
DuAEF.WUStoryboarder

Zip
DuAEF.Zip

Members

static aboutURL
DuAEF.jsxinc, line 100

The url about the script

static bugReportURL
DuAEF.jsxinc, line 92

The url for reporting bugs

static chatURL
DuAEF.jsxinc, line 88

The url for a chat server about the script

static debug :boolean
DuAEF.jsxinc, line 59

Set to true and enable debug mode if you're a developper

static DuPseudoEffect
DuAEF.jsxinc, line 32845

Tools to manage pseudo effects.

static featureRequestURL
DuAEF.jsxinc, line 96

The url for requesting features

static, readonly file :File
DuAEF.jsxinc, line 112

The current DuAEF File

static forumURL
DuAEF.jsxinc, line 84

The url for the forum about the script

static, readonly mac :boolean
DuAEF.jsxinc, line 142

The current OS, true if we're on Mac OS

static scriptAbout
DuAEF.jsxinc, line 104

The text about the script

static, readonly scriptFirstRun :boolean
DuAEF.jsxinc, line 80

True if the script is run for the first time (new or the version has changed since last run)

static, readonly scriptName :string
DuAEF.jsxinc, line 66

The name of the script using this instance of DuAEF. Must be set by DuAEF.init.

static, readonly scriptVersion :string
DuAEF.jsxinc, line 73

The version of the script using this instance of DuAEF. Must be set by DuAEF.init.

static state :DuAEF.States
DuAEF.jsxinc, line 129

The current state of the script

static, readonly States :int
DuAEF.jsxinc, line 119

Enum for states.
Properties:
Name Type Description
NOT_SET int
INIT int
RUNTIME int

static, readonly version :string
DuAEF.jsxinc, line 53

The Current DuAEF Version

static, readonly win :boolean
DuAEF.jsxinc, line 149

The current OS, true if we're on Windows

Methods

static enterRunTime()
DuAEF.jsxinc, line 178

This method has to be called once at the end of the script, when everything is ready and the main UI visible (after any prompt or setup during startup).

static init(scriptNameopt, scriptVersionopt)
DuAEF.jsxinc, line 157

This method has to be called once at the very beginning of the script, just after the inclusion of DuAEF #include DuAEF.jsxinc
Parameters:
Name Type Attributes Default Description
scriptName string <optional>
 "DuAEF" The name of your script, as it has to be displayed in the UI and the filesystem
scriptVersion string <optional>
 "0.0.0" The version of your script, in the form "XX.XX.XX-Comment", for example "1.0.12-Beta". The "-Comment" part is optional.