A DzSimpleElementData implementation that executes a script after the owning element has been loaded into the scene.

More...

Inherits :

• QObject
  • DzBase
    • DzCustomData
      • DzElementData
        • DzSimpleElementData

Implements a custom data item that causes a specified script to be executed after the element that owns this data item has been loaded into the scene.

A global transient variable named DataItem, which refers to the DzSimpleElementScriptData that invoked the execution of the script, is provided to the script in the global context at runtime. Attempts to use this global variable outside of the associated script will result in a ReferenceError.

A global transient variable named FileIOSettings, which refers to the DzFileIOSettings that was used when the element that owns this data item was loaded, is provided to the script in the global context at runtime. Attempts to use this global variable outside of the associated script will result in a ReferenceError. (since 4.9.4.109)

If the DzSettings for this data item contains a boolean setting named RunOnce set to true, the specified script will be run once and then this data item will be deleted from the element.

Attention:

• The differences between this implementation and DzElementPostLoadFileData are that this implementation must reference the file path of a script and has an associated DzSettings that can be used to configure the script.

See Also:

• DzElement::addDataItem()
• DzElement::removeDataItem()
• DzElement::deleteDataItem()
• DzElement::getNumDataItems()
• DzElement::getDataItem()
• DzElement::getDataItemList()
• DzElement::getUniqueDataItemName()
• DzElement::findDataItem()
• DzElement::moveDataItemToIndex()
• DzElement::findDataItemIndex()

DzSimpleElementScriptData( String name, Boolean persistent=true )

Default constructor.

Parameter(s):

• name - The name for this data item. This must be unique for all data items on a given element - an element cannot have two data items with the same name.
• persistent - If true (default), this data item will be saved with the owning element. If false, this data item will not be saved.

Attention:

• It is the developer's responsibility to manage the lifetime of this object. This can be accomplished most easily by adding it to the list of data items owned by an element.

See Also:

• DzCustomData::isPersistent()
• DzElementData::getOwner()
• DzElement::addDataItem()
• DzElement::findDataItem()
• DzElement::getUniqueDataItemName()

String : getScriptFilePath()

Return Value:

• The file path of the script for this data item (if any), otherwise an empty string.

void : setScriptFilePath( String script )

Sets the file path of the script for this data item.

Parameter(s):

• script - The file path of the script.