DuAEF

The Duduf After Effects ExtendScript Framework.
by Rainbox Lab.
Version:
  • 0.10.2
Author:
  • Nicolas Dufresne and contributors
Copyright:
  • 2017 - 2020 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/.

Examples

// MINIMAL EXAMPLE
//encapsulate the script in a function to avoid global variables
(function (thisObj) {

    //================
    #include DuAEF.jsxinc
    DuAEF.init("Your Script Name", "1.0.2");

    //YOUR CODE HERE

    DuAEF.enterRunTime();
}
//encapsulate the script in a function to avoid global variables
  (function (thisObj) {

      //================
      #include DuAEF.jsxinc
      DuAEF.init("Your Script Name", "1.0.2");

      DuAEF.forumURL = 'https://forum.rainboxlab.org';
      DuAEF.chatURL = 'http://chat.rainboxlab.org';
      DuAEF.bugReportURL = 'https://github.com/Rainbox-dev/DuAEF/issues/new?template=bug_report.md';
      DuAEF.featureRequestURL = 'https://github.com/Rainbox-dev/DuAEF/issues/new?template=feature_request.md';
      DuAEF.aboutURL = 'https://rainboxlab.org/tools/duik/';
      DuAEF.scriptAbout = 'The Duduf After Effects Framework\nDeveloped by Nicolas Dufresne and Contributors.\n\nLicensed under the GNU General Public License v3.';
      DuAEF.newsServer = 'rainboxprod.net'
      DuAEF.newsArgs = 'wp/?call_custom_simple_rss=1&csrp_show_meta=0&csrp_cat=20';

      // ================ FUNCTIONS =============
      //MAIN


      //UI EVENTS


      // _______ UI SETUP _______
      var ui = DuAEF.DuScriptUI.createUI(thisObj);

      // ============ UI CONTENT =================
      var contents = ui.contents;
      DuAEF.DuScriptUI.addStaticText(contents, "Welcome to " + DuAEF.scriptName);


      //Show UI
      DuAEF.DuScriptUI.showUI(ui);
      DuAEF.enterRunTime();
  })(this);

Namespaces

Audition
DuAEF.Audition

Debug
DuAEF.Debug

DuAE
DuAEF.DuAE

DuBinary
DuAEF.DuBinary

Dugr
DuAEF.Dugr

Duik
DuAEF.Duik

DuJS
DuAEF.DuJS

DuProcess
DuAEF.DuProcess

DuRenderer
DuAEF.DuRenderer

DuRSS
DuAEF.DuRSS

DuSanity
DuAEF.DuSanity

DuScriptUI
DuAEF.DuScriptUI

DuSystem
DuAEF.DuSystem

Dutranslator
DuAEF.Dutranslator

DuXML
DuAEF.DuXML

Interchange
DuAEF.Interchange

Krita
DuAEF.Krita

OCA
DuAEF.OCA

Ramses
DuAEF.Ramses

TVPaint
DuAEF.TVPaint

WUStoryboarder
DuAEF.WUStoryboarder

XMP
DuAEF.XMP

Zip
DuAEF.Zip

Members

static aboutURL
DuAEF.jsxinc, line 164

The url about the script

static bugReportURL
DuAEF.jsxinc, line 156

The url for reporting bugs

static chatURL
DuAEF.jsxinc, line 152

The url for a chat server about the script

static companyIcon
DuAEF.jsxinc, line 202

An icon for this company

static companyIconOver
DuAEF.jsxinc, line 206

A mouseover icon for this company

static companyName
DuAEF.jsxinc, line 194

The name of the company/organisation/individual developping this tool

static companyURL
DuAEF.jsxinc, line 198

The URL to the company's website

static debug :boolean
DuAEF.jsxinc, line 115

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

static docURL
DuAEF.jsxinc, line 168

The url to the documentation of the script

static DuPseudoEffect
DuAEF.jsxinc, line 35799

Tools to manage pseudo effects.

static featureRequestURL
DuAEF.jsxinc, line 160

The url for requesting features

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

The current DuAEF File

static forumURL
DuAEF.jsxinc, line 148

The url for the forum about the script

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

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

static newsArgs
DuAEF.jsxinc, line 181

The subfolder and arguments needed to get the news

static newsPort
DuAEF.jsxinc, line 186

The port of the RSS server
Default Value:
  • 80

static newsServer
DuAEF.jsxinc, line 177

The RSS server providing some news (only the domain name)
Default Value:
  • 'rainboxprod.net'

static newsUserAgentVersion
DuAEF.jsxinc, line 190

The user agent to use when getting news

static scriptAbout
DuAEF.jsxinc, line 172

The text about the script

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

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

static scriptIcon
DuAEF.jsxinc, line 140

An icon for this script

static scriptIconOver
DuAEF.jsxinc, line 144

A mouseover icon for this script

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

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

static, readonly scriptVersion :DuVersion
DuAEF.jsxinc, line 129

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

static settings :DuSettings
DuAEF.jsxinc, line 17269

Some settings shared with all DuAEF instances

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

The current state of the script

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

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

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

The Current DuAEF Version

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

The current OS, true if we're on Windows

Methods

static enterRunTime()
DuAEF.jsxinc, line 280

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 259

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.