DuAEF

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

Example

//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

Debug

DuAE

DuBinary

DuExpression

Dugr

Duik

DuJS

DuRenderer

DuRSS

DuScriptUI

DuSystem

Dutranslator

DuXML

Interchange

Krita

Ramses

TVPaint

WUStoryboarder

Zip

Members

static aboutURL

The url about the script

static bugReportURL

The url for reporting bugs

static chatURL

The url for a chat server about the script

static debug :boolean

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

static DuPseudoEffect

Tools to manage pseudo effects.

static featureRequestURL

The url for requesting features

static, readonly file :File

The current DuAEF File

static forumURL

The url for the forum about the script

static, readonly mac :boolean

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

static newsArgs

The subfolder and arguments needed to get the news

static newsPort

The port of the RSS server
Default Value:
  • 80

static newsServer

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

static newsUserAgentVersion

The user agent to use when getting news

static scriptAbout

The text about the script

static, readonly scriptFirstRun :boolean

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

static, readonly scriptName :string

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

static, readonly scriptVersion :DuVersion

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

static state :DuAEF.States

The current state of the script

static, readonly States :int

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

static, readonly version :string

The Current DuAEF Version

static, readonly win :boolean

The current OS, true if we're on Windows

Methods

static enterRunTime()

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)

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.