User Tools

Site Tools


DzPlugin

Class that defines a DAZ Studio plug-in.

More...

Inherits :

Enumerations

Methods

Detailed Description

This class provides startup and shutdown functionality for DAZ Studio plug-ins and maintains the list of class types exported by the plug-in.

Enumerations


: Status

TODO: Add description.

  • Loaded - TODO: Add description.
  • RequiresRestart - TODO: Add description.
  • ManuallyDisabled - TODO: Add description.
  • EvaluationInvalid - TODO: Add description.
  • Failed - TODO: Add description.

Methods


String : getAuthor()

Return Value:

  • The author of the plug-in.

String : getDescription()

Return Value:

  • The author's description of the plug-in.

String : getEvaluationInformation()

Return Value:

  • The evaluation information of the plug-in in string form.

String : getFilename()

Return Value:

  • The absolute file path to the plug-in; set by DzApp when the plug-in is loaded.

Boolean : getLoadOnStart()

Return Value:

  • true if the plug-in should load on application start, otherwise false.

String : getName()

Return Value:

  • The name of the plug-in.

Array : getPrefixes()

Return Value:

  • A list of prefixes that can be used to serialize this plugin (if any), otherwise an empty list.

Since:

  • 4.11.0.35

Status : getStatus()

Return Value:

  • The load state of the plug-in.

String : getStatusInformation()

Return Value:

  • Additional information about the plug-in load state.

String : getStatusString()

Return Value:

  • The string representation of the plug-in load state.

DzVersion : getVersion()

Return Value:

  • The version number of the plug-in.

String : getVersionString()

Return Value:

  • The version number of the plug-in in string form.

Boolean : isActivated()

Return Value:

  • true if the plug-in is activated, otherwise false. A plug-in is considered activated if it has either been registered or it is within an evaluation period.

See Also:


Boolean : isRegistered()

Return Value:

  • true if the plug-in has been registered, othwerwise false. A plug-in is considered registered if a valid serial number for the plug-in has been applied, or if the plug-in does not use serial number registration. A plug-in that is within an evaluation period is not considered registered.

See Also:


Boolean : validateSerialNumber( String serialNumber, Boolean saveIfValid )

Parameter(s):

  • serialNumber - The serial number to validate.
  • saveIfValid - If true, the serial number will be saved if it is found to be valid.

Return Value:

  • true if the serial number is valid for the plug-in, otherwise false.