API Documentation
Public Member Functions | List of all members
nkScripts::ResourceDeclAugmentCallback Class Reference

Represents a callback enabling to "augment" a loading or saving of a project. More...

Public Member Functions

 ResourceDeclAugmentCallback ()
 
virtual ~ResourceDeclAugmentCallback ()
 
virtual void onScript (Script *script, nkExport::Node *node)
 

Detailed Description

Represents a callback enabling to "augment" a loading or saving of a project.

By implementiong this class, and plugging it within a ProjectLoadQuery or ProjectSaveQuery, external code can add or retrieve more required information. For instance, good use case could be to import a project and register all Script in a client structure for later referencing.

Constructor & Destructor Documentation

◆ ResourceDeclAugmentCallback()

nkScripts::ResourceDeclAugmentCallback::ResourceDeclAugmentCallback ( )

Constructor.

◆ ~ResourceDeclAugmentCallback()

virtual nkScripts::ResourceDeclAugmentCallback::~ResourceDeclAugmentCallback ( )
virtual

Destructor.

Member Function Documentation

◆ onScript()

virtual void nkScripts::ResourceDeclAugmentCallback::onScript ( Script script,
nkExport::Node node 
)
virtual

Callback used when a script is being processed.

Parameters
scriptThe script currently being processed.
nodeThe node from which the script has been imported / is being exported.
Remarks
During loading, this function is called after the script has been imported. During saving, this function is called after the node has been populated with attributes scripts needed to export.

The documentation for this class was generated from the following file: