IPM
StudioProject Class Reference

Supports packaging and installing modules from Studio projects. More...

Inheritance diagram for StudioProject:
Inheritance graph

Public Member Functions

_.Library.Status OnInstallFromPayload (pParams)
 Callback from the Verify phase to install the module payload in a different namespace.
 
- Public Member Functions inherited from Base
_.Library.String GetResourceRelativePath (_.Library.String pResource, _.Library.String pExtension)
 Helper method to get the relative path to the file corresponding to a resource (used in Reload/Export). More...
 
_.Library.Status OnAfterResourceProcessing (_.Library.String pPhase, pParams)
 This method can be overrided to include any action that needs to be executed. More...
 
_.Library.Status OnBeforeResourceProcessing (_.Library.String pPhase, pParams)
 This method can be overrided to include any action that needs to be executed. More...
 
_.Library.Status OnBeforeVerifyLoad (pParams)
 Allows for subclasses to do additional setup or modify pParams before the "verify" phase runs.
 

Private Member Functions

_.Library.Status Package (pParams)
 Packages all of the resources in a module (possibly including its dependencies, possibly including the package manager, possibly deploying by default) More...
 

Private Attributes

 __Payload
   More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Base
_.Library.List GetCompletePhases (_.Library.List pPhases)
 This method defines what a complete phase means for a given list of phases.
 
_.Library.List GetCompletePhasesForOne (_.Library.String pOnePhase)
 This method defines what a complete phase means for a given phase.
 
 GetDefaultParameters (pParams, _.Library.List pPhases)
 Merges default parameters into pParams. More...
 
_.Dictionary.Classname GetDefaultResourceProcessor (_.Library.String pResourceName)
 Returns the default resource processor class to use for a given resource name.
 
_.Library.String MatchSinglePhase (_.Library.String pOnePhase)
 Match single inputted phase to the correctly CamelCased lifecycle phase

 
- Public Attributes inherited from Base
 HasDeployedResources
   More...
 
 PhaseList
   More...
 
- Static Public Attributes inherited from Base
 PHASES = None
 $ListBuild list of phases in this lifecycle. More...
 

Detailed Description

Supports packaging and installing modules from Studio projects.

Additional command line flags:

  • -DPackage.WithDependencies=1: includes dependencies in the module package
  • -DPackage.Manager=1: includes package manager itself in the module package, to be bootstrapped in if it is not already installed
  • -DPackage.Target=C:\path\to\file.xml: exports the package to the specified file
  • -DPackage.Deploy=1: deploys all resources that are not explicitly listed with "Deploy=false"

Member Function Documentation

◆ Package()

_.Library.Status Package (   pParams)
private

Packages all of the resources in a module (possibly including its dependencies, possibly including the package manager, possibly deploying by default)

into a Studio project with a set of subordinate Studio projects.

Reimplemented from Base.

Member Data Documentation

◆ __Payload

__Payload
private