Namespace: DuESF

DuESF

The Duduf ExtendScript Framework.
by RxLaboratory and Duduf.
WARNING: all objects marked deprecated will be removed in the version 1.1.0 of the framework.
Version:
  • 1.0.0
Author:
  • Nicolas Dufresne and contributors
License:
  • GPL-3.0
    This program 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.

    This program 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 this program. If not, see http://www.gnu.org/licenses/.

Members

staticDuESF.aboutURLstring

The url about the script

staticDuESF.bugReportURLstring

The url for reporting bugs

staticDuESF.chatURLstring

The url for a chat server about the script

staticDuESF.companyIconstring

An icon for this company

staticDuESF.companyNamestring

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

staticDuESF.companyURLstring

The URL to the company's website

staticDuESF.debugBoolean

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

staticDuESF.docURLstring

The url to the documentation of the script

staticDuESF.donateURLstring

The url for donations, support, like...

staticDuESF.featureRequestURLstring

The url for requesting features

static,readonlyDuESF.fileFile

The current DuESF File

staticDuESF.forumURLstring

The url for the forum about the script

staticDuESF.hostDuESF.HostApplication

The host application

static,readonlyDuESF.HostApplicationstring

The applicatiosns DuESF can be used with.
Properties:
Name Type Default Description
AFTER_EFFECTS string after-effects
ILLUSTRATOR string illustrator
PHOTOSHOP string photoshop
INDESIGN string indesign

staticDuESF.hostVersion

The version of the host application

staticDuESF.rxVersionURLstring

The URL to a rxVersion server used to check for updates

staticDuESF.scriptAboutstring

The text about the script

static,readonlyDuESF.scriptFirstRunboolean

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

staticDuESF.scriptIconstring

An icon for this script

static,readonlyDuESF.scriptNamestring

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

staticDuESF.scriptSettingsDuSettings

The settings to store the script specific settings.

static,readonlyDuESF.scriptVersionDuVersion

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

static,readonlyDuESF.Stateint

Enum for states.
Properties:
Name Type Default Description
NOT_SET int -1
INIT int 0
RUNTIME int 1

staticDuESF.stateDuESF.State

The current state of the script
Default Value:
  • DuESF.State.NOT_SET

static,readonlyDuESF.versionDuVersion

The Current DuESF Version

Methods

staticDuESF.delete()

D:/DEV_SRC/RxOT/DuAEF/DuESF/tools/build/output/DuESF.jsxinc, line 248
Removes all DuESF parts from memory. Call this if you've updated before you reload DuESF.

staticDuESF.enterRunTime()

D:/DEV_SRC/RxOT/DuAEF/DuESF/tools/build/output/DuESF.jsxinc, line 238
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).

staticDuESF.init(hostApplication, scriptName, scriptVersion, companyName)

D:/DEV_SRC/RxOT/DuAEF/DuESF/tools/build/output/DuESF.jsxinc, line 204
This method has to be called once at the very beginning of the script, just after the inclusion of DuESF #include DuESF.jsxinc
Name Type Default Description
hostApplication DuESF.host The host application of the script.
scriptName string "DuESF" optional The name of your script, as it has to be displayed in the UI and the filesystem
scriptVersion string "0.0.0" optional The version of your script, in the form "XX.XX.XX-Comment", for example "1.0.12-Beta". The "-Comment" part is optional.
companyName string "RxLaboratory" optional The name of the company/organisation/individual developping this script.